Overview

Get API Document version metadata

GET/v1/apis/{namespace}/{slug}/version/{semver}/metadata
Features

Get metadata (uid, content shas, version sha, tags) for a specific API document version.

Input3
Authorizationheaderrequired
Your API key, sent as Authorization: Bearer YOUR_SCALAR_ACCESS_TOKEN.Sent from your browser straight to the API — never to Docsbook, never stored.
namespacestring · pathrequired
slugstring · pathrequired
semverstring · pathrequired
Output10
uidstring
createdAtnumber
versionstring
upgradedboolean
embedStatusstring
tagsstring[]
toolsobject[]
yamlShastring
jsonShastring
versionShastring
Responses
200Default Response
400Bad request
401No auth
403Forbidden
404Not found
422Invalid payload
500Uncaught error
Example input
curl 'https://access.scalar.com/v1/apis/{namespace}/{slug}/version/{semver}/metadata' \
  -H 'Authorization: Bearer YOUR_SCALAR_ACCESS_TOKEN'
Example output
{
  "uid": "<uid>",
  "createdAt": 0,
  "version": "<version>",
  "upgraded": true,
  "embedStatus": "<embedStatus>",
  "tags": [],
  "tools": [],
  "yamlSha": "<yamlSha>",
  "jsonSha": "<jsonSha>",
  "versionSha": "<versionSha>"
}

Updated

Was this page helpful?