Admin Diagnostics

Generated admin diagnostics operations.

GET/v1/admin/diagnostics/bundleRead server diagnostics bundleadmin

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_diagnostics_bundle

Responses

200Successapplication/zip

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/diagnostics/bundle" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/v1/admin/diagnostics/capabilitiesWhy Live TV, recording, prepared media or hardware encoding is unavailable on this serveradmin

Audience: Clients · Native API
Authorization: API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID: get_capability_report

Responses

200Successapplication/json

Example

{
  "items": [
    {
      "available": true,
      "capability": "string",
      "checkedAt": "2026-10-18T19:30:00Z",
      "code": "string",
      "detail": "string"
    }
  ]
}

Schema

itemsarray of objectrequired
- availablebooleanrequired
- capabilitystringrequired
- checkedAtstringrequired
- codestring
- detailstring

defaultRequest refused or unavailableapplication/json

Example

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

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittedtimeoutdatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/admin/diagnostics/capabilities" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/v1/admin/diagnostics/client-logsList client reportsadmin

Audience: Clients · Native API
Authorization: API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID: get_client_logs

Parameters

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

Responses

200Successapplication/json

Example

{
  "items": [
    {
      "accountId": "id_8h2k4q",
      "appVersion": "string",
      "body": "string",
      "bytes": 0,
      "deviceClass": "string",
      "deviceId": "id_8h2k4q",
      "id": "id_8h2k4q",
      "platform": "string",
      "profileId": "id_8h2k4q",
      "receivedAt": "2026-10-18T19:30:00Z"
    }
  ],
  "limit": 0,
  "nextCursor": "eyJvIjoyMH0"
}

Schema

itemsarray of objectrequired
- accountIdstringrequired
- appVersionstring
- bodystring
- bytesintegerrequired
- deviceClassstringrequired
- deviceIdstringrequired
- idstringrequired
- platformstringrequired
- profileIdstringrequired
- receivedAtstringrequired
limitintegerrequired
nextCursorstring

defaultRequest refused or unavailableapplication/json

Example

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

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizedinvalid_requestinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/admin/diagnostics/client-logs" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

DELETE/v1/admin/diagnostics/client-logs/{id}Delete a client reportadmin

Audience: Clients · Native API
Authorization: API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID: delete_client_log

Parameters

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

Responses

200Successapplication/json

Example

{}

Schema

object

defaultRequest refused or unavailableapplication/json

Example

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

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_foundinternaldatabase_busywriter_capacity

Example request

curl -X DELETE "http://127.0.0.1:32500/v1/admin/diagnostics/client-logs/{id}" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/v1/admin/diagnostics/client-logs/{id}Read a client reportadmin

Audience: Clients · Native API
Authorization: API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID: get_client_log

Parameters

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

Responses

200Successapplication/json

Example

{
  "accountId": "id_8h2k4q",
  "appVersion": "string",
  "body": "string",
  "bytes": 0,
  "deviceClass": "string",
  "deviceId": "id_8h2k4q",
  "id": "id_8h2k4q",
  "platform": "string",
  "profileId": "id_8h2k4q",
  "receivedAt": "2026-10-18T19:30:00Z"
}

Schema

accountIdstringrequired
appVersionstring
bodystring
bytesintegerrequired
deviceClassstringrequired
deviceIdstringrequired
idstringrequired
platformstringrequired
profileIdstringrequired
receivedAtstringrequired

defaultRequest refused or unavailableapplication/json

Example

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

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_foundinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/admin/diagnostics/client-logs/{id}" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/v1/admin/diagnostics/client-logs/{id}/downloadDownload a client reportadmin

Audience: Clients · Native API
Authorization: API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID: download_client_log

Parameters

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

Responses

200Successapplication/json

Example

{
  "accountId": "id_8h2k4q",
  "appVersion": "string",
  "body": "string",
  "bytes": 0,
  "deviceClass": "string",
  "deviceId": "id_8h2k4q",
  "id": "id_8h2k4q",
  "platform": "string",
  "profileId": "id_8h2k4q",
  "receivedAt": "2026-10-18T19:30:00Z"
}

Schema

