API Reference
Log InSign UpBlog

Update an Agent Pool

patch
https://{Domain}/api/iacp/v3/agent-pools/

This endpoint updates an agent pool by ID.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The ID of the agent pool to be updated.

Query Params
include
array of strings

The comma-separated list of relationship paths.

include
Body Params

JSON:API Document.

see: https://jsonapi.org/format/#document-structure

data
object

With the agent pool resource you can manage a pool of self-hosted agents

A workspace may be configured to use an agent pool to execute terraform runs. Agents could be hosted on a physical or virtual machines within the customer's network.

Responses

403

User unauthorized to perform this action.

404

User not authorized or agent pool not found.

409

Quota exceeded error.

422

Malformed request body (missing attributes, wrong types, etc.).

4XX

Client error.

5XX

Server error.

Updated 12 days ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/vnd.api+json

Updated 12 days ago