A valid request URL is required to generate request examples{
"governed": true,
"profile_name": "<string>"
}{
"event_id": "<string>",
"type": "<string>",
"is_bifrost_error": true,
"status_code": 123,
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"event_id": "<string>"
},
"extra_fields": {
"provider": "anthropic",
"model_requested": "<string>",
"request_type": "<string>"
}
}Get the calling user's virtual-key creation policy
Reports whether virtual keys the calling user creates will be adopted into one of their access profiles, and if so which one. The create form uses this to lock the policy fields up front rather than letting a user author a policy that is about to be overwritten.
Self-scoped: it always describes the caller and takes no user ID. Returns
{"governed": false} when the caller has no per-user identity (local admin or password
auth) or when no profile they hold has Govern virtual keys created by members enabled.
When more than one of their profiles has it on, the first such profile governs.
A valid request URL is required to generate request examples{
"governed": true,
"profile_name": "<string>"
}{
"event_id": "<string>",
"type": "<string>",
"is_bifrost_error": true,
"status_code": 123,
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"event_id": "<string>"
},
"extra_fields": {
"provider": "anthropic",
"model_requested": "<string>",
"request_type": "<string>"
}
}Authorizations
Management API authentication for /api/* endpoints. Use the Authorization header
with Bearer <token>, where <token> is one of:
- a Bifrost management API key,
- a dashboard session token issued by
POST /api/session/login, - base64 of
<admin-username>:<admin-password>(legacy equivalent ofBasicAuth).
Virtual keys (sk-bf-*) and the x-api-key header are not accepted on management APIs -
the sole exception is GET /api/governance/virtual-keys/quota, which is virtual-key-only.
Was this page helpful?