Admin overview of ALL keys in the installation (admin only; session only).

GET

/admin/api-keys

const url = 'https://example.com/api/v1/admin/api-keys';
const options = {method: 'GET', headers: {cookie: 'dnse_session=<dnse_session>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/admin/api-keys \
  --cookie dnse_session=<dnse_session>

Authorizations

session

Responses

200

Every key with resolved project names.

application/json

Array<object>

object

string format: uuid

name

string

kind

string

Allowed values: project admin

projectId

string format: uuid

projectName

Resolved in the admin overview.

string

role

string

Allowed values: manager editor visitor

scopes

Array<string>

Allowed values: users teams projects settings

expiresAt

string format: date-time

lastUsedAt

string format: date-time

secret

Present only in the create response — shown exactly once.

string

Example

[
  {
    "kind": "project",
    "role": "manager",
    "scopes": [
      "users"
    ]
  }
]

403

Insufficient role.