Pterodactyldocs
Admin A P I

Update general settings

Updates panel branding, 2FA requirements, and default locale settings.

PUT/api/admin/settings/general

Authorization

default
AuthorizationBearer <token>

Application API requests require an application API token, or a client API token, that belongs to a root administrator. Admin API requests require a client API token that belongs to a root administrator, and reject application API tokens. Client API requests require a client API token.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X PUT "https://example.com/api/admin/settings/general" \  -H "Content-Type: application/json" \  -d '{    "default_locale": "en"  }'
Empty

Get settings GET

Returns current general, mail, advanced, and metadata settings.

Update mail settings PUT

Updates SMTP mail settings and restarts queued workers so they reload configuration.