---
title: "Get HealthChecks"
method: GET
path: "/api/v2/ui/healthchecks/{id}/healthCheckAgents"
tags: ["HealthChecks"]
---

# Get HealthChecks

`GET /api/v2/ui/healthchecks/{id}/healthCheckAgents`

## Request

- Base URL: `https://docs.hashtopolis.org`
- URL: `https://docs.hashtopolis.org/api/v2/ui/healthchecks/{id}/healthCheckAgents`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/hashtopolis/apis/hashtopolis-api/docs/api/v2/ui/healthchecks/:id/healthCheckAgents/get.ts> (a function with typed inputs; its response is checked against the schema)

GET request to retrieve a single object.

## Path parameters

- `id` integer, required

## Response `200`

successful operation

- HealthCheckAgentListResponse
  - `jsonapi` object, required
    - `version` string, required
    - `ext` string[]
  - `links` object, required
    - `self` string, required
    - `first` string, required
    - `last` string, nullable, required
    - `next` string, nullable, required
    - `prev` string, nullable, required
  - `meta` object, required
    - `page` object, required
      - `total_elements` integer, required
  - `data` object[], required
    - `id` integer, required
    - `type` 'healthCheckAgent', required
    - `attributes` object, required
      - `healthCheckId` integer, required
      - `agentId` integer, required
      - `status` union, required
        - -1
        - 0
        - 1
      - `cracked` integer, required
      - `numGpus` integer, required
      - `start` integer, required
      - `end` integer, required
      - `errors` string, required
    - `links` object, required
      - `self` string, required
    - `relationships` object, required
      - `agent` object, required
        - `links` object, required
          - `self` string, required
          - `related` string, required
        - `data` object, nullable
          - `type` 'agent', required
          - `id` integer, required
      - `healthCheck` object, required
        - `links` object, required
          - `self` string, required
          - `related` string, required
        - `data` object, nullable
          - `type` 'healthCheck', required
          - `id` integer, required
  - `included` union[]
    - union
      - object
        - `id` integer, required
        - `type` 'agent', required
        - `attributes` object, required
          - `agentName` string, required
          - `uid` string, required
          - `os` union, required
            - 0
            - 1
            - 2
          - `devices` string, required
          - `cmdPars` string, required
          - `ignoreErrors` union, required
            - 0
            - 1
            - 2
          - `isActive` boolean, required
          - `isTrusted` boolean, required
          - `token` string, required
          - `lastAct` string, required
          - `lastTime` integer, required
          - `lastIp` string, required
          - `userId` integer, nullable, required
          - `cpuOnly` boolean, required
          - `clientSignature` string, required
      - object
        - `id` integer, required
        - `type` 'healthCheck', required
        - `attributes` object, required
          - `time` integer, required
          - `status` union, required
            - -1
            - 0
            - 1
          - `checkType` union, required
            - 0
            - 3200
          - `hashtypeId` integer, required
          - `crackerBinaryId` integer, required
          - `expectedCracks` integer, required
          - `attackCmd` string, required

## Other responses

- `400`: Invalid request
- `401`: Authentication failed
- `403`: Permission denied
- `404`: Not Found

## Changes

- **2026-10-22** `559b0274a0c8`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/hashtopolis/apis/hashtopolis-api/changes/api/v2/ui/healthchecks/:id/healthCheckAgents/get.md)

---

[API](https://skmtc.dev/hashtopolis/apis/hashtopolis-api.md) - [All operations](https://skmtc.dev/hashtopolis/apis/hashtopolis-api/llms.txt) - [OpenAPI document](https://skmtc.dev/hashtopolis/apis/hashtopolis-api/revisions/fde7c323b9d9?raw)