WorkerTaskLeases

Get WorkerTaskLeases

Gets a paginated set of WorkerTaskLeases.

get/{spaceId}/workertaskleases

Request

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

Query parameters

skipinteger required

Number of items to skip

takeinteger required

Number of items to take

Response

Rseponse to getting set of WorkerTaskLeases

Example response

{
  "WorkerTaskLeases": {
    "Items": [
      {
        "ServerTaskId": "ServerTasks-1",
        "SpaceId": "Spaces-1",
        "WorkerId": "Workers-1",
        "WorkerPoolId": "WorkerPools-1"
      }
    ],
    "ItemsPerPage": 30,
    "ItemType": "WorkerTaskLease",
    "LastPageNumber": 1,
    "Links": {
      "Self": "/api/..."
    },
    "NumberOfPages": 2,
    "TotalResults": 42
  }
}

Changes

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