List resources using a policy

Returns the names of every resource (agent, function, model, sandbox, job) currently referencing the given policy. Replaces the client-side fan-out the policies UI used to do over the listings.

GET /policies/{policyName}/usages

List resources using a policy

cURL

curl --request GET \
  --url https://api.blaxel.ai/v0/policies/{policyName}/usages \
  --header 'Authorization: Bearer <token>'

200

{
  "agents": [
    {}
  ],
  "functions": [
    {}
  ],
  "jobs": [
    {}
  ],
  "models": [
    {}
  ],
  "sandboxes": [
    {}
  ]
}

Authorizations

OAuth2ApiKeyAuth

Authorization · string · header · required

OAuth2 authentication with JWT tokens

Path Parameters

policyName · string · required

Unique name identifier of the policy

Response

200 - application/json

successful operation

Resources currently referencing a policy. Returned by GET /policies/{name}/usages so the policies UI can render attachments without fetching the agents/models/functions listings full.

agents · object[]

Names of agents whose spec.policies contains this policy.

functions · object[]

Names of functions whose spec.policies contains this policy.

jobs · object[]

Names of jobs whose spec.policies contains this policy.

models · object[]

Names of models whose spec.policies contains this policy.

sandboxes · object[]

Names of sandboxes whose spec.policies contains this policy.