WorkerPools

Get a list of WorkerResources for the given WorkerPoolResource

Lists all of the machines that belong to the given worker pool.

get/workerpools/{id}/workers

Request

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

idstring required

ID of the WorkerPool

Query parameters

commStylesstring[]
deploymentTargetTypesstring[]
healthStatusesstring[]
isDisabledboolean
operatingSystemNamesstring[]
partialNamestring
shellNamesstring[]
skipinteger

Number of items to skip. Defaults to zero

takeinteger

Number of items to take. Defaults to 20

Response

The requested list of Workers within a Worker Pool

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.