PorticoDocs

Admin Logs

Generated admin logs operations.

GET/v1/admin/logsRead server logsadmin
Audience
Clients · Native API
Authorization
API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID
get_admin_logs

Parameters

NameInTypeDescription
categoryquerystring
cursorquerystring
levelquerystring
limitqueryinteger | ""≤ 500

Responses

200Successapplication/json

Example
{
  "effectiveLevel": "string",
  "items": [
    {
      "at": "2026-10-18T19:30:00Z",
      "category": "string",
      "level": "string",
      "message": "string",
      "sequence": "string"
    }
  ],
  "level": "string",
  "limit": 0,
  "nextCursor": "eyJvIjoyMH0"
}
Schema
  • effectiveLevelstringrequired
  • itemsarray of objectrequired
    • atstringrequired
    • categorystringrequired
    • levelstringrequired
    • messagestringrequired
    • sequencestringrequired
  • levelstringrequired
  • limitintegerrequired
  • nextCursorstring

defaultRequest refused or unavailableapplication/json

Example
{
  "error": {
    "code": "string",
    "message": "string"
  }
}
Schema
  • errorobjectrequired
    • codestringrequired
    • messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/admin/logs" \
  -H "Authorization: Bearer $PORTICO_API_KEY"
POST/v1/admin/logs/debug-windowRun server logs debug windowadmin
Audience
Clients · Native API
Authorization
API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID
post_admin_logs_debug_window
Max body
64 KiB

Request body application/json · required

Example
{
  "minutes": 0,
  "operationId": "id_8h2k4q"
}
Schema
  • minutesintegerrequired
  • operationIdstringrequired

Responses

200Successapplication/json

Example
{
  "categories": [
    "string"
  ],
  "debugWindowUntil": "string",
  "effectiveLevel": "string",
  "levels": [
    "string"
  ],
  "logDetailMinutes": 15,
  "logLevel": "string",
  "retention": [
    {
      "category": "string",
      "days": 0
    }
  ],
  "revision": 0
}
Schema
  • categoriesarray of stringrequired
  • debugWindowUntilstring
  • effectiveLevelstringrequired
  • levelsarray of stringrequired
  • logDetailMinutesintegerone of 15, 30, 60, 120, 240
  • logLevelstringrequired
  • retentionarray of objectrequired
    • categorystringrequired
    • daysintegerrequired
  • revisionintegerrequired

defaultRequest refused or unavailableapplication/json

Example
{
  "error": {
    "code": "string",
    "message": "string"
  }
}
Schema
  • errorobjectrequired
    • codestringrequired
    • messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/admin/logs/debug-window" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"minutes":0,"operationId":"id_8h2k4q"}'
GET/v1/admin/logs/eventsRead server logs eventsadmin
Audience
Clients · Native API
Authorization
API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID
get_admin_logs_events

Parameters

NameInTypeDescription
levelquerystring

Responses

200Successtext/event-stream

Example
"string"
Schema

string (binary)

defaultRequest refused or unavailableapplication/json

Example
{
  "error": {
    "code": "string",
    "message": "string"
  }
}
Schema
  • errorobjectrequired
    • codestringrequired
    • messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/admin/logs/events" \
  -H "Authorization: Bearer $PORTICO_API_KEY"
GET/v1/admin/logs/settingsRead server logs settingsadmin
Audience
Clients · Native API
Authorization
API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID
get_admin_logs_settings

Responses

200Successapplication/json

Example
{
  "categories": [
    "string"
  ],
  "debugWindowUntil": "string",
  "effectiveLevel": "string",
  "levels": [
    "string"
  ],
  "logDetailMinutes": 15,
  "logLevel": "string",
  "retention": [
    {
      "category": "string",
      "days": 0
    }
  ],
  "revision": 0
}
Schema
  • categoriesarray of stringrequired
  • debugWindowUntilstring
  • effectiveLevelstringrequired
  • levelsarray of stringrequired
  • logDetailMinutesintegerone of 15, 30, 60, 120, 240
  • logLevelstringrequired
  • retentionarray of objectrequired
    • categorystringrequired
    • daysintegerrequired
  • revisionintegerrequired

defaultRequest refused or unavailableapplication/json

Example
{
  "error": {
    "code": "string",
    "message": "string"
  }
}
Schema
  • errorobjectrequired
    • codestringrequired
    • messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/admin/logs/settings" \
  -H "Authorization: Bearer $PORTICO_API_KEY"
PATCH/v1/admin/logs/settingsChange server logs settingsadmin
Audience
Clients · Native API
Authorization
API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID
patch_admin_logs_settings
Max body
64 KiB

Parameters

NameInTypeDescription
Idempotency-Keyheaderstring
Portico-Mutation-Rootheaderstring

Request body application/json · required

Example
{
  "expectedRevision": 0,
  "logDetailMinutes": 15,
  "logLevel": "string",
  "operationId": "id_8h2k4q",
  "retention": [
    {
      "category": "string",
      "days": 0
    }
  ]
}
Schema
  • expectedRevisionintegerrequired
  • logDetailMinutesintegerone of 15, 30, 60, 120, 240
  • logLevelstringrequired
  • operationIdstringrequired
  • retentionarray of objectrequired
    • categorystringrequired
    • daysintegerrequired

Responses

200Successapplication/json

Example
{
  "categories": [
    "string"
  ],
  "debugWindowUntil": "string",
  "effectiveLevel": "string",
  "levels": [
    "string"
  ],
  "logDetailMinutes": 15,
  "logLevel": "string",
  "retention": [
    {
      "category": "string",
      "days": 0
    }
  ],
  "revision": 0
}
Schema
  • categoriesarray of stringrequired
  • debugWindowUntilstring
  • effectiveLevelstringrequired
  • levelsarray of stringrequired
  • logDetailMinutesintegerone of 15, 30, 60, 120, 240
  • logLevelstringrequired
  • retentionarray of objectrequired
    • categorystringrequired
    • daysintegerrequired
  • revisionintegerrequired

defaultRequest refused or unavailableapplication/json

Example
{
  "error": {
    "code": "string",
    "message": "string"
  }
}
Schema
  • errorobjectrequired
    • codestringrequired
    • messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternalidempotency_conflictreceipt_expiredinvalid_mutation_keydatabase_busywriter_capacity

Example request

curl -X PATCH "http://127.0.0.1:32500/v1/admin/logs/settings" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"expectedRevision":0,"logDetailMinutes":15,"logLevel":"string","operationId":"id_8h2k4q","retention":[{"category":"string","days":0}]}'