Manage an existing cluster

post

http://localhost:8080/api/v1/clusters/{id}/manage

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integer

required

Body Params

Request struct for cluster maintenance

auth_info

object

Info for deployment system authorization

playbook

string

Ansible playbook file name. Defaults to config_pgcluster.yml when omitted

tags

string

Optional comma-separated Ansible tags used to limit playbook execution

inventory

object

Optional Ansible inventory JSON object. When provided, it overrides the stored inventory for this run and is persisted to the cluster

envs

array of strings

envs

extra_vars

object

Persistent Ansible extra vars. When provided, replaces the cluster extra_vars after a successful operation

runtime_extra_vars

object

Runtime-only Ansible extra vars for this operation. Passed as a second --extra-vars argument after persistent extra_vars and never saved to the cluster

new_nodes

array of objects

length ≥ 1

Own-machine nodes added to the PostgreSQL, load balancer, and managed DCS inventory groups by add_node playbook

new_nodes

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Error