View or Run in Postman
API Endpoint
{{apiUrl}}/api/v2/properties/environments
Returns the list of environments available for a given project.
Use this endpoint to retrieve environment records associated with the project identified by projectKey. You can also paginate the results with startAt and limit.
Headers
To authenticate the API request, you need to provide the Vansah Connect Token that is generated from the Jira workspace's Vansah configuration page.
Authorization | {{vansahConnectToken}}
|
Request Query Parameters
startAt | {{startAt}}
|
limit | {{limit}}
|
projectKey | {{projectKey}} Jira Project Key (Required for vansah connect API calls), e.g. ("TEST", "PRODAPP") |
Example Response Body
{
"success": true,
"message": "Environments returned successfully",
"pagination": {
"total": 3,
"startAt": 0,
"limit": 50
},
"data": [
{
"identifier": "efa67a67-0386-11f0-b619-a6332c493f52",
"name": " new"
},
{
"identifier": "8cc5aea6-f311-11ef-892e-2e4c1a6a0f74",
"name": "SYS"
},
{
"identifier": "8cc5c440-f311-11ef-892e-2e4c1a6a0f74",
"name": "UAT"
}
]
}