Skip to main content

GET List Environments

The api retrieves all environment listed under project setting for any workspace

Updated this week

API Endpoint


{{apiUrl}}/api/v1/properties/environments?projectKey={{projectKey}}

This api makes use of three query parameters namely, projectKey, startAt, 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}}


Generate a Token from Vansah

Request Query Parameters


startAt

{{startAt}}

Optional Rows start at e.g start at 5 out of 15 rows , it will fetch 10 rows from 5 to 15 (for pagination)

limit

{{limit}}

Optional Number of rows to be displayed , default 50

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"

}

]

}


​

Did this answer your question?