Create My Api Key
const url = 'https://example.com/auth/api-keys/';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"name":"example","expires_at":"2026-04-15T12:00:00Z","scope":"full"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/auth/api-keys/ \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "name": "example", "expires_at": "2026-04-15T12:00:00Z", "scope": "full" }'Create an API key for the current user.
The raw key is returned only in this response and cannot be retrieved again. Requires a signed-in session: a request that presents an API key gets 403.
Authorizations
Section titled “ Authorizations ”Request Bodyrequired
Section titled “ Request Bodyrequired ”object
Human-readable label for the API key
Privilege scope. ‘full’ impersonates the owner completely. ‘read_only’ authenticates GET, HEAD and OPTIONS requests only; any other method is refused with 403. ‘publish’ also allows uploads, manifest apply, dataset metadata edits and new maps, but no map update, delete, feature write, public visibility, admin or key route.
Responses
Section titled “ Responses ”Successful Response
object
The API key secret (shown only once)
Non-secret key identifier (prefix and last four characters)
Privilege scope: ‘full’, ‘read_only’, ‘publish’ (reads, uploads, manifest apply, dataset metadata edits and new maps, but no map updates, deletes, feature writes or public visibility), ‘dataset_write’ (reads and writes the features of the dataset in dataset_id, and nothing else), or ‘dataset_append’ (only creates features in that dataset)
Example generated
{ "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "key": "example", "fingerprint": "example", "name": "example", "expires_at": "2026-04-15T12:00:00Z", "scope": "example", "dataset_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "created_at": "2026-04-15T12:00:00Z"}Bad request — invalid query parameters or payload
Unauthorized — missing or invalid credentials
Forbidden — caller lacks access to this resource
Not found
Validation error
Too many requests — retry after the advertised interval
Headers
Section titled “ Headers ”Seconds until the request may be retried
Internal server error
Service unavailable — the database could not serve the request