Jump to

• Request
• Response
• Examples

Get API deployments

get

/apiplatform/management/v1/apis/{apiId}/deployments

Returns a collection of deployments of the {apiId} API.

The response also contains HATEOAS links to related operations.

Users requesting this resource must be assigned the Plan Manager, API Manager, or Gateway Manager role and must be issued the Manage API or View All Details grants for the specified API. All deployments are returned, regardless of the permissions issued for each gateway.

Request

Supported Media Types

• application/json

Path Parameters

• apiId: string
  A unique ID referencing a specific API.

Query Parameters

• 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.

  • [0]: string

  {
      "name":"expand",
      "in":"query",
      "description":"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.",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"csv"
  }

• 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.

  • [0]: string

  {
      "name":"fields",
      "in":"query",
      "description":"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.",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"csv"
  }

• limit(optional): integer(int32)
  Number of items to retrieve. 1 is the minumum; 128 is the maximum.

  Default Value: 128
• links(optional): array
  Collection Format: csv

  Filter the specified link rel's.

  • [0]: string

  {
      "name":"links",
      "in":"query",
      "description":"Filter the specified link rel's.",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"csv"
  }

• offset(optional): integer(int32)
  Offset the list returned results by this amount. Default is zero.

  Default Value: 0
• orderBy(optional): array
  Collection Format: csv

  Pass sorting criteria, comma separated.

  • [0]: string

  {
      "name":"orderBy",
      "in":"query",
      "description":"Pass sorting criteria, comma separated.",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"csv"
  }

• 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

Back to Top

Response

Supported Media Types

• application/json

200 Response

The collection of deployments

Body ()

Root Schema : GetDeploymentsResponse

Match All

Show Source

• object CollectionResponseFeature
• object CollectionResponsePagingFeature
• object LinksResponseFeature
• object GetDeploymentsResponse-allOf[3]

{
    "allOf":[
        {
            "$ref":"#/definitions/CollectionResponseFeature"
        },
        {
            "$ref":"#/definitions/CollectionResponsePagingFeature"
        },
        {
            "$ref":"#/definitions/LinksResponseFeature"
        },
        {
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/GetDeploymentsItem"
                    }
                }
            }
        }
    ]
}

Nested Schema : CollectionResponseFeature

Type: object

Show Source

• count(optional): integer(int32)
  The number of items in this collection.

{
    "properties":{
        "count":{
            "type":"integer",
            "format":"int32",
            "description":"The number of items in this collection."
        }
    }
}

Nested Schema : CollectionResponsePagingFeature

Type: object

Show Source

• totalResults(optional): integer(int32)
  The total number of results available. Only provided if the showTotalResults query parameter is set to true

{
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"The total number of results available. Only provided if the showTotalResults query parameter is set to true"
        }
    }
}

Nested Schema : LinksResponseFeature

Type: object

Show Source

• links(optional): array links
  Includes 'canonical'.

{
    "properties":{
        "links":{
            "type":"array",
            "description":"Includes 'canonical'.",
            "items":{
                "$ref":"#/definitions/HATEOASLink"
            }
        }
    }
}

Nested Schema : GetDeploymentsResponse-allOf[3]

Type: object

Show Source

• items(optional): array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/GetDeploymentsItem"
            }
        }
    }
}

Nested Schema : links

Type: array

Includes 'canonical'.

Show Source

• Array of: object HATEOASLink

{
    "type":"array",
    "description":"Includes 'canonical'.",
    "items":{
        "$ref":"#/definitions/HATEOASLink"
    }
}

Nested Schema : HATEOASLink

Type: object

Show Source

• href(optional): string
  Link href.
• method(optional): string
  HTTP Operation GET, POST, PUT
• rel(optional): string
  Link relation.

