Endpoint
Authentication
Requires a Personal API Access Token with admin role.Header
Request
Headers
| Header | Value | Required |
|---|---|---|
| Authorization | Bearer | Yes |
Path Parameters
None.Query Parameters
None.Response
Success Response (200 OK)
Response Fields
| Field | Type | Description |
|---|---|---|
| success | boolean | Indicates if the request was successful |
| resultList | array[object] | List of environments |
| resultCount | integer | Total number of environments |
Environment Object
| Field | Type | Description |
|---|---|---|
| environmentName | string | Environment name |
| description | string | Environment description (optional) |
Error Response (401 Unauthorized)
Error Response (403 Forbidden)
cURL Example
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
Related Documentation
- Get Environments by Project - Get environments for a specific project
- Authentication Guide - How to obtain and use API tokens

