Change something through an operation
apiRuns one change (POST, PUT, PATCH or DELETE) of The Deployer's app as the person, with the same permission checks the app applies: domains, scaling, start/stop and schedules, databases and other cloud services, app access, build inputs, code review, hosting plans, retries, environments, blueprints, servers, adoption and more. Needs Operate access. Some changes cost money or change a live app. Secrets are never returned. Documented at https://portal.thedploy.com/docs.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"method": "<method>",
"path": "<path>"
},
"name": "api"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| body | No | The JSON body, for POST, PUT and PATCH | |
| path | Yes | The operation's path with ids filled in, e.g. /projects/12/scaling | |
| query | No | Query parameters | |
| method | Yes | ||
| workspace | No | A teammate's workspace id. Default: your own. |