{
    "type":"object",
    "properties":{
        "method":{
            "type":"string",
            "description":"HTTP Operation GET, POST, PUT"
        },
        "rel":{
            "type":"string",
            "description":"Link relation."
        },
        "href":{
            "type":"string",
            "description":"Link href."
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: GetDeploymentsItem

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/GetDeploymentsItem"
    }
}

Nested Schema : GetDeploymentsItem

Match All

Show Source

• Deployment
• object ResourceLinksProperties

{
    "allOf":[
        {
            "$ref":"#/definitions/Deployment"
        },
        {
            "$ref":"#/definitions/ResourceLinksProperties"
        }
    ]
}

Nested Schema : Deployment

Match All

Show Source

• object DeploymentId
• object Deployment-allOf[1]
• object Deployment-allOf[2]
• object DeploymentDef
• object DeploymentMetadata
• object Deployment-allOf[5]

{
    "allOf":[
        {
            "$ref":"#/definitions/DeploymentId"
        },
        {
            "type":"object",
            "properties":{
                "api":{
                    "$ref":"#/definitions/Api"
                }
            }
        },
        {
            "type":"object",
            "properties":{
                "gateway":{
                    "$ref":"#/definitions/Gateway"
                }
            }
        },
        {
            "$ref":"#/definitions/DeploymentDef"
        },
        {
            "$ref":"#/definitions/DeploymentMetadata"
        },
        {
            "type":"object",
            "properties":{
                "nodes":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/NodeDeployment"
                    }
                }
            }
        }
    ]
}

Nested Schema : ResourceLinksProperties

Type: object

Show Source

• links(optional): array links
  Includes 'canonical'.

{
    "properties":{
        "links":{
            "type":"array",
            "description":"Includes 'canonical'.",
            "items":{
                "$ref":"#/definitions/HATEOASLink"
            }
        }
    }
}

Nested Schema : DeploymentId

Type: object

Show Source

• id: string
  The deployment's ID.

{
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The deployment's ID."
        }
    }
}

Nested Schema : Deployment-allOf[1]

Type: object

Show Source

• api(optional): object Api

{
    "type":"object",
    "properties":{
        "api":{
            "$ref":"#/definitions/Api"
        }
    }
}

Nested Schema : Deployment-allOf[2]

Type: object

Show Source

• gateway(optional): Gateway

{
    "type":"object",
    "properties":{
        "gateway":{
            "$ref":"#/definitions/Gateway"
        }
    }
}

Nested Schema : DeploymentDef

Type: object

Show Source

• action(optional): string
  The deployment action. Valid values are DEPLOY (to create a new deployment), UNDEPLOY (to undeploy a deployment), ACTIVATE (to activate a deployment), and INACTIVATE (to inactivate a deployment).
• deploymentComments(optional): string
  Comments regarding the deployment's state.
• deploymentState(optional): string
  The deployment's state. Valid values are REQUESTING, APPROVED, and REJECTED.
• description(optional): string
  The deployment's description.
• endpoints(optional): array endpoints
  The deployment's endpoints.
• runtimeState(optional): string
  The deployment's runtime state. Valid values are ACTIVE and INACTIVE.

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string",
            "description":"The deployment's description."
        },
        "endpoints":{
            "type":"array",
            "description":"The deployment's endpoints.",
            "items":{
                "type":"string"
            }
        },
        "action":{
            "type":"string",
            "description":"The deployment action. Valid values are <code>DEPLOY</code> (to create a new deployment), <code>UNDEPLOY</code> (to undeploy a deployment), <code>ACTIVATE</code> (to activate a deployment), and <code>INACTIVATE</code> (to inactivate a deployment)."
        },
        "deploymentState":{
            "type":"string",
            "description":"The deployment's state. Valid values are <code>REQUESTING</code>, <code>APPROVED</code>, and <code>REJECTED</code>."
        },
        "deploymentComments":{
            "type":"string",
            "description":"Comments regarding the deployment's state."
        },
        "runtimeState":{
            "type":"string",
            "description":"The deployment's runtime state. Valid values are <code>ACTIVE</code> and <code>INACTIVE</code>."
        }
    }
}

Nested Schema : DeploymentMetadata

Type: object

Show Source

• createdAt(optional): string
  The date and time the deployment was created.
• createdBy(optional): string
  The user who created the deployment.
