Overview

Update API Document version

PATCH/v1/apis/{namespace}/{slug}/version/{semver}
Features

Update the registry file content for an API document version.

Input5
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
documentstring · bodyrequired
lastKnownVersionShastring · body
Output3
jsonShastring
yamlShastring
versionShastring
Responses
200Default Response
400Bad request
401No auth
403Forbidden
404Not found
422Invalid payload
500Uncaught error
Example input
curl -X PATCH 'https://access.scalar.com/v1/apis/{namespace}/{slug}/version/{semver}' \
  -H 'Authorization: Bearer YOUR_SCALAR_ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"document":"<document>"}'
Example output
{
  "jsonSha": "<jsonSha>",
  "yamlSha": "<yamlSha>",
  "versionSha": "<versionSha>"
}

Updated

Was this page helpful?