accountIdstringrequired
appVersionstring
bodystring
bytesintegerrequired
deviceClassstringrequired
deviceIdstringrequired
idstringrequired
platformstringrequired
profileIdstringrequired
receivedAtstringrequired

defaultRequest refused or unavailableapplication/json

Example

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

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_foundinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/admin/diagnostics/client-logs/{id}/download" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/v1/admin/diagnostics/concurrencyRead server diagnostics concurrencyadmin

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_diagnostics_concurrency

Responses

200Successapplication/json

Example

{
  "authorizationCaches": {
    "authorityGeneration": 0,
    "libraryGrantCapacity": 0,
    "libraryGrants": 0,
    "principals": {
      "capacity": 0,
      "entries": 0,
      "hits": 0,
      "misses": 0,
      "ttlMillis": 0
    }
  },
  "conversions": {
    "active": 0,
    "capacity": 0,
    "refused": 0
  },
  "health": {
    "backgroundPaused": true,
    "consecutiveFailures": 0,
    "consecutiveSuccesses": 0,
    "handleRecycles": 0,
    "lastCheckedUnix": 0,
    "lastError": "string",
    "lastProbeMillis": 0,
    "state": "string"
  },
  "httpLanes": [
    {
      "active": 0,
      "admitted": 0,
      "capacity": 0,
      "clientQueueFullRefusals": 0,
      "countsAsForegroundLoad": true,
      "lane": "string",
      "noQueueRefusals": 0,
      "perClientQueueCapacity": 0,
      "perClientShare": 0,
      "perClientThrottled": 0,
      "queueCancellationRefusals": 0,
      "queueCapacity": 0,
      "queueFullRefusals": 0,
      "queueLimitMillis": 0,
      "queueTimeoutRefusals": 0,
      "queueWaitMillis": 0,
      "queued": 0,
      "rejected": 0,
      "releaseImbalance": 0,
      "requestBudgetMillis": 0,
      "waiting": 0,
      "workClass": "string"
    }
  ],
  "integrity": {
    "checkedUnix": 0,
    "durationMillis": 0,
    "error": "string",
    "foreignKeyViolations": 0,
    "foreignKeyViolationsByTable": {
      "key": 0
    },
    "foreignSchemaObjects": 0,
    "quickCheck": "string"
  },
  "jobLanes": [
    {
      "active": 0,
      "backlog": 0,
      "capacity": 0,
      "lane": "string"
    }
  ],
  "pool": {
    "idle": 0,
    "inUse": 0,
    "maxIdleClosed": 0,
    "maxLifetimeClosed": 0,
    "maxOpenConnections": 0,
    "openConnections": 0,
    "waitCount": 0,
    "waitMillis": 0
  },
  "pressure": {
    "foregroundActive": true,
    "healthy": true,
    "valveBlocks": 0,
    "yieldWaitMillis": 0,
    "yields": 0
  },
  "process": {
    "capacityPolicy": "string",
    "containedPanics": 0,
    "databaseCalls": 0,
    "gcCycles": 0,
    "goroutines": 0,
    "heapAllocBytes": 0,
    "heapInUseBytes": 0,
    "heapSysBytes": 0,
    "maxProcs": 0,
    "memoryLimitBytes": 0,
    "memoryLimitBytesExact": "string",
    "nextGCBytes": 0,
    "openFileHardLimit": 0,
    "openFileSoftLimit": 0,
    "processCpu": {
      "reason": "string",
      "state": "string",
      "unit": "string",
      "value": null
    },
    "supervisedLoopRestarts": 0
  },
  "publications": 0,
  "readSnapshots": {
    "capacity": 0,
    "held": 0,
    "waitMillis": 0,
    "waiting": 0
  },
  "reads": {
    "acquisitions": 0,
    "byClass": [
      {
        "class": "string",
        "maxMillis": 0,
        "statements": 0,
        "totalMillis": 0
      }
    ],
    "heavyReads": 0,
    "slowReads": 0,
    "statementCache": {
      "bypasses": 0,
      "evictions": 0,
      "hits": 0,
      "misses": 0
    },
    "statements": 0,
    "transactions": 0
  },
  "routeCosts": [
    {
      "acquisitions": 0,
      "lane": "string",
      "maxAcquisitions": 0,
      "maxReadMillis": 0,
      "maxStatements": 0,
      "maxTransactions": 0,
      "requests": 0,
      "route": "string",
      "statements": 0,
      "transactions": 0
    }
  ],
  "search": {
    "active": 0,
    "globalLimit": 0,
    "perViewerLimit": 0,
    "rejected": 0
  },
  "storageHelpers": {
    "admitted": 0,
    "backgroundActive": 0,
    "backgroundCapacity": 0,
    "helperActive": 0,
    "helperCapacity": 0,
    "playbackActive": 0,
    "playbackCapacity": 0,
    "queueWaitMillis": 0,
    "queued": 0,
    "refused": 0,
    "scanProbeActive": 0,
    "scanProbeCapacity": 0
  },
  "ungatedWrites": {
    "reader": 0,
    "writer": 0
  },
  "wal": {
    "backlogFrames": 0,
    "busy": 0,
    "checkpointedFrames": 0,
    "checkpoints": {
      "attempts": 0,
      "busy": 0,
      "errors": 0,
      "last": {
        "backoffMs": 1800000,
        "beforeCheckpointedFrames": 0,
        "beforeFileBytes": 0,
        "beforeLogFrames": 0,
        "busy": 0,
        "checkpointedFrames": 0,
        "drainMs": 1800000,
        "durationMs": 1800000,
        "logFrames": 0,
        "mode": "string",
        "outcome": "string",
        "readers": {
          "admissionPaused": true,
          "admissionRefused": 0,
          "admissionWaitMs": 1800000,
          "admissionWaiting": 0,
          "admissionWaits": 0,
          "implicitRows": 0,
          "maxImplicitRowsMs": 1800000,
          "maxSnapshotMs": 1800000,
          "oldestImplicitRowsClass": "string",
          "oldestImplicitRowsMs": 1800000,
          "oldestSnapshotClass": "string",
          "oldestSnapshotMs": 1800000,
          "overLifetimeBackground": 0,
          "overLifetimeForeground": 0,
          "snapshots": 0
        }
      },
      "maxDurationMs": 1800000,
      "pressureTimeouts": 0,
      "truncates": 0
    },
    "lastError": "string",
    "logFrames": 0,
    "readers": {
      "admissionPaused": true,
      "admissionRefused": 0,
      "admissionWaitMs": 1800000,
      "admissionWaiting": 0,
      "admissionWaits": 0,
      "implicitRows": 0,
      "maxImplicitRowsMs": 1800000,
      "maxSnapshotMs": 1800000,
      "oldestImplicitRowsClass": "string",
      "oldestImplicitRowsMs": 1800000,
      "oldestSnapshotClass": "string",
      "oldestSnapshotMs": 1800000,
      "overLifetimeBackground": 0,
      "overLifetimeForeground": 0,
      "snapshots": 0
    },
    "walFileBytes": 0,
    "walPeakFileBytes": 0
  },
  "writeGate": {
    "acquired": 0,
    "active": true,
    "byClass": {
      "key": {
        "acquired": 0,
        "active": true,
        "cancelled": 0,
        "currentHeldMillis": 0,
        "heldMillis": 0,
        "maxHeldMillis": 0,
        "queueWaitMillis": 0,
        "queued": 0
      }
    },
    "cancelled": 0,
    "heldMillis": 0,
    "maxHeldMillis": 0,
    "maxQueueAgeMillis": {
      "key": 0
    },
    "queueAgeMillis": {
      "key": 0
    },
    "queueWaitMillis": 0,
    "queued": 0,
    "waiting": {
      "key": 0
    }
  },
  "writePlans": {
    "largest": {
      "pages": 0,
      "rows": 0,
      "vmOps": 0
    },
    "measured": 0,
    "musicBrainzWal": {
      "flip": {
        "maxCachePages": 0,
        "maxFrames": 0,
        "maxWalBytes": 0,
        "peakCachePages": 0,
        "peakFrames": 0,
        "peakWalBytes": 0,
        "samples": 0,
        "unknownCachePages": 0,
        "unknownFrames": 0,
        "unknownWal": 0,
        "windowSamples": 0
      },
      "fold": {
        "maxCachePages": 0,
        "maxFrames": 0,
        "maxWalBytes": 0,
        "peakCachePages": 0,
        "peakFrames": 0,
        "peakWalBytes": 0,
        "samples": 0,
        "unknownCachePages": 0,
        "unknownFrames": 0,
        "unknownWal": 0,
        "windowSamples": 0
      },
      "window": 0
    },
    "overruns": 0,
    "overrunsByClass": {
      "key": 0
    },
    "overrunsByDimension": {
      "key": 0
    },
    "recent": [
      {
        "atMs": 1800000,
        "budget": {
          "pages": 0,
          "rows": 0,
          "vmOps": 0
        },
        "class": "string",
        "cost": {
          "pages": 0,
          "rows": 0,
          "vmOps": 0
        },
        "over": [
          "string"
        ],
        "plan": "string",
        "site": "string"
      }
    ]
  },
  "writerAdmission": {
    "backgroundQueued": 0,
    "busyAfterAdmission": 0,
    "busyAfterAdmissionByClass": {
      "key": 0
    },
    "capacity": 0,
    "deferred": 0,
    "recoveryHold": true,
    "recoveryPause": true,
    "refused": 0,
    "refusedByClass": {
      "key": 0
    },
    "userQueued": 0
  }
}

