Skip to content

Get the site name and address

GET
/admin/system/site

Returns the site’s display name and base URL as saved.

You need system.config.read or system.admin for the whole install; a permission held only for a team doesn’t count. Without one you get 403, and signed-out callers get 401.

The values are read from the database on each call. A fresh install answers with the name Artist Alley and no base_url; base_url is left out whenever it is empty. Server errors, including saved settings that can’t be read, get a plain-text 500.

The saved site name and base URL.

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

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"
}

Authenticated but missing required capabilities

object
error
required

Human-readable error summary

string
Example
the request could not be completed