Workers

List Workers

List all of the registered worker machines in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.

get/{spaceId}/workers

Request

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

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

Query parameters

commStylesstring[]

List of communication styles which if specified, filters the result to only include Workers with matching communication styles.

healthStatusesstring[]

List of health statuses which if specified, filters the result to only include Deployment Targets with matching health statuses.

idsstring[]

List of Worker IDs which if specified, filters the result to only include Workers with matching IDs.

isDisabledboolean

A filter to return only disabled/enabled Workers

namestring

The exact name of a Worker to be matched

operatingSystemNamesstring[]

List of operating system names which if specified, filters the result to only include Workers with matching operating systems.

partialNamestring

A partial or complete name to search on. This will perform a "contains" style match against the supplied name or name-fragment

shellNamesstring[]

List of shell names which if specified, filters the result to only include Workers with matching shells.

skipinteger

Number of items to skip. Defaults to zero

takeinteger

Number of items to take. Defaults to 30

workerPoolIdsstring[]

List of Worker Pool IDs which if specified, filters the result to only include Workers belonging to these Worker Pools.

Response

A paginated list of Workers

Idstring

Gets or sets a unique identifier for this resource.

ItemsPerPageinteger
ItemTypestring

The type of item in this list

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.

LastPageNumberinteger
Linksobject

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

NumberOfPagesinteger
TotalResultsinteger

Example response

{
  "Items": [
    {
      "Endpoint": {
        "Links": {
          "Self": "/api/..."
        }
      },
      "Links": {
        "Self": "/api/..."
      },
      "SpaceId": "Spaces-1",
      "WorkerPoolIds": [
        "WorkerPools-1",
        "..."
      ]
    }
  ],
  "ItemsPerPage": 30,
  "ItemType": "Worker",
  "LastPageNumber": 1,
  "Links": {
    "Self": "/api/..."
  },
  "NumberOfPages": 2,
  "TotalResults": 42
}

Changes

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