Update the site configuration

PATCH

/admin/system/site

• Local development behind nginx (port 8088 by default)

Authorizations

• cookieAuth
• bearerAuth

Request Body ^required

object

name

required

string

>= 1 characters <= 100 characters

Example

Acme Art Reviews

base_url

Absolute URL the site is reachable at. Used to build outgoing links (e.g., password-reset emails). May be empty at install time and filled in later.

string

Example

https://art.example.com

Responses

200

Updated site config

object

name

required

string

>= 1 characters <= 100 characters

Example

Acme Art Reviews

base_url

Absolute URL the site is reachable at. Used to build outgoing links (e.g., password-reset emails). May be empty at install time and filled in later.

string

Example

https://art.example.com

400

Malformed request

object

error

required

Human-readable error summary

string

Example

the request could not be completed

401

Authentication required, missing, or invalid

object

error

required

Human-readable error summary

string

Example

the request could not be completed

Example

{
  "error": "authentication required: sign in and retry with a valid session or API token"
}

403

Authenticated but missing required capabilities

object

error

required

Human-readable error summary

string

Example

the request could not be completed