Ana içeriğe atla

​
Endpoint

GET /apiops/projects/{projectName}/apiProxyGroups/{apiProxyGroupName}/environments/

​
Authentication

Requires a Personal API Access Token. 
Authorization: Bearer YOUR_TOKEN

​
Request

​
Headers

HeaderValueRequired
AuthorizationBearer Yes

​
Path Parameters

ParameterTypeRequiredDescription
projectNamestringYesProject name
apiProxyGroupNamestringYesAPI Proxy Group name

​
Query Parameters

None.

​
Response

​
Success Response (200 OK)

{
  "success": true,
  "resultList": [
    {
      "environmentName": "production",
      "deployed": true
    },
    {
      "environmentName": "staging",
      "deployed": true
    },
    {
      "environmentName": "development",
      "deployed": false
    }
  ],
  "resultCount": 3
}

​
Response Fields

FieldTypeDescription
successbooleanIndicates if the request was successful
resultListarray[object]List of environments
resultCountintegerTotal number of environments

​
Environment Object

FieldTypeDescription
environmentNamestringEnvironment name
deployedbooleanWhether the API Proxy Group is deployed to this environment

​
Notes

  • Returns environments where the group is deployed
  • Empty list ([]) is returned if group is not deployed to any environment
  • resultCount is 0 if no deployments exist

​
Error Response (400 Bad Request)

{
  "error": "bad_request",
  "error_description": "API Proxy Group (PaymentAPIGroup) is not found or user does not have privilege to access it!"
}

​
cURL Example

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

​
Notes and Warnings

  • Deployment Status:
    • Shows only environments where group is deployed
    • Does not show all available environments

​
Permissions

  • User must have any permission in the project (read access)