Exploring the Boxis API reference

Exploring the API reference

The reference is one page. It lists every section from the Boxis catalog, the parameters of each command, and a sample in JSON, Shell, PHP, Python and Node.js.

Open the reference

Go to the API reference. You can read it without an account. Running a command needs a project key and a signed request from your application. The page does not sign in to your account and it does not execute a call for you.

Search

The field at the top of the side list filters sections and commands. A search for sendSMS leaves that command and hides the others. Clearing the field shows the full page again.

Sections

Each side entry is a section path, such as /sms or /domain. Live means commands run. Reserved means a call returns HTTP 501 and the canonical path. /dns is the zone section. /domain/zone is only an alias of the same section. /domain stays domain registration: contacts, nameservers, renewal, lock and DNSSEC.

A section link stays on this page. The address ends with a hash, for example /sms.

A command

Open a command to see its route, whether it reads or writes, and its parameters. The samples tabs show the same call in JSON, Shell, PHP, Python and Node.js. Replace the placeholders. Do not commit the secret.

Examples that are live today: GET /sms/credits reads the SMS credit, POST /sms/messages sends an SMS, DELETE /sms/messages/scheduled cancels a scheduled SMS. The HTTP call is always POST. The verb in the route is the signed method.

Download OpenAPI JSON or YAML from the top of the reference and import it into your HTTP client. The file uses the same six signature headers.