API keys

An API key lets your own servers, scripts, and scheduled tasks call a Digitospace API, such as the Scheduler REST API. A key belongs to an organisation, not to a person, so it keeps working when people join or leave your team.

Each key is for one service, and can only do what you choose when you create it.

What a key can do

When you create a key, you choose:

Servicechoice

The API the key calls, such as Scheduler.

Permissionschoice

What it may do in that service. For the scheduler: View, Create, Edit, Delete, and Run jobs.

Projectschoice

All projects, including new ones, or only the projects you choose.

Expireschoice

Never, or in 30 days, 90 days, or 1 year.

A key can’t manage your team, your organisation, or other keys.

Create a key

1. Open API keys

   In the console, check the organisation at the bottom of the sidebar, then open API keys.

2. Choose what the key can do

   Select Create API key, then choose the service, a name, its permissions, its projects, and when it expires.

3. Copy the key

   Select Create, then copy the key. It starts with dsk_. You can’t see it again after you close the dialog, so store it straight away.

You can give a key only the permissions your own access includes. See Team members and access.

Use a key

Send the key as a bearer token on every request:

Authorization: Bearer dsk_…

For example, to list a project’s scheduler jobs:

curl "https://scheduler-api.digitospace.com/v1/projects/$PROJECT_ID/jobs" \
  -H "Authorization: Bearer $API_KEY"

When a request is refused

Delete a key

Open API keys, then select Delete on the key. Anything using it stops working within half a minute.

Limits