Get APIs that can be deployed to a gateway
/apiplatform/management/v1/gateways/{gwId}/deployments/apis
Returns a collection of APIs that can be deployed to the {gwID}
gateway.
Users requesting this resource must be assigned the API Manager, or Gateway Manager role and must be issued the Deploy to Gateway or Request Deployment to Gateway grants for the specified gateway. Only APIs for which the user is issued the Deploy API grant are returned.
Request
- application/json
-
gwId: string
A unique ID referencing a specific gateway.
-
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
-
totalResults(optional):
integer(int32)
The total number of results available. Only provided if the showTotalResults query parameter is set to true
object
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 get APIs that can be 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
-H "Authorization: Bearer access_token"
https://example.com/apiplatform/management/v1/gateways/{gwId}/deployments/apis
{gwId}
is the unique of a gateway. To retrieve available gateway Ids, see Get gateways.
You can pass the following optional field values in the fields
query parameter, separated by commas, to include them in the response:
-
vanityName
: The API's vanity name. -
description
: The API's description. -
iterationId
: The API's iteration. -
state
: The API's state. Values areALPHA
,BETA
,DEPRECATED
,RELEASED
, andRETIRED
. -
stateComments
: Comments about the API's state. -
stateUpdatedAt
: The date and time the API state was last updated. -
stateUpdadtedBy
: The user who last updated the API state. -
createdAt
: The date and time the API was created. -
createdBy
: The user who created the API. -
updatedAt
: The date and time the API was last updated. -
updatedBy
: The user who last updated the API. -
deployments.description
: The deployment's description. -
deployments.state
: The deployment's state. Values areREQUESTING
,APPROVED
, andREJECTED
. -
deployments.endpoints
: The deployment's endpoints. -
deployments.gateway.description
: The gateway???s description. -
deployments.gateway.location
: The gateway???s location. -
deployments.gateway.urls
: The gateway???s load balancer URLs. -
deployments.gateway.configuration
: The gateway???s configuration. -
deployments.gateway.createdAt
: The date and time the deployment was created. -
deployments.gateway.createdBy
: The user who created the deployment. -
deployments.gateway.updatedAt
: The date and time the deployment was last updated. -
deployments.gateway.updatedBy
: The user who last updated the deployment. -
publication
: The state of Developer Portal publication and the iterationId of the published API, if applicable.
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/gateways/{gwId}/deployments/apis?fields=vanityName,description,iterationId,state,deployments.gateway.urls
Example of Response Headers
The following shows an example of the response headers.
Content-encoding:gzip Content-type:application/json Date:Fri, 28 Apr 2017 14:14:33 GMT Proxy-agent:Oracle-Traffic-Director/12.2.1.2.0 Server:Oracle-Traffic-Director/12.2.1.2.0 Transfer-encoding:chunked Vary:accept-encoding Via:1.1 otd_opc-lb-1 X-oracle-dms-ecid:Q0F^F022000000000 X-oracle-dms-rid:0:1
Example of Response Body
The following example shows the contents of the response body in JSON format, including details about the APIs that can be deployed to this gateway.
{ "count": 3, "links": [ { "templated": "true", "method": "GET", "rel": "self", "href": "https://example.com:443/apiplatform/management/v1/gateways/113/deployments/apis" } ], "items": [ { "name": "Climate", "id": "255", "version": "1" }, { "name": "RealEstateListings", "id": "245", "version": "1" }, { "name": "Restaurants", "id": "136", "version": "1" } ] }