Skip to main content
GET
/
settings
Get Settings
curl --request GET \
  --url https://pbx-{proxyboxId}.pbxz.io/api/v1/settings \
  --header 'X-API-Key: <api-key>'
{
  "status": "<string>",
  "statusCode": 123,
  "result": {
    "module": "<string>",
    "message": "<string>",
    "content": {
      "apiKey": "<string>",
      "extensions": [
        {
          "name": "<string>",
          "enabled": true,
          "instances": [
            {
              "oidcPath": "<string>",
              "clientId": "<string>",
              "clientSecret": "<string>",
              "target": "https://pbx-jrdn.pbxz.io/api/v1/print/tcp_192-168-86-250_9100",
              "logicalPrinterId": "JRDN",
              "tag": "<string>",
              "startOnBoot": true,
              "id": 123
            }
          ]
        }
      ],
      "shares": [
        {
          "sharePath": "<string>",
          "alias": "<string>",
          "username": "<string>",
          "password": "<string>",
          "server": "<string>",
          "browsable": true,
          "uuid": "<string>"
        }
      ],
      "printers": [
        {
          "id": "<string>",
          "type": "<string>",
          "path": "<string>",
          "connection": {
            "type": "<string>",
            "host": "<string>",
            "port": 123,
            "protocol": "<string>"
          },
          "model": "<string>",
          "content": "<string>",
          "discovered": true
        }
      ],
      "subDomain": "<string>",
      "alias": "<string>"
    }
  }
}

Authorizations

X-API-Key
string
header
required

Response

Settings Response

status
string
required
Example:

"success"

statusCode
integer
required

Standard HTTP status codes.

Example:

200

result
object
required