Bootstrap

Generated bootstrap operations.

GET/v1/bootstrapRead this viewer's startup stateread

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

Parameters

Name	In	Type	Description
`deviceClass`	query	`string`

Responses

200Successapplication/json

Example

{
  "capabilities": {
    "api": {
      "level": 0,
      "major": 0
    },
    "features": {
      "key": "string"
    },
    "limits": {
      "key": 0
    }
  },
  "homeLayout": {
    "hiddenRowIds": [
      "string"
    ],
    "revision": 0,
    "rowOrder": [
      "string"
    ]
  },
  "libraries": [
    {
      "defaultView": "string",
      "id": "id_8h2k4q",
      "kind": "string",
      "name": "Fargo",
      "pinned": true,
      "summary": {
        "counts": [
          {}
        ],
        "coverUrls": [
          "https://example.com/…"
        ],
        "empty": true,
        "emptyKnown": true,
        "firstScan": true,
        "latestArtwork": "string",
        "publicationCounts": [
          {}
        ]
      }
    }
  ],
  "me": {
    "viewer": {
      "accountId": "id_8h2k4q",
      "authority": "string",
      "profileId": "id_8h2k4q",
      "role": "string",
      "serverId": "id_8h2k4q"
    }
  },
  "preferences": {
    "audioEffects": {
      "crossfadeMs": 1800000,
      "dsdGainDb": 0,
      "gapless": true,
      "neverBoost": true,
      "normalization": "string",
      "smoothTransitions": true
    },
    "clampedFields": [
      "string"
    ],
    "deviceBound": true,
    "deviceClass": "string",
    "documents": [
      {
        "activeRevision": 0,
        "digest": "string",
        "revision": 0,
        "scope": "string",
        "values": {
          "key": null
        }
      }
    ],
    "effective": {
      "key": null
    },
    "effectiveSource": {
      "key": "string"
    },
    "registry": {
      "fields": [
        {
          "allowedValues": [],
          "consumer": "string",
          "default": null,
          "group": "string",
          "key": "string",
          "labelKey": "string",
          "max": 0,
          "min": 0,
          "scopes": [],
          "step": 0,
          "type": "string"
        }
      ],
      "revision": "r12"
    },
    "registryRevision": "r12"
  },
  "server": {
    "api": {
      "level": 0,
      "major": 0
    },
    "id": "id_8h2k4q",
    "name": "Fargo",
    "setupRequired": true
  }
}

Schema

capabilitiesobjectrequired
- apiobjectrequired
  - levelintegerrequired
  - majorintegerrequired
- featuresobjectrequired
- limitsobjectrequired
homeLayoutobjectrequired
- hiddenRowIdsarray of stringrequired0–64 items
- revisionintegerrequired
- rowOrderarray of stringrequired0–64 items
librariesarray of objectrequired
- defaultViewstringrequired
- idstringrequired
- kindstringrequired
- namestringrequired
- pinnedbooleanrequired
- summaryobject
  - countsarray of objectrequired
    atLeastbooleanrequired
    countintegerrequired
    kindstringrequired
  - coverUrlsarray of stringrequired
  - emptybooleanrequired
  - emptyKnownbooleanrequired
  - firstScanbooleanrequired
  - latestArtworkstringrequired
  - publicationCountsarray of object
    atLeastbooleanrequired
    countintegerrequired
    kindstringrequired
meobjectrequired
- viewerobjectrequired
  - accountIdstringrequired
  - authoritystringrequired
  - profileIdstringrequired
  - rolestringrequired
  - serverIdstringrequired
preferencesobjectrequired
- audioEffectsobjectrequired
  - crossfadeMsintegerrequired
  - dsdGainDbintegerrequired
  - gaplessbooleanrequired
  - neverBoostbooleanrequired
  - normalizationstringrequired
  - smoothTransitionsbooleanrequired
- clampedFieldsarray of stringrequired
- deviceBoundbooleanrequired
- deviceClassstringrequired
- documentsarray of objectrequired
  - activeRevisionintegerrequired
  - digeststringrequired
  - revisionintegerrequired
  - scopestringrequired
  - valuesobjectrequired
- effectiveobjectrequired
- effectiveSourceobjectrequired
- registryobjectrequired
  - fieldsarray of objectrequired
    allowedValuesarray of any
    consumerstringrequired
    defaultanyrequired
    groupstringrequired
    keystringrequired
    labelKeystringrequired
    maxnumber
    minnumber
    scopesarray of stringrequired
    stepnumber
    typestringrequired
  - revisionstringrequired
- registryRevisionstringrequired
serverobjectrequired
- apiobjectrequired
  - levelintegerrequired
  - majorintegerrequired
- idstringrequired
- namestringrequired
- setupRequiredbooleanrequired

defaultRequest refused or unavailableapplication/json

Example

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

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittedinvalid_requestinternaldatabase_busy

Example request

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