DeploymentTargets

Modify an existing Deployment Target (identified by ID).

put/machines/{machineid}

Request

Base URL
https://demo.octopus.app/api
URL
https://demo.octopus.app/api/machines/{machineid}
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

machineidstring required

Request body

EnvironmentIdsstring[] required

IsDisabledboolean

MachineIdstring required

MachinePolicyIdstring

Note: If this is unset, but the endpoint requires a policy, Octopus will update the machine with the default machine policy

Namestring required

Rolesstring[] required

Slugstring

SpaceIdstring required

TenantedDeploymentParticipation'Untenanted' | 'TenantedOrUntenanted' | 'Tenanted'

TenantIdsstring[]

TenantTagsstring[]

Thumbprintstring

Uristring

Example request

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

Response

The MachineResource following requested changes.

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