Ana içeriğe atla

Documentation Index

Fetch the complete documentation index at: https://docs.apinizer.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Endpoint

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

​
Authentication

Requires a Personal API Access Token. 
Authorization: Bearer YOUR_TOKEN

​
Request

​
Headers

HeaderValueRequired
AuthorizationBearer Yes

​
Path Parameters

ParameterTypeRequiredDescription
projectNamestringYesProject name

​
Query Parameters

None.

​
Response

​
Success Response (200 OK)

{
  "success": true,
  "resultList": [
    {
      "id": "60a7b1c2d3e4f5g6h7i8j9k0",
      "name": "production",
      "description": "Production environment",
      "type": "PRODUCTION",
      "accessUrl": "https://gw.example.com",
      "status": "PUBLISHED",
      "deployed": null,
      "redeployRequired": null
    },
    {
      "id": "60a7b1c2d3e4f5g6h7i8j9k1",
      "name": "staging",
      "description": "Staging environment",
      "type": "SANDBOX",
      "accessUrl": "https://gw-staging.example.com",
      "status": "PUBLISHED",
      "deployed": null,
      "redeployRequired": null
    }
  ],
  "resultCount": 2
}

​
Response Fields

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

​
Environment Object

FieldTypeDescription
idstringEnvironment unique identifier
namestringEnvironment name
descriptionstringEnvironment description (optional)
typestringEnvironment type. See EnumEnvironmentType
accessUrlstringGateway access URL for this environment
statusstringPublish status. See EnumPublishStatus
deployedbooleanWhether the environment is deployed (only populated in API Proxy/Group context)
redeployRequiredbooleanWhether redeployment is required (only populated in API Proxy/Group context)

​
EnumEnvironmentType

  • PRODUCTION - Production environment
  • SANDBOX - Sandbox/staging environment
  • TEST - Test environment

​
EnumPublishStatus

  • PUBLISHED - Environment is published and active
  • UNPUBLISHED - Environment is not published
  • REPUBLISH_REQUIRED - Environment needs to be republished due to configuration changes

​
Error Response (400 Bad Request)

{
  "error": "bad_request",
  "error_description": "Project not found"
}

​
Error Response (401 Unauthorized)

{
  "error": "unauthorized",
  "error_description": "Invalid or expired token"
}

​
Error Response (403 Forbidden)

{
  "error": "forbidden",
  "error_description": "User does not have access to this project"
}

​
cURL Example

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

​
Permissions

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

​
Notes and Warnings

  • Project Membership: User must be a member of the project to access environments
  • Returns only environments accessible through project membership
  • Project Access: If user doesn’t have access to the project, returns 403 Forbidden