Overview

An API token lets a tool send to SQIBS. Its scope (global, team or service) decides which services' filters are checked, and its type decides what it can do: open incidents, or create requests.

You need
Global Admin (global tokens) or Team Manager (team and service tokens)
Where
API Tokens
Result
A token for each tool that sends to SQIBS

Scope

Scope An incident sent with it is checked against Who manages it
Global The API filters of every service in every team. Each matching service gets an incident. Global Admin
Team The API filters of every service in that team. Global Admin, Team Manager
Service The API filter of that one service. Global Admin, Team Manager

Use the narrowest scope that works: a service token cannot open incidents anywhere else.

Type

  • Incident: for /v1/process, opens and resolves incidents.
  • Request: for /v1/request, creates requests that run automation workflows. Request tokens are global.

Using the wrong type returns 401.

Create a token

  1. Open API Tokens and use Select Token type to choose Global or a team.
  2. Click Create Global Token, Create team token or Create service token (choose the service), and choose the Type.
  3. Copy the token with Copy Token and store it in your tool's secret store.

A deleted or regenerated token stops working at once and cannot be reused.

API tracking (debug)

Turn on Debug on a token to save what it receives in the API log. It switches itself off after 48 hours. While it is off, nothing is saved, which keeps payloads private.

Deduplication time

Deduplication Time(in Minutes) discards a request with exactly the same content as one received within that time (default 10 minutes). SQIBS answers 208 for a discarded duplicate. This stops a tool that resends the same alert from opening extra incidents.