Environment
The Environment API alows you to retrieve information about Environments within an organization.
Path parameters
orgUUIDstringRequired
A valid organization Uuid
Responses
200
OK
*/*
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
get
GET /org/{orgUUID}/environments HTTP/1.1
Host:
Accept: */*
{
"uuid": "text",
"organizationUuid": "text",
"instanceUuid": "text",
"instanceName": "text",
"channelInstanceUuid": "text",
"channelInstanceName": "text",
"connectorInstanceUuid": "text",
"connectorInstanceName": "text",
"dns": "text",
"apiURL": "text",
"name": "text",
"removed": true,
"channelApiUrl": "text",
"connectorApiUrl": "text",
"applications": [
{
"version": "text",
"name": "text",
"properties": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
],
"permissions": [
"text"
]
}
Path parameters
orgUUIDstringRequired
A valid organization Uuid
envUUIDstringRequired
A valid environment Uuid
Responses
200
OK
*/*
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Resource not found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
get
GET /org/{orgUUID}/environments/{envUUID} HTTP/1.1
Host:
Accept: */*
{
"uuid": "text",
"organizationUuid": "text",
"instanceUuid": "text",
"instanceName": "text",
"channelInstanceUuid": "text",
"channelInstanceName": "text",
"connectorInstanceUuid": "text",
"connectorInstanceName": "text",
"dns": "text",
"apiURL": "text",
"name": "text",
"removed": true,
"channelApiUrl": "text",
"connectorApiUrl": "text",
"applications": [
{
"version": "text",
"name": "text",
"properties": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
],
"permissions": [
"text"
]
}
Last updated
Was this helpful?