resetSettings
POST
/api/v1/settings/reset
const url = 'https://example.com/api/v1/settings/reset';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"revision":1,"category":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/v1/settings/reset \ --header 'Content-Type: application/json' \ --data '{ "revision": 1, "category": "example" }'Reset settings to defaults, optionally scoped to one category at the current revision. Requires an Owner or Administrator with the admin scope. Cookie-authenticated unsafe requests require X-CSRF-Token.
Parameters
Section titled “ Parameters ”Header Parameters
Section titled “Header Parameters”X-CSRF-Token
string
Cookie-backed browser requests only, and only on unsafe methods. Bearer grants never send it.
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
revision
integer
category
string
Examplegenerated
{ "revision": 1, "category": "example"}Responses
Section titled “ Responses ”Settings reset
Media typeapplication/json
object
data
required
Versioned organization or preference document. Definitions always ride along; callers never merge a second read to render titles.
object
schemaVersion
required
integer
revision
required
integer format: int64
values
required
object
key
additional properties
any
definitions
required
Array<object>
object
key
required
string
category
required
string
type
required
string
title
required
string
description
string
documentation
string
default
required
min
number
max
number
allowed
Array<string>
scope
required
string
sensitive
required
boolean
restartRequired
required
boolean
immediate
required
boolean
futureOnly
required
boolean
updatedAt
required
string format: date-time
Example
{ "data": { "definitions": [ { "scope": "organization" } ] }}Invalid request body
Dashboard authentication required
Insufficient role