Get API deployments

API Platform Base Path: https://api.enterprise.apigee.com/v1/o/{org_name}

API Resource Path: /apis/{api_name}/deployments

Returns detail on deployments of the API specified

Verb: GET

Auth: Basic Auth

Returns detail on deployments of the API specified. Returns result across environments (that is, returns deployments of the API in test and in prod environments (as well others if they exist)

Sample Response:

{
  "environment" : [ {
    "name" : "test",
    "revision" : [ {
      "configuration" : {
        "basePath" : "/",
        "steps" : [ ]
      },
      "name" : "1",
      "server" : [ {
        "status" : "deployed",
        "type" : [ "message-processor" ],
        "uUID" : "90096dd1-1019-406b-9f42-fbb80cd01200"
      }, {
        "status" : "deployed",
        "type" : [ "message-processor" ],
        "uUID" : "7d6e2eb1-581a-4db0-8045-20d9c3306549"
      }, {
        "status" : "deployed",
        "type" : [ "router" ],
        "uUID" : "1619e2d7-c822-45e0-9f97-63882fb6a805"
      }, {
        "status" : "deployed",
        "type" : [ "router" ],
        "uUID" : "8a5f3d5f-46f8-4e99-b4cc-955875c8a8c8"
      } ],
      "state" : "deployed"
    } ]
  } ],
  "name" : "weatherTest",
  "organization" : "myorg"
}

Response Payload Elements:

Name	Description
environment	Settings for the environment
name	Name of the environment
revision	Configuration settings for the API revision
basePath	Basepath for the API in this environment
steps	Policies attached to the API
server	Servers deployed in support of this API (usedinternally by Apigee)
state	The deployment status of the API (deployed or undeployed)
name	Name of the API
organization	The organization in which the API is deployed

Errors

Failure 4xx with proper error message
<Error>
	<Code>messaging.config.beans.ApplicationDoesNotExist</Code>
	<Message>APIProxy named myapp1 does not exist</Message>
	<Contexts/>
</Error>

Last updated: about 1 month ago