Environments
Return the list of machines in an environment that matches the filters requested by the user.
get/{spaceId}/environments/{id}/machines
Request
- Base URLhttps://demo.octopus.app/api
- URLhttps://demo.octopus.app/api/{spaceId}/environments/{id}/machines
- Auth
- API key in header X-Octopus-ApiKey
- or API key in query parameter ApiKey
- or API key in header X-NuGet-ApiKey
Path parameters
spaceIdstring required
ID of the space
idstring required
ID of the Environment
Query parameters
commStylesstring[]
deploymentTargetTypesstring[]
healthStatusesstring[]
isDisabledboolean
partialNamestring
rolesstring[]
shellNamesstring[]
skipinteger
Number of items to skip. Defaults to zero
takeinteger
Number of items per page. Defaults to 20
targetTagsstring[]
tenantIdsstring[]
tenantTagsstring[]
Response
The lists of all machines that belong to the given environment, and matches any specified filters.
Example response
{
"Items": [
{
"Endpoint": {
"Links": {
"Self": "/api/..."
}
},
"EnvironmentIds": [
"Environments-1",
"..."
],
"Links": {
"Self": "/api/..."
},
"SpaceId": "Spaces-1",
"TenantIds": [
"Tenants-1",
"..."
]
}
],
"ItemsPerPage": 30,
"ItemType": "Machine",
"LastPageNumber": 1,
"Links": {
"Self": "/api/..."
},
"NumberOfPages": 2,
"TotalResults": 42
}Changes
No recorded changes to this operation across all 13 revisions of this API.