Sign in
WorkerPools

Get a list of WorkerResources for the given WorkerPoolResource

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

get/spaces/{spaceIdentifier}/workerpools/{id}/workers

Path parameters

spaceIdentifierstring required

Identifier (ID or slug) of the space

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
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": [
    {
      "SpaceId": "Spaces-1",
      "WorkerPoolIds": [
        "WorkerPools-1",
        "..."
      ]
    }
  ]
}

Changes

No recorded changes to this endpoint across all 6 revisions of this API.