Sign in
Key Management API

Describe the API key used for this request

Returns the key that authenticated this call, including its permission type and access policy, so a caller can tell what it may do before attempting it. The key value itself is never returned. Requires an API key; a session-authenticated call has no key to describe.

get/rest/api/v1/apiKeys/current

Response

OK

accountIdstring uuid

You have to set it during resource creation, after that, it is only read-only

aliasstring
expiresAtstring date-time

Point in time after which this key is rejected. Null means the key never expires.

idinteger
keystring
keyType'INTEGRATION' | 'AI'

Key type: INTEGRATION or AI. At most one AI key per project; setting it on a second key clears the flag on the first. AI keys fail closed without an access policy and cannot be turned back into INTEGRATION keys.

lastUsedAtstring date-time

Last time this key was accepted on a request. Updated at most once per minute.

permissionType'READ_WRITE' | 'READ_ONLY'

Permission type: READ_WRITE or READ_ONLY

projectIdstring uuid

You have to set it during resource creation, after that, it is only read-only

revokedAtstring date-time

Point in time at which this key was revoked. Null means the key is active.

Example response

{
  "accessPolicy": {
    "enabled": true,
    "endpointPolicyMode": "ALLOW_LIST",
    "endpoints": [
      {
        "method": "GET",
        "path": "/rest/api/v1/projects/{projectId}/strategies"
      }
    ],
    "fieldPolicyMode": "DENY_LIST",
    "fields": [
      {
        "dtoClassName": "AccountInformationDTO",
        "fieldName": "balance",
        "fieldType": "java.math.BigDecimal"
      }
    ]
  }
}

Changes

Changed in 1 of the 3 revisions of this API.1