Schema

authorizationCachesobjectrequired
- authorityGenerationintegerrequired
- libraryGrantCapacityintegerrequired
- libraryGrantsintegerrequired
- principalsobjectrequired
  - capacityintegerrequired
  - entriesintegerrequired
  - hitsintegerrequired
  - missesintegerrequired
  - ttlMillisintegerrequired
conversionsobjectrequired
- activeintegerrequired
- capacityintegerrequired
- refusedintegerrequired
healthobjectrequired
- backgroundPausedbooleanrequired
- consecutiveFailuresintegerrequired
- consecutiveSuccessesintegerrequired
- handleRecyclesintegerrequired
- lastCheckedUnixintegerrequired
- lastErrorstring
- lastProbeMillisintegerrequired
- statestringrequired
httpLanesarray of objectrequired
- activeintegerrequired
- admittedintegerrequired
- capacityintegerrequired
- clientQueueFullRefusalsintegerrequired
- countsAsForegroundLoadbooleanrequired
- lanestringrequired
- noQueueRefusalsintegerrequired
- perClientQueueCapacityintegerrequired
- perClientShareintegerrequired
- perClientThrottledintegerrequired
- queueCancellationRefusalsintegerrequired
- queueCapacityintegerrequired
- queueFullRefusalsintegerrequired
- queueLimitMillisintegerrequired
- queueTimeoutRefusalsintegerrequired
- queueWaitMillisintegerrequired
- queuedintegerrequired
- rejectedintegerrequired
- releaseImbalanceintegerrequired
- requestBudgetMillisintegerrequired
- waitingintegerrequired
- workClassstringrequired
integrityobjectrequired
- checkedUnixintegerrequired
- durationMillisintegerrequired
- errorstring
- foreignKeyViolationsintegerrequired
- foreignKeyViolationsByTableobject
- foreignSchemaObjectsintegerrequired
- quickCheckstring
jobLanesarray of objectrequired
- activeintegerrequired
- backlogintegerrequired
- capacityintegerrequired
- lanestringrequired
poolobjectrequired
- idleintegerrequired
- inUseintegerrequired
- maxIdleClosedintegerrequired
- maxLifetimeClosedintegerrequired
- maxOpenConnectionsintegerrequired
- openConnectionsintegerrequired
- waitCountintegerrequired
- waitMillisintegerrequired
pressureobjectrequired
- foregroundActivebooleanrequired
- healthybooleanrequired
- valveBlocksintegerrequired
- yieldWaitMillisintegerrequired
- yieldsintegerrequired
processobjectrequired
- capacityPolicystringrequired
- containedPanicsintegerrequired
- databaseCallsintegerrequired
- gcCyclesintegerrequired
- goroutinesintegerrequired
- heapAllocBytesintegerrequired
- heapInUseBytesintegerrequired
- heapSysBytesintegerrequired
- maxProcsintegerrequired
- memoryLimitBytesinteger | any | nullrequired
- memoryLimitBytesExactstringpattern ^[1-9][0-9]*$
- nextGCBytesintegerrequired
- openFileHardLimitintegerrequired
- openFileSoftLimitintegerrequired
- processCpuobjectrequired
  - reasonstring
  - statestringrequired
  - unitstring
  - valueanyrequired
