Query Csp Org Environments
Returns the completee list of available environments for an organization.
Request
URI
GET
https://{api_host}/organizations/{organizationId}/environments
COPY
Path Parameters
string
organizationId
Required
URN ID of a CSP organization
Query Parameters
string
filter
Optional
Filter for a query.
string
sort
Optional
The direction of sort
Possible values are :
asc,
desc,
integer
page
Optional
Page to fetch, The first page is 1, so the effective offset will be ((page - 1) * pageSize).
integer
limit
Optional
limit
Responses
200
A paged array of Environments
Returns
Environments
of type(s)
application/json
This response body class contains all of the following:
InlineEnvironments0
{
"resultTotal": 0,
"pageCount": 0,
"page": 0,
"pageSize": 0,
"valueType": "string",
"values": [
{
"initial": false,
"service": "https://openapi-generator.tech",
"name": "name",
"location": "us-west-2",
"id": "id",
"url": "https://openapi-generator.tech",
"enabled": true
}
]
}
Response Headers
string
x-next
A link to the next page of responses
404
Not Found
Returns
Error
of type(s)
application/json
"Error Object"
string
code
Optional
Error code. It will be of format VCDC_some-number
array of
object
messageParameters
Optional
messageParameters
string
message
Required
Detailed error message.
string
localizedMessage
Optional
Localized error message.
string
type
Optional
Type of error.
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/organizations/{organizationId}/environments