Create Api Key

POST

/admin/api-keys/

const url = 'https://example.com/admin/api-keys/';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"user_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","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/admin/api-keys/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "user_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "name": "example", "expires_at": "2026-04-15T12:00:00Z", "scope": "full" }'

Create an API key for a user (admin only).

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

OAuth2PasswordBearer

Request Body^required

application/json

AdminApiKeyCreateRequest

object

user_id

required

User Id

ID of the user the new API key will belong to.

string format: uuid

name

required

Name

Human-readable label for the API key (e.g. ‘CI pipeline’, ‘QGIS desktop’).

string

>= 1 characters <= 255 characters

expires_at

Any of:

string
null

string format: date-time

scope

Scope

Privilege scope. ‘full’ impersonates the owner completely. ‘read_only’ authenticates GET, HEAD and OPTIONS requests only; any other method is refused with 403. A service-account key minted for an application is the usual case for ‘read_only’.

string

default: full

Allowed values: full read_only

Responses

201

Successful Response

application/json

ApiKeyCreateResponse

object

required

string format: uuid

key

required

Key

The API key secret (shown only once)

string

fingerprint

required

Fingerprint

Non-secret key identifier (prefix and last four characters)

string

name

required

Name

string

expires_at

Any of:

string
null

string format: date-time

scope

required

Scope

Privilege scope: ‘full’, ‘read_only’, ‘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)

string

dataset_id

Any of:

string
null

string format: uuid

created_at

required

Created At

string format: date-time

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"
}

400

Bad request — invalid query parameters or payload

application/problem+json

ProblemDetail

object

type

Type

string

default: about:blank

title

required

Title

string

status

required

Status

integer

detail

required

Any of:

string

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

401

Unauthorized — missing or invalid credentials

application/problem+json

ProblemDetail

object

type

Type

string

default: about:blank

title

required

Title

string

status

required

Status

integer

detail

required

Any of:

string

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

403

Forbidden — caller lacks access to this resource

application/problem+json

ProblemDetail

object

type

Type

string

default: about:blank

title

required

Title

string

status

required

Status

integer

detail

required

Any of:

string

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

404

Not found

application/problem+json

ProblemDetail

object

type

Type

string

default: about:blank

title

required

Title

string

status

required

Status

integer

detail

required

Any of:

string

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

409

Conflict — resource state prevents the operation

application/problem+json

ProblemDetail

object

type

Type

string

default: about:blank

title

required

Title

string

status

required

Status

integer

detail

required

Any of:

string

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

422

Validation error

application/problem+json

ProblemDetail

object

type

Type

string

default: about:blank

title

required

Title

string

status

required

Status

integer

detail

required

Any of:

string

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

429

Too many requests — retry after the advertised interval

application/problem+json

ProblemDetail

object

type

Type

string

default: about:blank

title

required

Title

string

status

required

Status

integer

detail

required

Any of:

string

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

Headers

Retry-After

integer

Seconds until the request may be retried

500

Internal server error

application/problem+json

ProblemDetail

object

type

Type

string

default: about:blank

title

required

Title

string

status

required

Status

integer

detail

required

Any of:

string

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

503

Service unavailable — the database could not serve the request

application/problem+json

ProblemDetail

object

type

Type

string

default: about:blank

title

required

Title

string

status

required

Status

integer

detail

required

Any of:

string

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

Privacy Apache 2.0 getgeolens.com

Create Api Key

Authorizations

Request Bodyrequired

Responses

201

Example generated

400

Example

401

Example

403

Example

404

Example

409

Example

422

Example

429

Example

Headers

500

Example

503

Example

Request Body^required

Example ^generated