The OpenAPI document behind this reference

The Slen API is described by one OpenAPI document: every operation, its parameters, the fields of its request and of its answers, the error codes. The pages of this section are drawn from that document. This page says what the document holds, what the pages show of it, and how to read the page of an operation.

The document

• The document follows OpenAPI 3.1. It describes version 1.0 of the API — the version the badge beside the name of this section shows, and the /v1 at the start of every path.

• Its first server is the base address of Overview, and every path of the document is relative to it.

• An operation asks for the API key in the Authorization header, as Bearer and the key — Authentication. The probes /health and /ready ask for none, and a few operations that set the workspace up answer only a person signed in to the console: to an API key they answer 403 with the code session_required.

• The texts of the document — what an operation does, what a field holds — are written in English, and this reference shows them in English in every language.

The API serves no copy of the document, and this reference offers none to download: the pages of this section are its readable form.

What the pages show

A page of a resource draws the operations of one part of the API from the document: Customers and credits, Executions and the other resource pages of this section. Beside the document, a page uses what the code of Slen says about each route:

• the scope a key needs to call the operation;

• whether the operation requires an Idempotency-Key;

• whether an API key can call it at all, or only a person signed in to the console;

• which SDK has a call that sends it.

Some operations of the document are on no page, among them the channel the console keeps open to Slen for live updates, the operations that set the workspace up — organizations, projects, keys, policies, members, webhook endpoints, alert rules — and the audit log. The console sets the workspace up and shows its audit log.

At the foot of a page drawn from the document, a line says which revision of the document and of the SDK it was made from. When a table of the reference and an answer of the API disagree, that line says which revision to compare with.

Read an operation

An operation of a page has its method and path, what it does, and then:

• the marks: the scope it needs, whether it requires an Idempotency-Key, which SDK has a call that sends it, whether it takes no key at all, and whether only a person signed in to the console can call it;

• the parameters of the path, of the query and the headers, each with its type and whether it is required;

• the request body, field by field, the fields of a nested object included;

• the answers, one for each status the operation answers with: the body and the headers. The body of a refusal is the envelope of an error — Overview.

A name of an error code in a text of the document is a link to its row on Error codes.

Where to go next

• Overview — the conventions every operation follows.

• Authentication — the key and its scopes.

• Error codes — what each code means and what to do about it.