Search the docs

Search guides, API endpoints and MCP tools.

Catalog

update_deployment

Write grantIdempotent

Change a deployment's base URL, Fixture API URL or version. Only the fields given change. Record the version after each deploy. Refused while the product or environment is archived. Returns the deployment. Needs write access.

Inputs

productstringRequired

The product's slug, such as storefront.

environmentstringRequired

The environment's slug, such as staging.

baseUrlnullable string

The http:// or https:// URL where the product answers in this environment, such as https://staging.acme.dev. Website and API products need one. null clears it.

fixtureUrlnullable string

The http:// or https:// URL of the deployment's Fixture API, which test runs call to create and delete test data, such as https://staging.acme.dev/fixtures. null clears it.

versionnullable string

The build running in this environment, such as a git SHA or v2.4.1, up to 100 characters. null clears it.

tools/callJSON-RPC
{  "jsonrpc": "2.0",  "id": 1,  "method": "tools/call",  "params": {    "name": "update_deployment",    "arguments": {      "product": "storefront",      "environment": "production",      "version": "v2.4.1"    }  }}
POST/agent/v1/deployments:update
curl -X POST https://api.qa.clankership.net/agent/v1/deployments:update \  -H "Authorization: Bearer $CLANKER_AGENT_TOKEN" \  -H "Content-Type: application/json" \  -d '{    "product": "storefront",    "environment": "production",    "version": "v2.4.1"  }'
The same call over the agent HTTP API. Set CLANKER_AGENT_TOKEN to an agent OAuth access token.