Skip to content

GET /api/v1/admin/settings

Operation: adminListSettings.

List settings (Admin); the D-20 registry grouped by category, plus every root-of-trust key rendered read-only; a secret value is always {set, updated_at}, never the value

GET https://amplerun-api.spiry.org/api/v1/admin/settings

Admin interactive session. API keys do not authorize administrative operations. Sensitive writes also require the stated fresh step-up proof; account MFA is configurable.

Settings grouped by category.

application/json

FieldTypePresenceDescription
categoriesarray of objectRequired
{
"type": "object",
"required": [
"categories"
],
"properties": {
"categories": {
"type": "array",
"items": {
"type": "object",
"required": [
"category",
"settings"
],
"properties": {
"category": {
"type": "string",
"enum": [
"branding",
"contact",
"money",
"mail",
"alerts",
"auth-providers",
"chain-access",
"operations"
]
},
"settings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SettingView"
}
}
}
}
}
}
}

Error envelope. 401 unauthenticated, 403/404 forbidden, 409 conflict, 422 invalid input, 429 rate limited (code UNAVAILABLE, retryable:true, no Retry-After header), 503 unavailable money/provider state with retryable:true.

application/json

FieldTypePresenceDescription
errorobjectRequired
{
"$ref": "#/components/schemas/ErrorEnvelope"
}

Replace path/query placeholders and provide the required JSON body, headers and credential from the sections above. This is a request outline, not a command that chooses an amount or starts a rental for you.

Terminal window
curl --request GET 'https://amplerun-api.spiry.org/api/v1/admin/settings'

Schema definitions · Download OpenAPI · Authentication · Errors and recovery

Official AmpleRun documentation · Contract v3 · Generated from the API contract · Revision 52fe29de · Open AmpleRun · View Markdown · For agents