Console

Generated console operations.

GET/v1/console/registryRead the owner setting definitionsadmin

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

Responses

200Successapplication/json

Example

{
  "data": {
    "channelLogoUpload": {
      "base64Multipart": true
    },
    "exportOptions": {
      "includePaths": true
    },
    "externalScopes": {
      "key": "string"
    },
    "fields": [
      {
        "applicationMode": "string",
        "auditClass": "string",
        "default": null,
        "description": "string",
        "group": "string",
        "id": "id_8h2k4q",
        "max": 0,
        "min": 0,
        "options": [
          "string"
        ],
        "overrideScopes": [
          "string"
        ],
        "permission": "string",
        "retentionClass": "string",
        "runtimeConsumer": "2026-10-18T19:30:00Z",
        "saveMode": "string",
        "scope": "string",
        "secret": true,
        "type": "string"
      }
    ],
    "revision": "r12"
  },
  "scope": {
    "serverId": "id_8h2k4q",
    "viewerFence": "string"
  }
}

Schema

dataobjectrequired
- channelLogoUploadobject
  - base64Multipartbooleanrequired
- exportOptionsobject
  - includePathsbooleanrequired
- externalScopesobjectrequired
- fieldsarray of objectrequired
  - applicationModestringrequired
  - auditClassstringrequired
  - defaultany | nullrequired
  - descriptionstringrequired
  - groupstringrequired
  - idstringrequired
  - maxinteger
  - mininteger
  - optionsarray of string
  - overrideScopesarray of stringrequired
  - permissionstringrequired
  - retentionClassstringrequired
  - runtimeConsumerstringrequired
  - saveModestringrequired
  - scopestringrequired
  - secretbooleanrequired
  - typestringrequired
- revisionstringrequired
scopeobjectrequired
- serverIdstringrequired
- viewerFencestringrequired

defaultRequest refused or unavailableapplication/json

Example

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

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittedinvalid_requestrevision_mismatchidempotency_key_reusedrate_limitedinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/console/registry" \
  -H "Authorization: Bearer $PORTICO_API_KEY"