Was this helpful?

 

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

API Resource Path:

/deployments

Description: Returns a list of all API proxies that are deployed in all environments in an organization

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

Overview: Gets all API deployments across an organization, for all APIs in all environments.

Sample Request:
$ curl -X GET -H "Accept:application/json" \
https://api.enterprise.apigee.com/v1/o/{org_name}/deployments \
-u myname:mypass
Sample Response:
{
  "environment" : [ {
    "aPIProxy" : [ {
      "name" : "api1",
      "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" : "api2",
      "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"
  }, {
    "aPIProxy" : [ {
      "name" : "api3",
      "revision" : [ {
        "configuration" : {
          "basePath" : "/",
          "steps" : [ ]
        },
        "name" : "41",
        "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" : "api4",
      "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" : "prod"
  } ],
  "name" : "myorg"
}
Response Payload Elements:
Name Description
aPIProxy Names of the API proxies deployed in the environment
name Name of the API
revision Revision number of the deployed API
configuration Configuration number of the API proxy
basePath Base path of the API, used as a pattern match on incoming requests
steps A list of policies on the API
Errors
{
  "code" : "organizations.OrganizationDoesNotExist",
  "message" : "Organization : AutomationOrganization1 does not exist",
  "contexts" : [ ]
}

 

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?)