View deployed API definition
/apiplatform/management/v1/gateways/{gwId}/deployments/{depId}/api
Returns the runtime definition for the {depId}
deployment of an API deployed to the {gwId}
gateway.
Users requesting this resource must be assigned the Plan Manager, API Manager, or Gateway Manager roles and must be issued the Manage Gateway or View All Details grant for the specified gateway.
Request
- application/json
-
depId: string
A unique ID referencing a specific deployment.
-
gwId: string
A unique ID referencing a specific gateway.
Response
- application/json
200 Response
403 Response
object
-
detail(optional):
string
Detailed error message
-
errorCode(optional):
string
Application specific error code
-
errorDetails(optional):
array errorDetails
additional errors
-
errorPath(optional):
string
-
instance(optional):
string
URI to the link that provides more detail about the error
-
status(optional):
string
HTTP status code
-
title:
string
Summary error message
-
type:
string
Error type
500 Response
object
-
detail(optional):
string
Detailed error message
-
errorCode(optional):
string
Application specific error code
-
errorDetails(optional):
array errorDetails
additional errors
-
errorPath(optional):
string
-
instance(optional):
string
URI to the link that provides more detail about the error
-
status(optional):
string
HTTP status code
-
title:
string
Summary error message
-
type:
string
Error type
Examples
The following example shows how to retrieve the definition of an API currently deployed to a gateway by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL
curl -i -X GET -u apicsadmin:password https://example.com/apiplatform/management/v1/gateways/{gwId}/deployments/{depId}/apis
-
{gwId}
is the unique of a gateway. To retrieve available gateway Ids, see Get gateways. -
{depId}
is the unique Id for a deployment. To retrieve available deployment Ids, see Get deployed APIs.
Example of Response Headers
The following shows an example of the response headers.
HTTP/1.1 200 OK Server: Oracle-Traffic-Director/12.2.1.0.0 Date: Fri, 17 Mar 2017 09:26:14 GMT Content-Length: 522 Content-Type: application/json X-oracle-dms-ecid: f102c33f-1c5b-4409-806d-03bf5706c492-0002b4eb X-oracle-dms-rid: 0:1 Via: 1.1 otd_opc Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0
Example of Response Body
The following example shows the contents of the response body in JSON format, including details of the API as deployed to the gateway.
{ "implementation": { "executions": { "request": [ "1", "2" ], "response": [ "3", "4" ] }, "policies": [ { "draft": false, "id": "1", "type": "o:ApiRequest", "version": "1.0", "config": { "protocols": [ "HTTP" ], "url": "exampleEndpoint" } }, { "draft": false, "id": "2", "type": "o:ServiceRequest", "version": "1.0", "config": { "useProxy": true, "url": "http://www.example.com" } }, { "id": "3", "type": "o:ServiceResponse", "version": "1.0", "config": {} }, { "id": "4", "type": "o:ApiResponse", "version": "1.0", "config": {} } ] }, "name": "Temperature", "id": "103", "iterationId": "3", "version": "1" }