Update a docs project

Update project settings. Set isPrivate with accessGroups to put the site behind a login.

Path Parameters

slug
Type: string
required

Body

required

application/json

accessGroups
Type: …50
min length:
5
activeThemeId
Type:
min length:
5
agentEnabled
Type: boolean
analyticsEnabled
Type: boolean
isPrivate
Type: boolean
loginPortalUid
Type:
min length:
5
name
Type: string

Responses

application/json
application/json
application/json
application/json
application/json
application/json
application/json

patch/v1/docs/{slug}

import Scalar from '@scalar/sdk';

const client = new Scalar({
  bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var
});

await client.scalarDocs.updateProject('acme-docs', {});

Show Schema

null

Default Response

Delete a docs project

Publish a docs project