Vigilbase One APISupport

Open a support ticket

Opens a support request with Vigilbase. Send an Idempotency-Key so a retry never opens a second request. Staff must name the customer with customerId; everyone else gets their own organisation’s customer.

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

POST/support-tickets

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. Organisation API keys can't call this endpoint: it acts for a signed-in person or changes how people sign in. Scope: one:api.

AuthorizationstringMCP tokenheaderrequired

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

Permissions checkedsupport:access

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

subjectstringrequired

min length 5max length 200

descriptionstringrequired

min length 20max length 40000

prioritystring

One of:lowmediumhighurgentDefault:"medium"

serviceCategorystring

min length 1max length 128

ccEmailsstring[]

max 20 items

attachmentUrlsstring[]

Up to five file links from Vigilbase’s support attachment upload (Pylon links only).

max 5 items

customerIdstringuuid

Response

application/json

Success

ticketIdstringrequired

pattern ^[A-Za-z0-9-]{1,64}$

ticketNumberstringrequired

replayedbooleanrequired

True when an earlier request with the same Idempotency-Key already created it.

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).

More about this endpoint in the guide.

# Token from `vigilbase login`. API keys can't call this.
curl --request POST \
  --url 'https://api.vigilbase.com/one/v1/support-tickets' \
  --header "Authorization: Bearer $VIGILBASE_TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{"subject":"<string>","description":"<string>","priority":"medium","serviceCategory":"<string>","ccEmails":["<string>"],"attachmentUrls":["<string>"],"customerId":"<uuid>"}'

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

{
  "ticketId": "<string>",
  "ticketNumber": "<string>",
  "replayed": true
}

Was this page helpful?