Admin Settings

Generated admin settings operations.

GET/v1/admin/settings/configurationRead settings values, defaults and configuration sourcesadmin

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

Responses

200Successapplication/json

Example

{
  "data": {
    "fields": [
      {
        "applicationMode": "string",
        "configOnly": true,
        "current": null,
        "default": null,
        "effective": null,
        "id": "id_8h2k4q",
        "key": "string",
        "source": "string"
      }
    ],
    "path": "string",
    "registryRevision": "r12",
    "revision": 0
  },
  "scope": {
    "serverId": "id_8h2k4q",
    "viewerFence": "string"
  }
}

Schema

dataobjectrequired
- fieldsarray of objectrequired
  - applicationModestringrequired
  - configOnlybooleanrequired
  - currentany | nullrequired
  - defaultany | nullrequired
  - effectiveany | nullrequired
  - idstringrequired
  - keystringrequired
  - sourcestringrequired
- pathstringrequired
- registryRevisionstringrequired
- revisionintegerrequired
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/admin/settings/configuration" \
  -H "Authorization: Bearer $PORTICO_API_KEY"