Agentes asignados directamente a esta zona

GET/api/public/v1/zones/{zone_id}/agents

Every row carries level (the derived control level) and stale. ?level= and ?compatibility=unavailable filter on the SAME expressions the rows are built from, so a row's level and its inclusion in a filtered list cannot disagree. below_count is the agents in descendant zones.

cURL

curl --fail-with-body -X GET 'https://app.openlatch.ai/api/public/v1/zones/<zone_id>/agents' \
  -H "Authorization: Bearer $OPENLATCH_API_KEY"

Python

import json
import os
import urllib.request

request = urllib.request.Request(
    'https://app.openlatch.ai/api/public/v1/zones/<zone_id>/agents',
    method='GET',
    headers={
        'Authorization': 'Bearer ' + os.environ['OPENLATCH_API_KEY'],
    },
)
with urllib.request.urlopen(request) as response:
    text = response.read().decode()
    print(json.dumps(json.loads(text), indent=2) if text else response.status)

Bash

#!/usr/bin/env bash
set -euo pipefail

curl -sS --fail-with-body -X GET 'https://app.openlatch.ai/api/public/v1/zones/<zone_id>/agents' \
  -H "Authorization: Bearer $OPENLATCH_API_KEY" | jq .

PowerShell

$headers = @{
  Authorization = "Bearer $env:OPENLATCH_API_KEY"
}
Invoke-RestMethod -Method GET -Uri 'https://app.openlatch.ai/api/public/v1/zones/<zone_id>/agents' -Headers $headers | ConvertTo-Json -Depth 20

Autorización

Rol en la organización	Este punto de conexión
owner	Permitido
admin	Permitido
editor	Permitido
viewer	Permitido

Una clave tiene el rol que su propietario ocupa en la organización. Consulte Autenticación.

Ámbito de la clave de API: zones:read

Parámetros de ruta

Parámetro	Tipo	Descripción
zone_id	string (uuid)	Obligatorio.

Parámetros de consulta

Parámetro	Tipo	Descripción
level	string or null
compatibility	string or null
page	integer
page_size	integer

Respuesta

• 200 OK — la llamada se completó correctamente.
• 401 Unauthorized — UNAUTHORIZED
• 402 Payment Required — license_expired
• 403 Forbidden — FEATURE_DISABLED, FORBIDDEN, INSUFFICIENT_SCOPE
• 404 Not Found — NOT_FOUND
• 422 Unprocessable Content — INVALID_ID, VALIDATION_ERROR
• 429 Too Many Requests — TOO_MANY_REQUESTS
• 500 Internal Server Error — INTERNAL_SERVER_ERROR, tenant_isolation_violation
• 503 Service Unavailable — FEATURE_STATE_UNAVAILABLE, SERVICE_UNAVAILABLE

Campos de la respuesta

Campo	Tipo	Descripción
below_count	integer	Obligatorio.
data	array of object	Obligatorio.
data[].agent_id	string	Obligatorio.
data[].assignment_source	string	Obligatorio.
data[].auto_zone_id	string or null
data[].display_name	string or null
data[].env	string	Obligatorio.
data[].instance_qualifier	object or null	What tells this agent apart from the other agents of its platform on its host; null for a host's first OS user in their default profile. os_user is null for a key without agents:read.
data[].last_seen	string or null
data[].latest_arch	string or null
data[].latest_client_version	string or null
data[].latest_os	string or null
data[].latest_session_intent	string or null
data[].level	string	Obligatorio.
data[].owner	string or null
data[].platform	string	Obligatorio.
data[].sessions_count	integer
data[].stale	boolean	Obligatorio.
data[].zone_id	string	Obligatorio.
page	integer	Obligatorio.
page_size	integer	Obligatorio.
total	integer	Obligatorio.

Ejemplo de respuesta

{
  "below_count": 3,
  "data": [
    {
      "agent_id": "agt_01jbwa2k1vfrn9y42xhgxhmzj2",
      "assignment_source": "string",
      "auto_zone_id": "3f6c1a2e-8b4d-4c1f-9a7e-0d5b2c8e4f10",
      "display_name": "release-bot",
      "env": "string",
      "instance_qualifier": {
        "os_user": "string",
        "profile_suffix": "string",
        "user_suffix": "string"
      },
      "last_seen": "string",
      "latest_arch": "string",
      "latest_client_version": "string",
      "latest_os": "string",
      "latest_session_intent": "string",
      "level": "string",
      "owner": "string",
      "platform": "string",
      "sessions_count": 0,
      "stale": false,
      "zone_id": "3f6c1a2e-8b4d-4c1f-9a7e-0d5b2c8e4f10"
    }
  ],
  "page": 1,
  "page_size": 3,
  "total": 3
}

Véase también

• DELETE Restablecer la asignación automática de zona de un agente
• GET Lo que se aplica a este agente
• PUT Asignar un agente a una zona a mano