Admin Api Keys

Generated admin api keys operations.

GET/v1/admin/api-keysList this server's API keyssession

Audience: Integrations · Native API
Authorization: Session only; API keys and personal access tokens are refused
OpenAPI operation ID: list_api_keys

Parameters

Name	In	Type	Description
`cursor`	query	`string`
`limit`	query	`integer \| ""`1–100

Responses

200Successapplication/json

Example

{
  "items": [
    {
      "createdAt": "2026-10-18T19:30:00Z",
      "endedReason": "string",
      "expiresAt": "2026-10-18T19:30:00Z",
      "hint": "string",
      "id": "id_8h2k4q",
      "kind": "string",
      "lastUsedAt": "2026-10-18T19:30:00Z",
      "member": {
        "accountId": "id_8h2k4q",
        "profile": "string",
        "profileId": "id_8h2k4q",
        "username": "Fargo"
      },
      "name": "Fargo",
      "scopes": [
        "string"
      ],
      "state": "string"
    }
  ],
  "limit": 0,
  "nextCursor": "eyJvIjoyMH0",
  "total": 0
}

Schema

itemsarray of objectrequired
- createdAtstringrequired
- endedReasonstring
- expiresAtstring
- hintstringrequired
- idstringrequired
- kindstringrequired
- lastUsedAtstring
- memberobjectrequired
  - accountIdstringrequired
  - profilestringrequired
  - profileIdstringrequired
  - usernamestringrequired
- namestringrequired
- scopesarray of stringrequired
- statestringrequired
limitintegerrequired
nextCursorstring
totalintegerrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittedsession_requiredinvalid_requestadministration_unavailableinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/admin/api-keys" \
  -H "Authorization: Bearer $PORTICO_ACCESS_TOKEN"

POST/v1/admin/api-keysCreate an API key; the owner may reveal it latersession

Audience: Integrations · Native API
Authorization: Session only; API keys and personal access tokens are refused
OpenAPI operation ID: create_api_key
Max body: 4 KiB

Request body application/json · required

Example

{
  "expiresAt": "2026-10-18T19:30:00Z",
  "name": "Fargo",
  "operationId": "id_8h2k4q",
  "scopes": [
    "string"
  ]
}

Schema

expiresAtstring
namestringrequired
operationIdstringrequired
scopesarray of stringrequired

Responses

201Successapplication/json

Example

{
  "credential": {
    "createdAt": "2026-10-18T19:30:00Z",
    "endedReason": "string",
    "expiresAt": "2026-10-18T19:30:00Z",
    "hint": "string",
    "id": "id_8h2k4q",
    "kind": "string",
    "lastUsedAt": "2026-10-18T19:30:00Z",
    "member": {
      "accountId": "id_8h2k4q",
      "profile": "string",
      "profileId": "id_8h2k4q",
      "username": "Fargo"
    },
    "name": "Fargo",
    "scopes": [
      "string"
    ],
    "state": "string"
  },
  "secret": "string"
}

Schema

credentialobjectrequired
- createdAtstringrequired
- endedReasonstring
- expiresAtstring
- hintstringrequired
- idstringrequired
- kindstringrequired
- lastUsedAtstring
- memberobjectrequired
  - accountIdstringrequired
  - profilestringrequired
  - profileIdstringrequired
  - usernamestringrequired
- namestringrequired
- scopesarray of stringrequired
- statestringrequired
secretstring

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittedsession_requiredinvalid_requestidempotency_key_reusedcredential_limitcredential_unavailableaccess_tokens_offadministration_unavailableinternaldatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/admin/api-keys" \
  -H "Authorization: Bearer $PORTICO_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"expiresAt":"2026-10-18T19:30:00Z","name":"Fargo","operationId":"id_8h2k4q","scopes":["string"]}'

DELETE/v1/admin/api-keys/{id}Revoke an API keysession

Audience: Integrations · Native API
Authorization: Session only; API keys and personal access tokens are refused
OpenAPI operation ID: revoke_api_key

Parameters

Name	In	Type	Description
`id`required	path	`string`

Responses

200Successapplication/json

Example

{
  "createdAt": "2026-10-18T19:30:00Z",
  "endedReason": "string",
  "expiresAt": "2026-10-18T19:30:00Z",
  "hint": "string",
  "id": "id_8h2k4q",
  "kind": "string",
  "lastUsedAt": "2026-10-18T19:30:00Z",
  "member": {
    "accountId": "id_8h2k4q",
    "profile": "string",
    "profileId": "id_8h2k4q",
    "username": "Fargo"
  },
  "name": "Fargo",
  "scopes": [
    "string"
  ],
  "state": "string"
}

Schema

createdAtstringrequired
endedReasonstring
expiresAtstring
hintstringrequired
idstringrequired
kindstringrequired
lastUsedAtstring
memberobjectrequired
- accountIdstringrequired
- profilestringrequired
- profileIdstringrequired
- usernamestringrequired
namestringrequired
scopesarray of stringrequired
statestringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittedsession_requiredinvalid_requestnot_foundadministration_unavailableinternaldatabase_busywriter_capacity

Example request

curl -X DELETE "http://127.0.0.1:32500/v1/admin/api-keys/{id}" \
  -H "Authorization: Bearer $PORTICO_ACCESS_TOKEN"

GET/v1/admin/api-keys/{id}/secretReveal this credential to the signed-in ownersession

Audience: Integrations · Native API
Authorization: Session only; API keys and personal access tokens are refused
OpenAPI operation ID: reveal_api_key

Parameters

Name	In	Type	Description
`id`required	path	`string`

Responses

200Successapplication/json

Example

{
  "id": "id_8h2k4q",
  "secret": "string"
}

Schema

idstringrequired
secretstringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittedinsufficient_scopesession_requiredinvalid_requestnot_foundcredential_limitinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/admin/api-keys/{id}/secret" \
  -H "Authorization: Bearer $PORTICO_ACCESS_TOKEN"