Version: Current
Historical release snapshot. These docs are frozen. Read current docs.
GET and POST /v1/providers
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”GET /v1/providers
Section titled “GET /v1/providers”List providers
Every provider with its id, adapter, base URL, auth style, egress policy and enabled flag. Operator (ops:read) scope.
- Operation id:
getV1Providers - Scope:
ops:read - Exposure:
operator - Mutating: no
- Auth:
bearerAuth,operatorSession
Responses
200: OKapplication/json:EstateProviderList: EstateProviderList (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)
POST /v1/providers
Section titled “POST /v1/providers”Add (or upsert) a provider
Registers a provider row: id, adapter and optional base URL (validated against the SSRF policy) and auth style. Operator (admin) scope.
- Operation id:
postV1Providers - Scope:
admin - Exposure:
operator - Mutating: yes
- Auth:
bearerAuth,operatorSession
Request
- Request body (application/json, required):
EstateProviderAddRequest: EstateProviderAddRequest (object)
| Field | Type | Required | Notes |
|---|---|---|---|
adapter |
string | yes | |
auth_style |
string | no | |
base_url |
string | no | |
id |
string | yes |
Responses
201: Createdapplication/json:EstateProvider: EstateProvider (object)
400: schema_invalidapplication/problem+json:Problem: Problem (object)