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>'

import requests

url = "https://api.blaxel.ai/v0/policies/{policyName}/usages"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.blaxel.ai/v0/policies/{policyName}/usages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.blaxel.ai/v0/policies/{policyName}/usages",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.blaxel.ai/v0/policies/{policyName}/usages"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.blaxel.ai/v0/policies/{policyName}/usages")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.blaxel.ai/v0/policies/{policyName}/usages")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

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.