Admin Library Settings

Generated admin library settings operations.

GET/v1/admin/library-settingsRead server library settingslibrary

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

Parameters

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

Responses

200Successapplication/json

Example

{
  "protocolVersion": "string",
  "result": {
    "items": [
      {
        "allowMediaDeletion": true,
        "analysisOperationCount": 0,
        "id": "id_8h2k4q",
        "kind": "string",
        "name": "Fargo",
        "revision": 0,
        "sourceCount": 0
      }
    ],
    "nextCursor": "eyJvIjoyMH0"
  },
  "serverId": "id_8h2k4q"
}

Schema

protocolVersionstringrequired
resultobjectrequired
- itemsarray of objectrequired
  - allowMediaDeletionbooleanrequired
  - analysisOperationCountintegerrequired
  - idstringrequired
  - kindstringrequired
  - namestringrequired
  - revisionintegerrequired
  - sourceCountintegerrequired
- nextCursorstringrequired
serverIdstringrequired

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