Get Environments by Project

Endpoint

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

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

Query Parameters

None.

Response

Success Response (200 OK)

{
  "status": "SUCCESS",
  "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

Field	Type	Description
status	string	Response status: SUCCESS or FAILURE
resultList	array[object]	List of environments accessible from the project
resultCount	integer	Total number of environments

Environment Object

Field	Type	Description
id	string	Environment unique identifier
name	string	Environment name
description	string	Environment description (optional)
type	string	Environment type. See EnumEnvironmentType
accessUrl	string	Gateway access URL for this environment
status	string	Publish status. See EnumPublishStatus
deployed	boolean	Whether the environment is deployed (only populated in API Proxy/Group context)
redeployRequired	boolean	Whether redeployment is required (only populated in API Proxy/Group context)

EnumEnvironmentType

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

EnumPublishStatus

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

Error Response (400 Bad Request)

Returned when the project is not found or the user does not have access to the project:

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

Error Response (401 Unauthorized)

{
  "status": "FAILURE",
  "resultMessage": "Invalid or expired token"
}

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 have any permission in the project
• Access errors: Project not found or insufficient access returns 400 Bad Request, not 403 Forbidden

Related Documentation

• List Environments - Get all environments (admin only)
• Projects API - Project management endpoints
• Authentication Guide - How to obtain and use API tokens