List API Proxies for Promotion

Endpoint

GET /apiops/projects/{projectName}/apiProxies/forpromotion

Promotion means carrying an API proxy definition from one project to another — typically from a development project to a test or production project on the same installation. This endpoint returns the source side of that operation: the proxies of the given project, each with enough detail to be sent back through Save API Proxy for Promotion.

Unlike List API Proxies, which returns a summary row per proxy, this endpoint includes the client route and routing configuration.

Authentication

Requires a Personal API Access Token.

Header

Authorization: Bearer YOUR_TOKEN

Request

Headers

Header	Value	Required
Authorization	Bearer {token}	Yes

Path Parameters

Parameter	Type	Required	Description
projectName	string	Yes	Source project name

Query Parameters

None.

Request Body

This endpoint does not require a request body.

Permissions

API_MANAGEMENT read access on the source project.

Response

Success (200 OK)

{
  "status": "SUCCESS",
  "resultCount": 2,
  "resultList": [
    {
      "id": "68f3a1c95d4b2e7a91c04e11",
      "name": "petstore-api",
      "description": "Petstore reverse proxy",
      "type": "REVERSE_PROXY",
      "protocolTransformation": false,
      "relativePath": "/petstore",
      "clientRoute": {
        "relativePathList": ["/petstore"]
      },
      "routing": {
        "apiRoutingList": [
          {
            "url": "https://petstore.example.com/v2"
          }
        ]
      },
      "categoryList": ["public"],
      "apiProxyDeployList": [
        {
          "environmentSettingsId": "66a1f0d25d4b2e7a91c04a02",
          "environmentName": "prod",
          "accessUrl": "https://gw.example.com/apigateway/petstore",
          "deploy": true,
          "redeployRequired": false
        }
      ]
    }
  ]
}

Response Fields

Field	Type	Description
id	string	API Proxy identifier. Send it back in the promotion request only when updating an existing proxy in the target project
name	string	API Proxy name
description	string	API Proxy description
type	string	API type (REVERSE_PROXY, AI, MCP, A2A, …)
protocolTransformation	boolean	Whether protocol transformation is enabled
relativePath	string	Gateway relative path
clientRoute	object	Client-side routing definition
routing	object	Backend routing configuration
categoryList	array	Categories assigned to the proxy
apiProxyDeployList	array	Deployment records of the source project — see the note below

Note

apiProxyDeployList describes the deployment state in the source project. It is informational here: the promotion endpoint never carries these flags to the target project. See Save API Proxy for Promotion for how the target's own deployment state is handled.

Error Responses

Code	Meaning
400	Validation error, or the license API count limit has been exceeded
401	Token is missing, invalid, or expired
500	Server error

Example

curl -X GET "https://apinizer.example.com/apiops/projects/dev-project/apiProxies/forpromotion" \
  -H "Authorization: Bearer YOUR_TOKEN"

Related Documentation

• Save API Proxy for Promotion
• List API Proxies
• Deploy API Proxy