- supervisedLoopRestartsintegerrequired
publicationsintegerrequired
readSnapshotsobjectrequired
- capacityintegerrequired
- heldintegerrequired
- waitMillisintegerrequired
- waitingintegerrequired
readsobjectrequired
- acquisitionsintegerrequired
- byClassarray of objectrequired
  - classstringrequired
  - maxMillisintegerrequired
  - statementsintegerrequired
  - totalMillisintegerrequired
- heavyReadsintegerrequired
- slowReadsintegerrequired
- statementCacheobjectrequired
  - bypassesintegerrequired
  - evictionsintegerrequired
  - hitsintegerrequired
  - missesintegerrequired
- statementsintegerrequired
- transactionsintegerrequired
routeCostsarray of objectrequired
- acquisitionsintegerrequired
- lanestringrequired
- maxAcquisitionsintegerrequired
- maxReadMillisintegerrequired
- maxStatementsintegerrequired
- maxTransactionsintegerrequired
- requestsintegerrequired
- routestringrequired
- statementsintegerrequired
- transactionsintegerrequired
searchobjectrequired
- activeintegerrequired
- globalLimitintegerrequired
- perViewerLimitintegerrequired
- rejectedintegerrequired
storageHelpersobjectrequired
- admittedintegerrequired
- backgroundActiveintegerrequired
- backgroundCapacityintegerrequired
- helperActiveintegerrequired
- helperCapacityintegerrequired
- playbackActiveintegerrequired
- playbackCapacityintegerrequired
- queueWaitMillisintegerrequired
- queuedintegerrequired
- refusedintegerrequired
- scanProbeActiveintegerrequired
- scanProbeCapacityintegerrequired
ungatedWritesobjectrequired
- readerintegerrequired
- writerintegerrequired
walobjectrequired
- backlogFramesintegerrequired
- busyintegerrequired
- checkpointedFramesintegerrequired
- checkpointsobjectrequired
  - attemptsintegerrequired
  - busyintegerrequired
  - errorsintegerrequired
  - lastobjectrequired
    backoffMsintegerrequired
    beforeCheckpointedFramesintegerrequired
    beforeFileBytesintegerrequired
    beforeLogFramesintegerrequired
    busyintegerrequired
    checkpointedFramesintegerrequired
    drainMsintegerrequired
    durationMsintegerrequired
    logFramesintegerrequired
    modestringrequired
    outcomestringrequired
    readersobjectrequired
    admissionPausedbooleanrequired
    admissionRefusedintegerrequired
    admissionWaitMsintegerrequired
    admissionWaitingintegerrequired
    admissionWaitsintegerrequired
    implicitRowsintegerrequired
    maxImplicitRowsMsintegerrequired
    maxSnapshotMsintegerrequired
    oldestImplicitRowsClassstring
    oldestImplicitRowsMsintegerrequired
    oldestSnapshotClassstring
    oldestSnapshotMsintegerrequired
    overLifetimeBackgroundintegerrequired
    overLifetimeForegroundintegerrequired
    snapshotsintegerrequired
  - maxDurationMsintegerrequired
  - pressureTimeoutsintegerrequired
  - truncatesintegerrequired