• updatedAt(optional): string
  The date and time the deployment was last updated.
• updatedBy(optional): string
  The user who last updated the deployment.

{
    "type":"object",
    "properties":{
        "createdBy":{
            "type":"string",
            "description":"The user who created the deployment."
        },
        "createdAt":{
            "type":"string",
            "description":"The date and time the deployment was created."
        },
        "updatedBy":{
            "type":"string",
            "description":"The user who last updated the deployment."
        },
        "updatedAt":{
            "type":"string",
            "description":"The date and time the deployment was last updated."
        }
    }
}

Nested Schema : Deployment-allOf[5]

Type: object

Show Source

• nodes(optional): array nodes

{
    "type":"object",
    "properties":{
        "nodes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/NodeDeployment"
            }
        }
    }
}

Nested Schema : Api

Type: object

Nested Schema : Gateway

Match All

Show Source

• object GatewayId
• object GatewayIdentity
• object GatewayDef
• object GatewayMetadata

{
    "allOf":[
        {
            "$ref":"#/definitions/GatewayId"
        },
        {
            "$ref":"#/definitions/GatewayIdentity"
        },
        {
            "$ref":"#/definitions/GatewayDef"
        },
        {
            "$ref":"#/definitions/GatewayMetadata"
        }
    ]
}

Nested Schema : GatewayId

Type: object

Show Source

• id: string
  The gateway's ID.

{
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The gateway's ID."
        }
    }
}

Nested Schema : GatewayIdentity

Type: object

Show Source

• name: string
  The gateway's name.

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"The gateway's name."
        }
    }
}

Nested Schema : GatewayDef

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string",
            "description":"The gateway's description."
        },
        "releaseVersion":{
            "type":"string",
            "description":"The gateway's release version. This property is used only at node registration time to seed the original release version of the node."
        },
        "location":{
            "type":"string",
            "description":"The gateway's location."
        },
        "urls":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "proxyUrls":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "configuration":{
            "type":"object",
            "properties":{
            }
        },
        "firewall":{
            "type":"object",
            "properties":{
            }
        }
    }
}

Nested Schema : GatewayMetadata

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "createdBy":{
            "type":"string",
            "description":"The user who created the gateway."
        },
        "createdAt":{
            "type":"string",
            "description":"The date and time the gateway was created."
        },
        "updatedBy":{
            "type":"string",
            "description":"The user who last updated the gateway."
        },
        "updatedAt":{
            "type":"string",
            "description":"The date time the gateway was last updated."
        }
    }
}

Nested Schema : configuration

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : firewall

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : proxyUrls

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : urls

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : endpoints

Type: array

The deployment's endpoints.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The deployment's endpoints.",
    "items":{
        "type":"string"
    }
}

Nested Schema : nodes

Type: array

Show Source

• Array of: object NodeDeployment

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/NodeDeployment"
    }
}

Nested Schema : NodeDeployment

Type: object

Show Source

• deploymentState(optional): string
  The node deployment's state.
• endpoints(optional): array endpoints
  The node deployment's endpoints.
• errorMessage(optional): string
  The deployment's error message.
• errorSummary(optional): string
  The deployment's error summary.
• id(optional): string
  The node id.
• name(optional): string
  The node name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The node id."
        },
        "name":{
            "type":"string",
            "description":"The node name."
        },
        "endpoints":{
            "type":"array",
            "description":"The node deployment's endpoints.",
            "items":{
                "type":"string"
            }
        },
        "deploymentState":{
            "type":"string",
            "description":"The node deployment's state."
        },
        "errorSummary":{
            "type":"string",
            "description":"The deployment's error summary."
        },
        "errorMessage":{
            "type":"string",
            "description":"The deployment's error message."
        }
    }
}

Nested Schema : endpoints

Type: array

The node deployment's endpoints.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The node deployment's endpoints.",
    "items":{
        "type":"string"
    }
}

Nested Schema : links

Type: array

Includes 'canonical'.

Show Source

• Array of: object HATEOASLink

