Request a change

Asks Vigilbase to make a change for the customer. Needs a verified email for customer callers.

Deprecated aliases: POST https://one.vigilbase.com/api/change-requests. They answer with the same bodies, with a Deprecation header and a successor-version link to this URL.

POST/change-requests

Authorizations

Send one of these:

AuthorizationstringAccess tokenheaderrequired

Bearer access token from Vigilbase Identity (auth.vigilbase.com), sent as Authorization: Bearer <token>. The CLI gets one with vigilbase login. Scope: one:api.

AuthorizationstringAPI keyheaderrequired

Organisation API key (vb_one_…) from Settings → API keys in Vigilbase One, sent as Authorization: Bearer vb_one_…. Needs a key with write access: read-only keys get 403 with the code read_only_key. See organisation API keys.

AuthorizationstringMCP tokenheaderrequired

Vigilbase Identity access token issued to an MCP client (mcp.vigilbase.com). Scope: one:write.

Permissions checkedread:services

Headers

Idempotency-Keystring

A unique key for this write (a UUID is recommended). A retry with the same key and body returns the first answer (draft-ietf-httpapi-idempotency-key-header-08).

min length 1max length 255

Body

application/json

customerIdstringuuidrequired

titlestringrequired

min length 5max length 200

descriptionstringrequired

min length 10max length 5000

referencestring

min length 1max length 1000

Response

application/json

Success

idstringuuidrequired

customerIdstringuuidrequired

titlestringrequired

descriptionstringrequired

referencestring | nullrequired

statusstringrequired

One of:requestedawaiting_customer_approvalreadyexecutingappliedawaiting_propagationverification_failedfaileduncertainrejectedexpiredrolling_backrolled_backrollback_awaiting_propagationrollback_uncertaincompleted_manually

revisionintegerrequired

minimum -9007199254740991maximum 9007199254740991

hasPlanbooleanrequired

Whether Vigilbase has prepared the exact change.

approvalExpiresAtanyrequired

errorstring | nullrequired

createdAtstringdate-timerequired

updatedAtstringdate-timerequired

2 response headers

X-Request-Idstring

The request ID: yours when it was well-formed, otherwise a new one. Quote it to support.

API-Versionstring

The major API version (informational; the version is in the path).

# Token from `vigilbase login`, or a write API key (vb_one_…)
curl --request POST \
  --url 'https://api.vigilbase.com/one/v1/change-requests' \
  --header "Authorization: Bearer $VIGILBASE_TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{"customerId":"<uuid>","title":"<string>","description":"<string>","reference":"<string>"}'

Set VIGILBASE_TOKEN to an Identity access token or an organisation API key first, or use Try it.

{
  "id": "<uuid>",
  "customerId": "<uuid>",
  "title": "<string>",
  "description": "<string>",
  "reference": "<string>",
  "status": "requested",
  "revision": 123,
  "hasPlan": true,
  "approvalExpiresAt": "<any>",
  "error": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Was this page helpful?