Skip to content

POST /api/v1/admin/settings/test

Operation: adminTestSetting.

Test one subsystem’s connectivity (Admin, rate limited); mail/alerts/chain-access/auth-provider; the target always comes from the stored setting, never the request body

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

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

Required body.

FieldTypePresenceDescription
subsystem“mail” / “alerts” / “chain-access” / “auth-provider”Required
provider“github” / “google”Optional
{
"type": "object",
"required": [
"subsystem"
],
"properties": {
"subsystem": {
"type": "string",
"enum": [
"mail",
"alerts",
"chain-access",
"auth-provider"
]
},
"provider": {
"type": "string",
"enum": [
"github",
"google"
]
}
}
}

The real result of the check.

application/json

FieldTypePresenceDescription
okbooleanRequired
detailstringRequired
{
"type": "object",
"required": [
"ok",
"detail"
],
"properties": {
"ok": {
"type": "boolean"
},
"detail": {
"type": "string"
}
}
}

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 POST 'https://amplerun-api.spiry.org/api/v1/admin/settings/test'

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