Skip to content

Extension, API and automation

Tokens and the API

Create and manage aliases from a script, with a token that can be scoped and revoked.

Everything the dashboard does is an HTTP API, and you can use it directly.

A token

Create one under API. It is shown once. Store it where you would store a password, which means not in a repository.

Using it

curl -H "Authorization: Bearer $TOKEN" \
     -H "Accept: application/json" \
     https://app.skudo.org/api/v1/aliases

Creating one:

curl -X POST https://app.skudo.org/api/v1/aliases \
     -H "Authorization: Bearer $TOKEN" \
     -H "Content-Type: application/json" \
     -d '{"domain":"skudo.org","description":"acme shop"}'

Scope

A token created for the extension is restricted: it can create aliases and nothing else. A token you create yourself carries your account's abilities, so treat it accordingly and issue one per purpose.

Revoking

Individually, from the same page, immediately. If a machine holding a token is lost, revoke that token rather than changing your password.

Rate limits

The API is subject to the same alias limits as the dashboard, for the same reason. A script that creates addresses in a loop hits the monthly limit exactly as a person would.

Written for people using Skudo. If a page here is wrong or missing, tell us.