- lastErrorstring
- logFramesintegerrequired
- readersobjectrequired
  - admissionPausedbooleanrequired
  - admissionRefusedintegerrequired
  - admissionWaitMsintegerrequired
  - admissionWaitingintegerrequired
  - admissionWaitsintegerrequired
  - implicitRowsintegerrequired
  - maxImplicitRowsMsintegerrequired
  - maxSnapshotMsintegerrequired
  - oldestImplicitRowsClassstring
  - oldestImplicitRowsMsintegerrequired
  - oldestSnapshotClassstring
  - oldestSnapshotMsintegerrequired
  - overLifetimeBackgroundintegerrequired
  - overLifetimeForegroundintegerrequired
  - snapshotsintegerrequired
- walFileBytesintegerrequired
- walPeakFileBytesintegerrequired
writeGateobjectrequired
- acquiredintegerrequired
- activebooleanrequired
- byClassobjectrequired
  - acquiredintegerrequired
  - activebooleanrequired
  - cancelledintegerrequired
  - currentHeldMillisintegerrequired
  - heldMillisintegerrequired
  - maxHeldMillisintegerrequired
  - queueWaitMillisintegerrequired
  - queuedintegerrequired
- cancelledintegerrequired
- heldMillisintegerrequired
- maxHeldMillisintegerrequired
- maxQueueAgeMillisobjectrequired
- queueAgeMillisobjectrequired
- queueWaitMillisintegerrequired
- queuedintegerrequired
- waitingobjectrequired
writePlansobjectrequired
- largestobjectrequired
  - pagesintegerrequired
  - rowsintegerrequired
  - vmOpsintegerrequired
