Skip to main content
POST
Error
This endpoint is available in Bifrost Enterprise only.

Authorizations

Authorization
string
header
required

Management API authentication for /api/* endpoints. Use the Authorization header with Bearer <API key>. Virtual keys, dashboard/user/session tokens, and x-api-key headers are not supported on management APIs.

Body

application/json

A request to evaluate, plus the context the caller would otherwise have sent as HTTP headers.

phase
enum<string>
required

request evaluates before the upstream call; response reports the outcome afterwards, which is the phase that can write a log row.

Available options:
request,
response
log
boolean

Write a log row for this call. Honoured on the response phase, where the row carries the resolved governance project.

request_id
string
session_id
string
request
object

The Bifrost request being inspected.

response
object

The upstream response, on the response phase.

error
object

Error response from Bifrost

metadata
object

Read as the inspected request's headers, lowercased. This is how a caller scopes the inspection to a governance project, with x-bf-project-id or x-bf-project-name.

plugin_logs
object[]

Lines carried over from an earlier phase.

Response

Verdict returned

allow
boolean

Whether forwarding the original request is permitted.

reason
string

Why it was refused. Absent when allowed.

plugin_logs
object[]