WorkerPools

Modify an existing worker pool.

Updates an existing worker pool.

put/workerpools/{id}

Request

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

idstring required

The ID of the worker pool

Request body

Descriptionstring

The description of the worker pool

Idstring required

The ID of the worker pool

IsDefaultboolean required

Whether the worker pool is the default or not

Namestring required

The name of the worker pool

Slugstring

The slug of the worker pool

SpaceIdstring required

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

WorkerTypestring

The worker image

Example request

{
  "Id": "WorkerPools-1",
  "SpaceId": "Spaces-1"
}

Response

Confirms that a Worker Pool was modified, containing the updated Worker Pool

CanAddWorkersboolean
Descriptionstring

Gets or sets a short description of this pool that can be used to explain the purpose of the pool to other users. May describe the kinds of machines in the pool. This field may contain markdown.

Idstring

Gets or sets a unique identifier for this resource.

IsDefaultboolean

Is this the default pool. The default pool is used for steps that don't specify a worker pool. The default pool, if empty, uses the builtin worker to run steps.

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.

Namestring

Gets or sets the name of this pool. This should be short, preferably 5-20 characters.

Slugstring
SortOrderinteger

Gets or sets a number indicating the priority of this pool in sort order. Pools with a lower sort order will appear in the UI before items with a higher sort order.

SpaceIdstring
WorkerPoolType'StaticWorkerPool' | 'DynamicWorkerPool'

Example response

{
  "Links": {
    "Self": "/api/..."
  },
  "SpaceId": "Spaces-1"
}

Changes

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