Deploy API Proxy Group

Endpoint

POST /apiops/projects/{projectName}/apiProxyGroups/{apiProxyGroupName}/environments/{environmentName}/

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	Project name
apiProxyGroupName	string	Yes	API Proxy Group name
environmentName	string	Yes	Environment name to deploy to

Query Parameters

None.

Request Body

Optional JSON body. When omitted, defaults are applied.

Field	Type	Required	Description
description	string	No	Description/notes for the deploy history record. Defaults to "Deployed by APIOPS Api" if not provided.
persistent	boolean	No	If true, this deploy history record will not be auto-deleted when the retention limit is reached. Defaults to false.

Example

{
  "description": "v2.1 release",
  "persistent": true
}

Response

Success Response (200 OK)

{
  "status": "SUCCESS",
  "deploymentResult": {
    "success": true,
    "responseTime": 150,
    "detailList": [
      {
        "envName": "production",
        "podName": "worker-abc123",
        "podIp": "10.0.0.1",
        "success": true,
        "responseTime": 150
      }
    ]
  }
}

Response Fields

Field	Type	Description
status	string	Response status: SUCCESS or FAILURE
deploymentResult	object	Deployment result. See Deployment Result Object

Deployment Result Object

Field	Type	Description
success	boolean	Overall deployment success status
responseTime	integer	Total deployment time in milliseconds
detailList	array[object]	Per-pod deployment results

Detail List Item

Field	Type	Description
envName	string	Environment name
podName	string	Worker pod name
podIp	string	Worker pod IP address
success	boolean	Deployment success for this pod
responseTime	integer	Deployment time for this pod in milliseconds

Error Response (400 Bad Request)

{
  "status": "FAILURE",
  "resultMessage": "API Proxy Group (PaymentAPIGroup) is not found or user does not have privilege to access it!"
}

or

{
  "status": "FAILURE",
  "resultMessage": "Environment (production) is not found or user does not have privilege to access it!"
}

cURL Example

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

With Description and Persistent Flag

curl -X POST \
  "https://demo.apinizer.com/apiops/projects/MyProject/apiProxyGroups/PaymentAPIGroup/environments/production/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"description": "v2.1 release", "persistent": true}'

Notes and Warnings

• Group Deployment:

  • All API Proxies in the group are deployed together
  • Group-level settings (CORS, cache, etc.) are also deployed

• Environment Must Exist:

  • Environment must exist and be accessible

Permissions

• User must have API_MANAGEMENT + MANAGE and API_MANAGEMENT + DEPLOY_UNDEPLOY permissions in the project

Related Documentation

• Undeploy API Proxy Group - Undeploy group from environment
• List Environments - List environments for group