---
title: "Retrieve agent info by agent hash"
method: GET
path: "/agents/{hash}"
tags: ["Agents"]
---

# Retrieve agent info by agent hash

`GET /agents/{hash}`

## Path parameters

- `hash` string, required

## Response `200`

agent info received successful

- object
  - `data` object
    - `agent` ModelsAgent
      - `auth_status` 'authorized' | 'unauthorized' | 'blocked', required
      - `connected_date` string
      - `created_date` string
      - `deleted_at` string
      - `description` string, required
      - `group_id` integer
      - `hash` string, required
      - `id` integer
      - `info` ModelsAgentInfo, required
        - `net` ModelsAgentNet, required
          - `hostname` string, required
          - `ips` string[], required
        - `os` ModelsAgentOS, required
          - `arch` '386' | 'amd64', required
          - `name` string, required
          - `type` 'windows' | 'linux' | 'darwin', required
        - `tags` string[], required
        - `users` ModelsAgentUser[], required
          - `groups` string[], required
          - `name` string, required
      - `ip` string, required
      - `status` 'connected' | 'disconnected', required
      - `updated_at` string
      - `version` string, required
    - `details` PrivateAgentDetails
      - `active_modules` integer
      - `consistency` boolean
      - `dependencies` ModelsAgentDependency[]
        - `min_agent_version` string
        - `min_module_version` string
        - `module_name` string
        - `policy_id` integer
        - `source_module_name` string, required
        - `status` boolean
        - `type` 'to_receive_data' | 'to_send_data' | 'to_make_action' | 'agent_version', required
      - `group` ModelsGroup
        - `created_date` string
        - `deleted_at` string
        - `hash` string, required
        - `id` integer
        - `info` ModelsGroupInfo, required
          - `name` ModelsGroupItemLocale, required
            - `en` string, required
            - `ru` string, required
          - `system` boolean
          - `tags` string[], required
        - `updated_at` string
      - `hash` string
      - `joined_modules` string
      - `modules` ModelsModuleAShort[]
        - `deleted_at` string
        - `dynamic_dependencies` ModelsDependencyItem[], required
          - `min_agent_version` string
          - `min_module_version` string
          - `module_name` string
          - `type` 'to_receive_data' | 'to_send_data' | 'to_make_action' | 'agent_version', required
        - `id` integer
        - `info` ModelsModuleInfo, required
          - `actions` string[], required
          - `events` string[], required
          - `fields` string[], required
          - `name` string, required
          - `os` ModelsModuleInfoOS, required
          - `system` boolean
          - `tags` string[], required
          - `template` 'generic' | 'empty' | 'collector' | 'detector' | 'responder' | 'custom', required
          - `version` ModelsSemVersion, required
            - `major` integer
            - `minor` integer
            - `patch` integer
        - `last_module_update` string, required
        - `last_update` string
        - `locale` ModelsLocale, required
          - `action_config` object, required
          - `actions` object, required
          - `config` object, required
          - `event_config` object, required
          - `events` object, required
          - `fields` object, required
          - `module` ModelsModuleLocaleDesc, required
          - `secure_config` object
          - `tags` object, required
        - `policy_id` integer
        - `state` 'draft' | 'release'
        - `static_dependencies` ModelsDependencyItem[], required
          - `min_agent_version` string
          - `min_module_version` string
          - `module_name` string
          - `type` 'to_receive_data' | 'to_send_data' | 'to_make_action' | 'agent_version', required
      - `policies` ModelsPolicy[]
        - `created_date` string
        - `deleted_at` string
        - `hash` string, required
        - `id` integer
        - `info` ModelsPolicyInfo, required
          - `name` ModelsPolicyItemLocale, required
            - `en` string, required
            - `ru` string, required
          - `system` boolean
          - `tags` string[], required
        - `updated_at` string
      - `upgrade_task` ModelsAgentUpgradeTask
        - `agent_id` integer
        - `batch` string, required
        - `created` string
        - `id` integer
        - `last_update` string
        - `reason` string
        - `status` 'new' | 'running' | 'ready' | 'failed', required
        - `version` string, required
  - `status` string

## Other responses

- `403` — getting agent info not permitted
- `404` — agent not found
- `500` — internal error on getting agent

---

[API](https://skmtc.net/vxcontrol/apis/soldr-swagger-api.md) · [All operations](https://skmtc.net/vxcontrol/apis/soldr-swagger-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vxcontrol/soldr-swagger-api/revisions/ac519ec936b3/schema)