Version: Current
Historical release snapshot. These docs are frozen. Read current docs.
POST /v1/providers/{provider_id}/accounts/{account_id}/state
Part of the API reference; this page is generated from the OpenAPI document that the gateway builds from its own route tables.
Provenance
Section titled “Provenance”- Contract version:
1.10.0 - Contract title: acumen gateway API
- Source:
acumen:docs/openapi/acumen-v1.openapi.json
Operations
Section titled “Operations”POST /v1/providers/{provider_id}/accounts/{account_id}/state
Section titled “POST /v1/providers/{provider_id}/accounts/{account_id}/state”Set an account’s state
Enables or disables one account: {state:“active”|“disabled”}. Operator (admin) scope.
- Operation id:
postV1ProvidersProviderIdAccountsAccountIdState - Scope:
admin - Exposure:
operator - Mutating: yes
- Auth:
bearerAuth,operatorSession
Request
- Request body (application/json, required):
EstateAccountStateRequest: EstateAccountStateRequest (object)
| Field | Type | Required | Notes |
|---|---|---|---|
state |
string | yes |
Responses
200: OKapplication/json:EstateAccountResult: EstateAccountResult (object)
400: schema_invalid — the request body or parameter failed validationapplication/problem+json:Problem: Problem (object)
401: auth_missing — no virtual key or operator sessionapplication/problem+json:Problem: Problem (object)
403: auth_scope — the credential lacks the route’s scopeapplication/problem+json:Problem: Problem (object)
404: resource_not_found — the addressed object does not existapplication/problem+json:Problem: Problem (object)
405: method_not_allowed — the path exists for another verbapplication/problem+json:Problem: Problem (object)
429: rate_limited — the per-key or per-IP bucket is exhaustedapplication/problem+json:Problem: Problem (object)
500: internal — the store or process failedapplication/problem+json:Problem: Problem (object)
501: not_implemented — the route is declared but not wired in this buildapplication/problem+json:Problem: Problem (object)
503: store_unavailable — the dependency is down; retryableapplication/problem+json:Problem: Problem (object)