Skip to main content
PATCH
Change a pool

Authorizations

Authorization
string
header
required

An org API key (gh_live_…) from Settings → API keys in the console.

Path Parameters

pool_id
string
required

Body

application/json
name
string
Required string length: 1 - 80
computer_ids
string[]

The org’s linked computers, by id. The whole list.

Maximum array length: 200

Response

The pool.

object
any
id
string
Example:

"pool_8fK2mQ0aLp4x"

name
string
Maximum string length: 80
computer_ids
string[]
created_at
string<date-time>