Ana içeriğe atla

Endpoint

GET /apiops/environments/

Authentication

Requires a Personal API Access Token with admin role.
Authorization: Bearer YOUR_TOKEN

Request

Headers

HeaderValueRequired
AuthorizationBearer Yes

Path Parameters

None.

Query Parameters

None.

Response

Success Response (200 OK)

{
  "success": true,
  "resultList": [
    {
      "environmentName": "production",
      "description": "Production environment"
    },
    {
      "environmentName": "staging",
      "description": "Staging environment"
    },
    {
      "environmentName": "development",
      "description": "Development environment"
    }
  ],
  "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
descriptionstringEnvironment description (optional)

Error Response (401 Unauthorized)

{
  "error": "unauthorized",
  "error_description": "Admin role required"
}

Error Response (403 Forbidden)

{
  "error": "forbidden",
  "error_description": "Insufficient permissions"
}

cURL Example

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

Permissions

  • User must have system admin (sysAdmin) role

Notes and Warnings

  • Admin Only: This endpoint requires system admin role
  • Regular users should use “Get Environments by Project” endpoint instead