List project agents
Lists the project's agents from its ProjectMembershipV1 evidence: one row per registered agent, whether its memberships name the agent or its keys, and one per DID no agent holds. A row's subject_did is the agent's urn:uuid, or that DID. Non-active evidence remains visible.
https://<host>/api/v1/projects/{project_uuid}/agentscurl --request GET \
--url 'https://<host>/api/v1/projects/{project_uuid}/agents' \
--header 'Authorization: Bearer <token>'const response = await fetch("https://<host>/api/v1/projects/{project_uuid}/agents", {
method: "GET",
headers: {
"Authorization": "Bearer <token>"
}
});
const data = await response.json();interface ProjectAgentListResponseDoc {
activity_window?: string;
correlation_id?: string;
items?: Record<string, unknown>[];
total_count?: number;
window_end?: string;
window_start?: string;
}
const response = await fetch("https://<host>/api/v1/projects/{project_uuid}/agents", {
method: "GET",
headers: {
"Authorization": "Bearer <token>"
}
});
if (!response.ok) throw new Error(`${response.status} ${response.statusText}`);
const data: ProjectAgentListResponseDoc = await response.json();import requests
response = requests.get(
"https://<host>/api/v1/projects/{project_uuid}/agents",
headers={
"Authorization": "Bearer <token>",
},
)
response.raise_for_status()
print(response.json())package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, err := http.NewRequest(http.MethodGet, "https://<host>/api/v1/projects/{project_uuid}/agents", nil)
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer <token>")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
data, err := io.ReadAll(res.Body)
if err != nil {
panic(err)
}
fmt.Println(res.Status, string(data))
}import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://<host>/api/v1/projects/{project_uuid}/agents"))
.header("Authorization", "Bearer <token>")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}using System.Net.Http.Headers;
using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://<host>/api/v1/projects/{project_uuid}/agents");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<token>");
using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");<?php
$ch = curl_init('https://<host>/api/v1/projects/{project_uuid}/agents');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer <token>',
],
CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
echo $status . " " . $response . PHP_EOL;require "net/http"
uri = URI("https://<host>/api/v1/projects/{project_uuid}/agents")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer <token>"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
http.request(request)
end
puts "#{response.code} #{response.body}"// Cargo.toml dependencies: reqwest, tokio (features "full")
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let response = reqwest::Client::new()
.get("https://<host>/api/v1/projects/{project_uuid}/agents")
.header("Authorization", "Bearer <token>")
.send()
.await?;
println!("{} {}", response.status(), response.text().await?);
Ok(())
}Authorizations
BearerAuth· API key in header "Authorization" — Type "Bearer" followed by a space and a sign-in token: a Guardian Platform JWT, or an OIDC ID token in a standalone deployment.ApiKeyAuth· API key in header "Authorization" — Type "Bearer" followed by a space and a Guardian Platform API key. Project-scoped routes and registration tokens check the key's scopes and project binding. Per-agent routes accept a key bound to no project that has empty scopes or full access, which acts as its holder, or a scope for what the route does: submit_agent_assessments reads an agent (its detail, configurations, state history and the files a state references, definitions, tools and operating profile, as its assessments rest on), view_agent_certifications reads its certifications, and manage_programs or review_agent_assessments attach a certification. A state's raw snapshot and findings, its audit exchanges and plugin events, and saving its operating profile take full access. A scope counts only while the key's holder still holds that permission in the key's organization, which auth-service reports as keyHeldScopes. A key never acts as an admin, so its holder's binding to the agent still decides.
Parameters
Path parameters
| Name | Type | Description |
|---|---|---|
project_uuidrequired | string | Guardian project UUID |
Query parameters
| Name | Type | Description |
|---|---|---|
limit | integer | Page size |
offset | integer | Agent offset |
include | string | Extra data to include |
Responses
200OK
activity_windowstringcorrelation_idstringitemsinternal_controlhttp.projectAgentSummaryDoc[]Show properties
Array of
internal_controlhttp.projectAgentSummaryDocagent_idstringapp_typestringbadgesgithub_com_eqtylab_gateway_control-plane_service_internal_discovery.AgentBadge[]Show properties
Array of
github_com_eqtylab_gateway_control-plane_service_internal_discovery.AgentBadgedescriptionstringfirst_observed_atstringkeystringlabelstringlast_observed_atstringmetadataobjectShow properties
Map of
anymetadata_typestringplugin_idstringstatusstringsubject_didstring
did_sourcestringdisplay_namestringframeworkobjectThe framework of the definition the agent's newest state, in any project, names, as app_type is; a project's own current definition is on its definitions route
Show properties
namestringpackagesobjectShow properties
Map of
string
last_activity_atstringmembership_evidenceinternal_controlhttp.projectAgentMembershipEvidenceDoc[]Show properties
Array of
internal_controlhttp.projectAgentMembershipEvidenceDoccredential_idstringcredential_statusinternal_controlhttp.projectAgentCredentialStatusDoc[]Show properties
Array of
internal_controlhttp.projectAgentCredentialStatusDocidstringrawobjectShow properties
Map of
anystatus_list_credentialstringstatus_list_indexstringstatus_purposestringtypestring
credential_status_checked_atstringgateway_agent_idstringissuer_didstringlast_verified_atstringobserved_atstringproject_urnstringproject_uuidstringrolesstring[]sourcestringsource_refsinternal_controlhttp.projectAgentSourceRefsDocShow internal_controlhttp.projectAgentSourceRefsDoc
credential_idstringsource_cidstringstatement_cidstringstatement_idstring
status_check_attempted_atstringstatus_resolutioninternal_controlhttp.projectAgentStatusResolutionDocShow internal_controlhttp.projectAgentStatusResolutionDoc
checked_atstringmetadataobjectShow properties
Map of
anyrevokedboolean
subject_didstringThe credential's subject: a DID or the agent's urn:uuid
valid_fromstringvalid_untilstringvalidation_errorsinternal_controlhttp.projectAgentValidationErrorDoc[]Show properties
Array of
internal_controlhttp.projectAgentValidationErrorDoccodestringfieldstringmessagestring
validation_statusstring
membership_statestringprimary_didstringprimary_user_display_namestringstatusstringsubject_didstringThe row's identity: the agent's ID (its urn:uuid) for a registered agent, whether its memberships name the agent or its keys, or the DID no agent holds
throughputinteger[]
total_countintegerwindow_endstringwindow_startstring
{
"activity_window": "string",
"correlation_id": "string",
"items": [
{
"agent_id": "string",
"app_type": "string",
"badges": [
{
"description": "string",
"first_observed_at": "string",
"key": "string",
"label": "string",
"last_observed_at": "string",
"metadata": {
"key": null
},
"metadata_type": "string",
"plugin_id": "string",
"status": "string",
"subject_did": "string"
}
],
"did_source": "string",
"display_name": "string",
"framework": {
"name": "string",
"packages": {
"key": "string"
}
},
"last_activity_at": "string",
"membership_evidence": [
{
"credential_id": "string",
"credential_status": [
{
"id": "string",
"raw": {
"key": null
},
"status_list_credential": "string",
"status_list_index": "string",
"status_purpose": "string",
"type": "string"
}
],
"credential_status_checked_at": "string",
"gateway_agent_id": "string",
"issuer_did": "string",
"last_verified_at": "string",
"observed_at": "string",
"project_urn": "string",
"project_uuid": "string",
"roles": [
"string"
],
"source": "string",
"source_refs": {
"credential_id": "string",
"source_cid": "string",
"statement_cid": "string",
"statement_id": "string"
},
"status_check_attempted_at": "string",
"status_resolution": {
"checked_at": "string",
"metadata": {
"key": null
},
"revoked": true
},
"subject_did": "string",
"valid_from": "string",
"valid_until": "string",
"validation_errors": [
{
"code": "string",
"field": "string",
"message": "string"
}
],
"validation_status": "string"
}
],
"membership_state": "string",
"primary_did": "string",
"primary_user_display_name": "string",
"status": "string",
"subject_did": "string",
"throughput": [
0
]
}
],
"total_count": 0,
"window_end": "string",
"window_start": "string"
}400Bad Request
codestringcorrelation_idstringmessagestring
{
"code": "string",
"correlation_id": "string",
"message": "string"
}401Unauthorized
codestringcorrelation_idstringmessagestring
{
"code": "string",
"correlation_id": "string",
"message": "string"
}403Forbidden
codestringcorrelation_idstringmessagestring
{
"code": "string",
"correlation_id": "string",
"message": "string"
}404Not Found
codestringcorrelation_idstringmessagestring
{
"code": "string",
"correlation_id": "string",
"message": "string"
}500Internal Server Error
codestringcorrelation_idstringmessagestring
{
"code": "string",
"correlation_id": "string",
"message": "string"
}503Service Unavailable
codestringcorrelation_idstringmessagestring
{
"code": "string",
"correlation_id": "string",
"message": "string"
}