Deploy API Proxy

Overview

Deploys an API proxy to a specific environment. The API proxy becomes available in the target environment after successful deployment.

Endpoint

POST /apiops/projects/{projectName}/apiProxies/{apiProxyName}/environments/{environmentName}/

Authentication

Requires a Personal API Access Token.

Authorization: Bearer YOUR_TOKEN

Request

Headers

Header	Value	Required
Authorization	Bearer {token}	Yes

Path Parameters

Parameter	Type	Required	Description
projectName	string	Yes	Project name
apiProxyName	string	Yes	API Proxy name (must exist)
environmentName	string	Yes	Environment name (must exist)

Query Parameters

None

Request Body

This endpoint does not require a request body.

Response

Success Response (200 OK)

{
  "success": true,
  "deploymentResult": {
    "success": true,
    "deploymentResults": [
      {
        "environmentName": "production",
        "success": true,
        "message": "Deployment successful"
      }
    ]
  }
}

Response Fields

Field	Type	Description
success	boolean	Indicates if the request was successful
deploymentResult	object	Deployment result
deploymentResult.success	boolean	Overall deployment success
deploymentResult.deploymentResults	array	Individual environment deployment results
deploymentResult.deploymentResults[].environmentName	string	Environment name
deploymentResult.deploymentResults[].success	boolean	Deployment success for this environment
deploymentResult.deploymentResults[].message	string	Deployment message

Error Response (400 Bad Request)

{
  "error": "bad_request",
  "error_description": "ApiProxy with name (petstore-api) can not be deployed to Environment(production) because it is not exist!"
}

Common Causes

API Proxy name does not exist
Environment name does not exist
User does not have access to the environment
Deployment failed (check deploymentResult for details)

Error Response (401 Unauthorized)

{
  "error": "unauthorized_client",
  "error_description": "Invalid token"
}

Error Response (404 Not Found)

{
  "error": "not_found",
  "error_description": "Project (MyProject) is not found or user does not have privilege to access it!"
}

cURL Example

curl -X POST \
  "https://demo.apinizer.com/apiops/projects/MyProject/apiProxies/petstore-api/environments/production/" \
  -H "Authorization: Bearer YOUR_TOKEN"

Full JSON Body Example