{
    "type":"array",
    "description":"Includes 'canonical'.",
    "items":{
        "$ref":"#/definitions/HATEOASLink"
    }
}

403 Response

Forbidden.

Body ()

Root Schema : Error

Type: object

Show Source

• 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

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

• Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

500 Response

Unexpected error.

Body ()

Root Schema : Error

Type: object

Show Source

• 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

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

• Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

Back to Top

Examples

The following example shows how to retrieve all available deployments for an API 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

{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:

• For each API:

  • api.description: The API's description.

  • api.iterationId: The API's iteration.

  • api.createdAt: The date and time the API was created.

  • api.createdBy: The user who created the API.

  • api.updatedAt: The date and time the API was last updated.

  • api.updatedBy: The user who last updated the API.

• For each gateway:

  • gateway.description: The gateway's description.

  • gateway.urls: The gateway???s load balancer URLs.

  • nodes: Information about a node the API is deployed to.

  • nodes.description: A node???s description.

  • nodes.urls: The node???s load balancer URLs.

  • nodes.state: The gateway node's state. Values are REQUESTING, ACTIVE, and REJECTED.

  • nodes.stateComments: Comments regarding the gateway node's state.

• For each deployment:

  • action: The deployment action. Values are DEPLOY (to create a new deployment), UNDEPLOY (to undeploy a deployment), ACTIVATE (to activate a deployment), and INACTIVATE (to inactivate a deployment).

  • deploymentState: The deployment's state. Values are REQUESTING, APPROVED, and REJECTED.

  • deploymentComments: Comments regarding the deployment's state.

  • runtimeState: The deployment's runtime state. Values are ACTIVE and INACTIVE.

  • description: The deployment's description.

  • endpoints: The deployment's endpoints.

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?fields=api.description,deploymentState

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 06:59:13 GMT
Content-Length:  1667
Content-Type:  application/json
X-oracle-dms-ecid:  f102c33f-1c5b-4409-806d-03bf5706c492-0002adb4
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 ID of each deployment. The response also contains HATEOAS links to related operations.

{
    "count": 1,
    "links": [
        {
            "templated": "true",
            "method": "GET",
            "rel": "self",
            "href": "https://example.com:443/apiplatform/management/v1/apis/103/deployments"
        },
        {
            "templated": "true",
            "method": "GET",
            "rel": "canonical",
            "href": "https://example.com:443/apiplatform/management/v1/apis/103/deployments"
        },
        {
            "templated": "true",
            "method": "POST",
            "rel": "deploy",
            "href": "https://example.com:443/apiplatform/management/v1/apis/103/deployments"
        },
        {
            "templated": "true",
            "method": "GET",
            "rel": "gateways",
            "href": "https://example.com:443/apiplatform/management/v1/apis/103/deployments/gateways"
        }
    ],
    "items": [
        {
            "links": [
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "canonical",
                    "href": "https://example.com:443/apiplatform/management/v1/apis/103/deployments/103"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "implementation",
                    "href": "https://example.com:443/apiplatform/management/v1/apis/103/deployments/103/api"
                },
                {
                    "templated": "true",
                    "method": "POST",
                    "rel": "deploy",
                    "href": "https://example.com:443/apiplatform/management/v1/apis/103/deployments"
                },
                {
                    "templated": "true",
                    "method": "POST",
                    "rel": "redeploy",
                    "href": "https://example.com:443/apiplatform/management/v1/apis/103/deployments"
                },
                {
                    "templated": "true",
                    "method": "POST",
                    "rel": "activate",
                    "href": "https://example.com:443/apiplatform/management/v1/apis/103/deployments"
                },
                {
                    "templated": "true",
                    "method": "POST",
                    "rel": "inactivate",
                    "href": "https://example.com:443/apiplatform/management/v1/apis/103/deployments"
                },
                {
                    "templated": "true",
                    "method": "POST",
                    "rel": "undeploy",
                    "href": "https://example.com:443/apiplatform/management/v1/apis/103/deployments"
                }
            ],
            "id": "103"
        }
    ]
}

Back to Top