Groundeddocs
ReferenceAdmin

Turn public agents on or off (platform admins; audited). Off hides public agents and refuses public pages, embeds and the public API.

PUT/v1/admin/settings/public-access

Header Parameters

If-Match*string

The resource's revision, as returned in ETag (for example "3"). Missing returns 428; stale returns 412.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/v1/admin/settings/public-access" \  -H "If-Match: string" \  -H "Content-Type: application/json" \  -d '{    "publicAgentsEnabled": true  }'
{  "data": {    "publicAgentsEnabled": true,    "revision": 0,    "updatedAt": "2019-08-24T14:15:22Z",    "captcha": {      "provider": "none",      "siteKey": "string"    },    "anonSessionTtlSeconds": 0  }}