- measuredintegerrequired
- musicBrainzWalobject
  - flipobjectrequired
    maxCachePagesintegerrequired
    maxFramesintegerrequired
    maxWalBytesintegerrequired
    peakCachePagesintegerrequired
    peakFramesintegerrequired
    peakWalBytesintegerrequired
    samplesintegerrequired
    unknownCachePagesintegerrequired
    unknownFramesintegerrequired
    unknownWalintegerrequired
    windowSamplesintegerrequired
  - foldobjectrequired
    maxCachePagesintegerrequired
    maxFramesintegerrequired
    maxWalBytesintegerrequired
    peakCachePagesintegerrequired
    peakFramesintegerrequired
    peakWalBytesintegerrequired
    samplesintegerrequired
    unknownCachePagesintegerrequired
    unknownFramesintegerrequired
    unknownWalintegerrequired
    windowSamplesintegerrequired
  - windowintegerrequired
- overrunsintegerrequired
- overrunsByClassobjectrequired
- overrunsByDimensionobjectrequired
- recentarray of objectrequired
  - atMsintegerrequired
  - budgetobjectrequired
    pagesintegerrequired
    rowsintegerrequired
    vmOpsintegerrequired
  - classstringrequired
  - costobjectrequired
    pagesintegerrequired
    rowsintegerrequired
    vmOpsintegerrequired
  - overarray of stringrequired
  - planstringrequired
  - sitestringrequired
writerAdmissionobjectrequired
- backgroundQueuedintegerrequired
- busyAfterAdmissionintegerrequired
- busyAfterAdmissionByClassobjectrequired
- capacityintegerrequired
- deferredintegerrequired
- recoveryHoldbooleanrequired
- recoveryPausebooleanrequired
- refusedintegerrequired
- refusedByClassobjectrequired
- userQueuedintegerrequired

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/diagnostics/concurrency" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

POST/v1/admin/diagnostics/integrityRun server diagnostics integrityadmin

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_diagnostics_integrity

Responses

200Successapplication/json

Example

{
  "checkedUnix": 0,
  "durationMillis": 0,
  "error": "string",
  "foreignKeyViolations": 0,
  "foreignKeyViolationsByTable": {
    "key": 0
  },
  "foreignSchemaObjects": 0,
  "quickCheck": "string"
}

Schema

checkedUnixintegerrequired
durationMillisintegerrequired
errorstring
foreignKeyViolationsintegerrequired
foreignKeyViolationsByTableobject
foreignSchemaObjectsintegerrequired
quickCheckstring

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/diagnostics/integrity" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

POST/v1/admin/diagnostics/integrity/repairRun server diagnostics integrity repairadmin

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_diagnostics_integrity_repair

Responses

200Successapplication/json

Example

{
  "incomplete": true,
  "repair": {
    "durationMillis": 0,
    "removedByTable": {
      "key": 0
    },
    "reportedByTable": {
      "key": 0
    }
  }
}

Schema

incompletebooleanrequired
repairobjectrequired
- durationMillisintegerrequired
- removedByTableobjectrequired
- reportedByTableobjectrequired

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/diagnostics/integrity/repair" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/v1/admin/diagnostics/pprof/{profile}Read server diagnostics pprofadmin

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_diagnostics_pprof_profile

Parameters

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

Responses

200Successapplication/octet-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/diagnostics/pprof/{profile}" \
  -H "Authorization: Bearer $PORTICO_API_KEY"