DeploymentTargets

Get a list of Deployment Targets

Lists all of the Deployment Targets in the supplied Space. The results will be sorted alphabetically by name.

get/machines/all

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/machines/all
  • Auth
    • API key in header X-Octopus-ApiKey
    • or API key in query parameter ApiKey
    • or API key in header X-NuGet-ApiKey

Query parameters

idsstring[]

A comma separated list of Machine resource ids used to filter a query.

thumbprintstring

A thumbprint used to filter a query.

Response

Requested list of Deployment Targets

Architecturestring
EnvironmentIdsstring[]
HasLatestCalamariboolean
HealthStatus'Healthy' | 'Unavailable' | 'Unknown' | 'HasWarnings' | 'Unhealthy'
Idstring

Gets or sets a unique identifier for this resource.

IsDisabledboolean
IsInProcessboolean
LastModifiedBystring

Gets or sets the username of the user who last modified this resource.

LastModifiedOnstring date-time

Gets or sets the date/time that this resource was last modified.

Linksobject

Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.

MachinePolicyIdstring
Namestring
OperatingSystemstring
OperatingSystemVersionstring
Rolesstring[]
ShellNamestring
ShellVersionstring
SkipInitialHealthCheckboolean
Slugstring
SpaceIdstring
StatusSummarystring
TenantedDeploymentParticipation'Untenanted' | 'TenantedOrUntenanted' | 'Tenanted'
TenantIdsstring[]
TenantTagsstring[]
Thumbprintstring
Uristring

Example response

[
  {
    "Endpoint": {
      "Links": {
        "Self": "/api/..."
      }
    },
    "EnvironmentIds": [
      "Environments-1",
      "..."
    ],
    "Links": {
      "Self": "/api/..."
    },
    "SpaceId": "Spaces-1",
    "TenantIds": [
      "Tenants-1",
      "..."
    ]
  }
]

Changes

No recorded changes to this operation across all 13 revisions of this API.