Version: Current
Historical release snapshot. These docs are frozen. Read current docs.
DELETE and PUT /v1/route/policies/{scope}/{match}
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”DELETE /v1/route/policies/{scope}/{match}
Section titled “DELETE /v1/route/policies/{scope}/{match}”Delete a resolver policy override
Removes an alias or model override. The default row cannot be deleted; edit it instead. Operator (admin) scope.
- Operation id:
deleteV1RoutePoliciesScopeMatch - Scope:
admin - Exposure:
operator - Mutating: yes
- Auth:
bearerAuth,operatorSession
Responses
200: OK400: 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)
PUT /v1/route/policies/{scope}/{match}
Section titled “PUT /v1/route/policies/{scope}/{match}”Create or replace a resolver policy
Stores a partial policy document for default (address it as /default/_), an alias or a model. The document overlays the compiled default and is validated on write: unknown fields, a bad mode and out-of-range weights or parameters are 400. If-Match carries the stored version (0 = create-only); a mismatch is 412. Takes effect on the next seat reload. Operator (admin) scope.
- Operation id:
putV1RoutePoliciesScopeMatch - Scope:
admin - Exposure:
operator - Mutating: yes
- Auth:
bearerAuth,operatorSession
Request
- Request body (application/json, required):
RoutePolicyDoc: RoutePolicyDoc (object)
| Field | Type | Required | Notes |
|---|---|---|---|
allow_paid |
boolean | no | |
cost_guard |
string | no | |
explain_top_n |
integer | no | |
max_cost_micros |
number | no | |
mode |
string | no | |
params |
object | no | |
profile |
string | no | |
weights |
object | no |
Responses
200: stored; the ETag header carries the new versionapplication/json:RoutePolicyRow: RoutePolicyRow (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)
412: precondition_failed — the stored version changedapplication/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)