Workers

Modify an existing worker machine.

put/spaces/{spaceIdentifier}/workers/{id}

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/spaces/{spaceIdentifier}/workers/{id}
  • 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

spaceIdentifierstring required

Identifier (ID or slug) of the space

idstring required

The ID of the worker

Request body

Idstring required

The ID of the worker

IsDisabledboolean required

Whether the worker is disabled or not

MachinePolicyIdstring

The policy the worker must adhere to

Namestring required

The name of the worker

Slugstring
SpaceIdstring required

The ID of the space containing the resource(s).

WorkerPoolIdsstring[] required

The worker pools the worker belongs to

Example request

{
  "Endpoint": {
    "Links": {
      "Self": "/api/..."
    }
  },
  "Id": "Machines-1",
  "MachinePolicyId": "MachinePolicies-1",
  "SpaceId": "Spaces-1",
  "WorkerPoolIds": [
    "WorkerPools-1",
    "..."
  ]
}

Response

The modified worker

Architecturestring
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
ShellNamestring
ShellVersionstring
SkipInitialHealthCheckboolean
Slugstring
SpaceIdstring
StatusSummarystring
Thumbprintstring
Uristring
WorkerPoolIdsstring[]

Example response

{
  "Endpoint": {
    "Links": {
      "Self": "/api/..."
    }
  },
  "Links": {
    "Self": "/api/..."
  },
  "SpaceId": "Spaces-1",
  "WorkerPoolIds": [
    "WorkerPools-1",
    "..."
  ]
}

Changes

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