Was this helpful?

 

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

API Resource Path:

/environments/{env_name}/deployments

Description: Gets a list of all API proxies that are deployed in a given environment

Verb: GET
Auth: Basic Auth
Media types:
application/json
text/xml

Overview: Gets a list of all API proxies that are deployed in the environment specified, along with deployment status and other metadata about the deployment.

Sample Request:
$ curl -X GET -H "Accept:application/json" \
https://api.enterprise.apigee.com/v1/o/{org_name}/environments/{env_name}/deployments \
-u myname:mypass
Sample Response:
{
  "aPIProxy" : [ {
    "name" : "myAPI",
    "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" : "myOtherAPI",
    "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" : "test",
  "organization" : "myorg"
}
Response Payload Elements:
Name Description
aPIProxy The API proxy that is deployed in this environment
name The name of the API
revision The revision number of the deployed API
server Servers that support this API deployment (used internally by Apigee for support)
name Environment name
organization Organization for the environment

 

Help or comments?

  • Something's not working: See Apigee Support
  • Something's wrong with the docs: Click Send Feedback in the lower right.
    (Incorrect? Unclear? Broken link? Typo?)