API Reference
Getting Started
Core Concepts
Backend API — Guides
Frontend API — Guides
OAuth & OpenID Connect — Guides
Enterprise: SSO & SCIM — Guides
Webhooks — Guides
SDKs
Backend API (BAPI)
Frontend API (FAPI)
Dashboard API
Public API
SCIM
OIDC
Platform

Restrictions

AdminUpdated Sep 11, 2026

Restrictions

Dashboard API — authenticated by an Atlas console (platform-instance) session, not a key.

4 routes. Each row is one endpoint with its explanation and whether it honours the Idempotency-Key header.

Method & path

Idem

Explanation

GET /v1/dashboard/accounts/:accountId/instances/:instanceId/restrictions

The allow and block lists plus whether allow-list-only sign-up is on.

POST /v1/dashboard/accounts/:accountId/instances/:instanceId/restrictions

Add an email, @domain or E.164 phone to the allow or block list. Owner or admin.

DELETE /v1/dashboard/accounts/:accountId/instances/:instanceId/restrictions/:id

Remove an allow/block list entry. Owner or admin.

PATCH /v1/dashboard/accounts/:accountId/instances/:instanceId/restrictions

Toggle allow-list-only sign-up, the switch that gives the allow list effect.

Was this page helpful?
Restrictions