Get API key details

GET

/api/v1/api-keys/{keyId}

const url = 'https://localhost:8080/api/v1/api-keys/example';
const options = {method: 'GET', headers: {Authorization: '<Authorization>'}};

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://localhost:8080/api/v1/api-keys/example \
  --header 'Authorization: <Authorization>'

Get details of one of the authenticated user’s API keys. JWT/session only — API keys cannot manage API keys

Authorizations

BearerAuth

Parameters

Path Parameters

keyId

required

string

API Key ID

Responses

200

API key details

application/json

An API key for service-to-service authentication; the secret itself is never returned here

object

allowedIps

Array<string>

createdAt

string format: date-time

createdBy

string

description

string

expiresAt

string format: date-time

string

keyId

string

lastUsedAt

string format: date-time

name

string

organizationId

integer

projectId

integer

revocationReason

Set via the revoke endpoint

string

revokedAt

string format: date-time

revokedBy

string

scopes

Array<string>

status

string

Allowed values: active expired revoked

usageCount

integer

userId

Resolved from the caller

string

Example

{
  "status": "active"
}

400

Bad request - Key ID required

application/json

Error body returned across the auth endpoints; the message is human-readable and not a stable identifier

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

401

Unauthorized - Authentication required

application/json

Error body returned across the auth endpoints; the message is human-readable and not a stable identifier

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

403

Forbidden - API keys cannot manage API keys, or can only view own API keys

application/json

Error body returned across the auth endpoints; the message is human-readable and not a stable identifier

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

404

API key not found

application/json

Error body returned across the auth endpoints; the message is human-readable and not a stable identifier

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

500

Internal server error

application/json

Error body returned across the auth endpoints; the message is human-readable and not a stable identifier

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}