Account and organizations API

On this page

Identify the key’s owner, manage personal API tokens, read and update your organization, and validate cron expressions.

Paths are relative to https://<your-atlas-host>/api/v1. For the API key and headers every request needs, see Authentication.

Scroll horizontally to see the full table.

Endpoint	What it does
GET /auth/me	Return the user or service account the API key belongs to
GET /tokens/	List the authenticated user’s active tokens
POST /tokens/	Create a new API token
DELETE /tokens/{token_id}	Revoke an API token
GET /tenants/	List organizations the authenticated user can access
POST /tenants/	Create a new organization with the authenticated user as owner
GET /tenants/current	Get your organization’s details
PATCH /tenants/current	Update your organization (display_name, settings, plan)
POST /utils/cron/validate	Validate a cron expression and return human-readable info

Get the key’s owner

GET /auth/me

Return the user or service account the API key belongs to.

Response

Scroll horizontally to see the full table.

Field	Type
`id`	UUID
`email`	string
`display_name`	string

List tokens

GET /tokens/

List the authenticated user’s active tokens.

Response A list of objects:

Scroll horizontally to see the full table.

Field	Type
`id`	UUID
`name`	string
`prefix`	string
`is_active`	boolean
`last_used_at`	datetime
`created_at`	datetime

Create token

POST /tokens/

Create a new API token. The raw key is returned once.

Request body

Scroll horizontally to see the full table.

Field	Type
`name`	string

Response

Scroll horizontally to see the full table.

Field	Type
`id`	UUID
`name`	string
`key`	string

Revoke token

DELETE /tokens/{token_id}

Revoke an API token.

Parameters

Scroll horizontally to see the full table.

Name	In	Type	Required
`token_id`	path	UUID	Yes

Response

The raw file content.

List organizations

GET /tenants/

List organizations the authenticated user can access.

Response A list of objects:

Scroll horizontally to see the full table.

Field	Type
`id`	UUID
`name`	string
`display_name`	string
`plan`	string
`is_active`	boolean
`created_at`	datetime
`updated_at`	datetime
`is_owner`	boolean
`is_default`	boolean

Create organization

POST /tenants/

Create a new organization with the authenticated user as owner.

Request body

Scroll horizontally to see the full table.

Field	Type	Required
`name`	string
`display_name`	string	Yes
`plan`	string
`status`	string

Response

Scroll horizontally to see the full table.

Field	Type
`id`	UUID
`name`	string
`display_name`	string
`plan`	string
`is_active`	boolean
`created_at`	datetime
`updated_at`	datetime

Get current organization

GET /tenants/current

Get your organization’s details.

Response

Scroll horizontally to see the full table.

Field	Type
`id`	UUID
`name`	string
`display_name`	string
`plan`	string
`is_active`	boolean
`created_at`	datetime
`updated_at`	datetime

Update current organization

PATCH /tenants/current

Update your organization (display_name, settings, plan).

Request body

Scroll horizontally to see the full table.

Field	Type
`display_name`	string
`settings`	object
`plan`	string

Response

Scroll horizontally to see the full table.

Field	Type
`id`	UUID
`name`	string
`display_name`	string
`plan`	string
`is_active`	boolean
`created_at`	datetime
`updated_at`	datetime

Validate a cron expression

POST /utils/cron/validate

Validate a cron expression and return human-readable info.

Request body

Scroll horizontally to see the full table.

Field	Type	Required
`expression`	string	Yes

Response

Scroll horizontally to see the full table.

Field	Type
`valid`	boolean
`description`	string
`next_runs`	list of string
`error`	string

What’s next?

API overview: authentication, worked examples, and error handling
Webhooks: get events pushed to your systems instead of polling
Service accounts: create the key an integration uses