API Overview

The Errthquake API gives customers the same features and functions that are available in the Errthquake portal, through an HTTP interface delivering JSON documents.

The API is hosted at https://api.errthquake.com/. API calls require an Authorization header that identifies the caller. The identity of the caller determines which workspace can be accessed and what resources and actions are available to them there.

Authorization

Service Account Authorization

Include an Authorization header in Errthquake API calls, using the Authorization token provided when the service account was created on the portal's Access & Permissions page.

Example using the curl utility:

curl -H "Authorization: xxxxxxxxxxxxxxx= yyyyyyyyyyyyyy..." \
  https://api.errthquake.com/workspaces

Service account authorization tokens do not expire, but service account permissions can be changed and a service account can be deleted.

Service Account Creation

Service accounts are created on the Access & Permissions page in the Errthquake Portal, with initial permissions assigned at creation time. Customers must have the Manage Service Accounts permission in order to create service accounts.

Customers who can create service accounts also have permission to update their permissions and delete service accounts.

Service accounts are tied to a single workspace. Customers operating multiple workspaces should create service accounts for each workspace they would like to manage through the Errthquake API.

Errthquake APIs