Environments
Authorizations
Responses
200
Success
application/json
get
GET /api/v1/environments HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
200
Success
{
"data": [
{
"id": 1,
"displayName": "text",
"agentGroups": [
{
"id": 1,
"displayName": "text",
"internalName": "text",
"isCrossPlatform": true,
"agents": [
"text"
],
"environment": {
"id": 1,
"displayName": "text"
},
"agentDetails": [
{
"url": "text",
"httpPorts": [
"text"
],
"httpsPorts": [
"text"
],
"id": 1,
"name": "text",
"isGateway": true
}
]
}
],
"internalName": "text"
}
]
}
Authorizations
Path parameters
environmentIdinteger · int64Required
Environment Identifier
Responses
200
Success
application/json
404
Environment not found
application/problem+json
get
GET /api/v1/environments/{environmentId} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"data": {
"id": 1,
"displayName": "text",
"agentGroups": [
{
"id": 1,
"displayName": "text",
"internalName": "text",
"isCrossPlatform": true,
"agents": [
"text"
],
"environment": {
"id": 1,
"displayName": "text"
},
"agentDetails": [
{
"url": "text",
"httpPorts": [
"text"
],
"httpsPorts": [
"text"
],
"id": 1,
"name": "text",
"isGateway": true
}
]
}
],
"internalName": "text"
}
}
Authorizations
Path parameters
environmentIdinteger · int64Required
Environment Identifier
Responses
200
Success
application/json
404
Environment not found
application/problem+json
get
GET /api/v1/environments/{environmentId}/agent-groups HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"data": [
{
"id": 1,
"displayName": "text",
"internalName": "text",
"isCrossPlatform": true,
"agents": [
"text"
],
"environment": {
"id": 1,
"displayName": "text"
},
"agentDetails": [
{
"url": "text",
"httpPorts": [
"text"
],
"httpsPorts": [
"text"
],
"id": 1,
"name": "text",
"isGateway": true
}
]
}
]
}
Was this helpful?