API keys

API keys let your scripts, integrations and internal tools call the ServiceOps API on behalf of your organization. Each key carries scopes — the only capabilities it grants. A key without a scope can do nothing with the routes that scope protects, whatever else is configured.

Create a key

1. Open Organization → Settings → API keys.
2. Choose Create a key, name it after the system that will use it — “Monitoring bridge”, not “key 2”.
3. Select only the scopes that system needs.
4. Copy the key now: it is shown once. ServiceOps stores only a hash.

Available scopes

Scope	Grants
ticket.read	Read tickets
ticket.create	Create tickets
ticket.update	Modify tickets
ticket.comment	Comment on tickets
ticket.close	Close tickets
knowledge.read	Read knowledge articles
knowledge.search	Search the knowledge base
ai_assist.use	Call the AI Assist API
organization.read	Read organization information

Use a key

Send it in the Authorization header:

curl https://your-desk.example.com/api/v1/assist \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"message": "How do I reset my VPN access?"}'

Endpoint reference: API overview.

Revoke and monitor

• Revoke a key the moment the system using it is decommissioned — revocation is immediate.
• Each key’s usage is visible next to it: last use and call counts, so a forgotten key is easy to spot and retire.

Caution

Treat a key like a password: store it in your secret manager, never in source code, and create one key per consuming system so revoking one never breaks another.