---
title: "Get HealthCheckAgents"
method: GET
path: "/api/v2/ui/healthcheckagents/{id}/healthCheck"
tags: ["HealthCheckAgents"]
---

# Get HealthCheckAgents

`GET /api/v2/ui/healthcheckagents/{id}/healthCheck`

## Request

- Base URL: `https://docs.hashtopolis.org`
- URL: `https://docs.hashtopolis.org/api/v2/ui/healthcheckagents/{id}/healthCheck`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/hashtopolis/apis/hashtopolis-api/docs/api/v2/ui/healthcheckagents/:id/healthCheck/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

- HealthCheckResponse
  - `jsonapi` object, required
    - `version` string, required
    - `ext` string[]
  - `links` object, required
    - `self` string, required
  - `data` object, required
    - `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
    - `links` object, required
      - `self` string, required
    - `relationships` object, required
      - `crackerBinary` object, required
        - `links` object, required
          - `self` string, required
          - `related` string, required
        - `data` object, nullable
          - `type` 'crackerBinary', required
          - `id` integer, required
      - `hashType` object, required
        - `links` object, required
          - `self` string, required
          - `related` string, required
        - `data` object, nullable
          - `type` 'hashType', required
          - `id` integer, required
      - `healthCheckAgents` object, required
        - `links` object, required
          - `self` string, required
          - `related` string, required
        - `data` object[]
          - `type` 'healthCheckAgent', required
          - `id` integer, required
  - `included` union[]
    - union
      - object
        - `id` integer, required
        - `type` 'crackerBinary', required
        - `attributes` object, required
          - `crackerBinaryTypeId` integer, required
          - `version` string, required
          - `downloadUrl` string, nullable, required: External http/https url where the agent downloads the binary archive from. The server keeps a local copy of the archive for later analysis: on creation it is downloaded from this url, and changing the url re-downloads it from the new url. The creation or change is rejected if that download fails or the archive is not a valid 7z file. Mutually exclusive with sourceType: when the archive is uploaded with sourceType, this url is set automatically to the download endpoint of this server and cannot be changed afterwards.
          - `binaryName` string, required
          - `filename` string, nullable, required: Filename of the locally stored 7z archive, null when the binary is downloaded from the downloadUrl. Cannot be provided.
          - `accessGroupId` integer, required: Access group containing this cracker binary. Required on creation; the requesting user must belong to the group. It can be changed only when the user belongs to both the current and new groups.
      - object
        - `id` integer, required
        - `type` 'hashType', required
        - `attributes` object, required
          - `description` string, required
          - `isSalted` boolean, required
          - `isSlowHash` boolean, required
      - object
        - `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

## 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/healthcheckagents/:id/healthCheck/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/87f3bd43387f?raw)