1. REST API for the Management Service in Oracle API Platform Cloud Service
  2. Tasks
  3. Deployments
  4. Gateways

Get APIs that can be deployed to a gateway

get

/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

Supported Media Types
Path Parameters
Query Parameters
  • 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.
  • 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.
  • Number of items to retrieve. 1 is the minumum; 128 is the maximum.
    Default Value: 128
  • Offset the list returned results by this amount. Default is zero.
    Default Value: 0
  • Collection Format: csv
    Pass sorting criteria, comma separated.
  • Pass filtering criteria, using the SCIM filter expression syntax
  • Include the total result count in the response.
    Default Value: false
Back to Top

Response

Supported Media Types

200 Response

The collection of APIs
Body ()
Root Schema : GetApisResponse
Match All
Show Source
Nested Schema : CollectionResponseFeature
Type: object
Show Source
Nested Schema : CollectionResponsePagingFeature
Type: object
Show Source
Nested Schema : GetApisResponse-allOf[2]
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : Api
Type: object

403 Response

Forbidden.
Body ()
Root Schema : Error
Type: object
Show Source
Nested Schema : errorDetails
Type: array
additional errors
Show Source

500 Response

Unexpected error.
Body ()
Root Schema : Error
Type: object
Show Source
Nested Schema : errorDetails
Type: array
additional errors
Show Source
Back to Top

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 are ALPHA, BETA, DEPRECATED, RELEASED, and RETIRED.

  • 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 are REQUESTING, APPROVED, and REJECTED.

  • 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"
    }
  ]
}
Back to Top