---
title: "Inspect a Gateway cluster"
method: GET
path: "/gateway_manager/v1/gateway/{clusterId}/{target}"
tags: ["Gateway Manager"]
---

# Inspect a Gateway cluster

`GET /gateway_manager/v1/gateway/{clusterId}/{target}`

## Request

- Base URL: `https://example.itential.io`
- URL: `https://example.itential.io/gateway_manager/v1/gateway/{clusterId}/{target}`
- Auth: none declared

Runs a named inspection operation against the specified gateway cluster. Use 'health' to get per-component health status, or 'activity' to get running and recently completed work across all runner nodes.

## Path parameters

- `clusterId` string, required
- `target` string, required

## Response `200`

The result of the inspection operation. Shape varies by target.

- union
  - GatewayManagerInspectClusterResponse2000: Returned when target is 'health'. Use the healthy boolean to determine if the cluster can accept work.
    - `cluster_id` string
    - `healthy` boolean
    - `components` GatewayManagerV1GatewayClusterIdTargetGetResponsesContentApplicationJsonSchemaOneOf0Components
      - `store` GatewayManagerV1GatewayClusterIdTargetGetResponsesContentApplicationJsonSchemaOneOf0ComponentsStore
        - `backend` string
        - `nodes` GatewayManagerV1GatewayClusterIdTargetGetResponsesContentApplicationJsonSchemaOneOf0ComponentsStoreNodesItems[]
          - `address` string
          - `status` string
      - `runner` GatewayManagerV1GatewayClusterIdTargetGetResponsesContentApplicationJsonSchemaOneOf0ComponentsRunner
        - `nodes` GatewayManagerV1GatewayClusterIdTargetGetResponsesContentApplicationJsonSchemaOneOf0ComponentsRunnerNodesItems[], nullable: null when store is down and enumeration was impossible
          - `type` string
          - `address` string
          - `status` string
      - `gateway_manager` GatewayManagerV1GatewayClusterIdTargetGetResponsesContentApplicationJsonSchemaOneOf0ComponentsGatewayManager
        - `type` string, nullable
        - `address` string, nullable
        - `status` string
      - `controller` GatewayManagerV1GatewayClusterIdTargetGetResponsesContentApplicationJsonSchemaOneOf0ComponentsController
        - `nodes` GatewayManagerV1GatewayClusterIdTargetGetResponsesContentApplicationJsonSchemaOneOf0ComponentsControllerNodesItems[], nullable: null when store is down and enumeration was impossible
          - `hostname` string
          - `status` string
  - GatewayManagerInspectClusterResponse2001: Returned when target is 'activity'.
    - `healthy` boolean: True when the store is healthy and at least one runner is reachable.
    - `entries` GatewayManagerV1GatewayClusterIdTargetGetResponsesContentApplicationJsonSchemaOneOf1EntriesItems[]
      - `name` string
      - `type` string
      - `node` string
      - `status` string
      - `started_at` string
      - `completed_at` string, nullable

## Other responses

- `500`: Error response from API

## Changes

- **2026-10-31** `2095cc90e583`: 2 info
  - api tag `Gateway Manager` added
  - api tag `gatewayManager` removed

[Operation history](https://skmtc.dev/itential/apis/itential-2/changes/gateway_manager/v1/gateway/:clusterId/:target/get.md)

---

[API](https://skmtc.dev/itential/apis/itential-2.md) - [All operations](https://skmtc.dev/itential/apis/itential-2/llms.txt) - [OpenAPI document](https://skmtc.dev/itential/apis/itential-2/revisions/2095cc90e583?raw)