Get gateways an API can be deployed to
/apiplatform/management/v1/apis/{apiId}/deployments/gateways
Returns a collection of gateways the {apiId}
API can be deployed to.
Users requesting this resource must be assigned the API Manager, or Gateway Manager role and must be issued the Deploy API grant for the specified API. Only gateways for which the user is issued the Deploy to Gateway or Request Deployment to Gateway grants are returned.
Request
- application/json
-
apiId: string
A unique ID referencing a specific API.
-
expand(optional): array
Collection Format:
csv
Pass optional fields, separated by commas, in this parameter to return them in the response. See the operation's description for a list of expand values. -
fields(optional): array
Collection Format:
csv
Pass optional fields, separated by commas, in this parameter to return them in the response. See the operation's description for a list of field values. -
limit(optional): integer(int32)
Number of items to retrieve.
1
is the minumum;128
is the maximum.Default Value:128
-
offset(optional): integer(int32)
Offset the list returned results by this amount. Default is zero.Default Value:
0
- orderBy(optional): array
-
q(optional): string
Pass filtering criteria, using the SCIM filter expression syntax
-
totalResults(optional): boolean
Include the total result count in the response.Default Value:
false
Response
- application/json
200 Response
object
-
count(optional):
integer(int32)
The number of items in this collection.
object
-
links(optional):
array links
Includes 'canonical'.
object
-
totalResults(optional):
integer(int32)
The total number of results available. Only provided if the showTotalResults query parameter is set to true
object
-
href(optional):
string
Link href.
-
method(optional):
string
HTTP Operation GET, POST, PUT
-
rel(optional):
string
Link relation.
object
-
links(optional):
array links
Includes 'canonical'.
object
-
configuration(optional):
object configuration
-
description(optional):
string
The gateway's description.
-
firewall(optional):
object firewall
-
location(optional):
string
The gateway's location.
-
proxyUrls(optional):
array proxyUrls
-
releaseVersion(optional):
string
The gateway's release version. This property is used only at node registration time to seed the original release version of the node.
-
urls(optional):
array urls
object
-
createdAt(optional):
string
The date and time the gateway was created.
-
createdBy(optional):
string
The user who created the gateway.
-
updatedAt(optional):
string
The date time the gateway was last updated.
-
updatedBy(optional):
string
The user who last updated the gateway.
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 gateways an API can be deployed to by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL
curl -i -X GET
-H "Authorization: Bearer access_token"
https://example.com/apiplatform/management/v1/apis/{apiId}/deployments/gateways
{apiId}
is the unique ID for an API. To retrieve available API IDs, see Get APIs.
You can pass the following optional field values in the fields
query parameter, separated by commas, to include them in the response:
-
description
: The gateway's description. -
location
: The gateway's location. -
urls
: The gateway's load balancer URLs. -
configuration
: The gateway's description. -
createdAt
: The date and time the gateway was created. -
createdBy
: The user who created the gateway. -
updatedAt
: The date and time the gateway was last updated. -
updatedBy
: The user who last updated the gateway.
The following example shows you how to include these fields in the response:
curl -i -X GET
-H "Authorization: Bearer access_token"
https://example.com/apiplatform/management/v1/apis/{apiId}/deployments/gateways?urls,updatedBy
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 07:09:25 GMT Content-Length: 307 Content-Type: application/json X-oracle-dms-ecid: f102c33f-1c5b-4409-806d-03bf5706c492-0002ae34 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 the ID and name of each eligible gateway.
{ "count": 3, "links": [ { "templated": "true", "method": "GET", "rel": "self", "href": "https://example.com:443/apiplatform/management/v1/apis/103/deployments/gateways" } ], "items": [ { "name": "Production Gateway", "id": "100" }, { "name": "Production Gateway 2", "id": "101" }, { "name": "Development Gateway2", "id": "104" } ] }