---
title: "Get a cluster"
method: GET
path: "/orgs/{orgName}/clusters/{clusterName}/"
tags: ["Cluster"]
---

# Get a cluster

`GET /orgs/{orgName}/clusters/{clusterName}/`

## Request

- Base URL: `https://api.signadot.com/api/v2`
- URL: `https://api.signadot.com/api/v2/orgs/{orgName}/clusters/{clusterName}/`
- Auth: API key in header `signadot-api-key`

Get a cluster.

## Path parameters

- `orgName` string, required
- `clusterName` string, required

## Response `200`

OK

- Cluster
  - `clusterConfig` ConfigClusterConfig
    - `allowOrphanedResources` boolean
    - `allowedNamespaces` string[]
    - `controlPlane` ConfigControlPlaneConfig
      - `disabled` boolean: control plane can be disabled
      - `proxy` string: control plane proxy can be "enabled" or "disabled"
      - `tunnelAddr` string
      - `tunnelTLS` boolean
    - `routing` ConfigRoutingConfig
      - `customHeaders` string[]
      - `defaultHeaders` ConfigDefaultHeaderClass[]
      - `gatewayAPI` ConfigGatewayAPIConfig
        - `enabled` boolean
        - `preservedAnnotations` string[]
        - `preservedLabels` string[]
      - `iptablesMode` string
      - `istio` ConfigIstioConfig
        - `enableHostRouting` boolean: Deprecated fields
        - `enabled` boolean
        - `operator` ConfigIstioSignadotOperator
          - `podLabels` object
      - `linkerd` ConfigLinkerdConfig
        - `enabled` boolean
        - `operator` ConfigLinkerdSignadotOperator
          - `podAnnotations` object
      - `queryParamRouting` ConfigQueryParamRoutingConfig
        - `enabled` boolean
        - `paramName` string
    - `sandboxTrafficManager` ConfigSandboxTrafficManagerConfig
      - `enabled` boolean
    - `trafficCapture` ConfigTrafficCaptureConfig
      - `enabled` boolean
      - `requestHeadersElide` string[]
      - `responseHeadersElide` string[]
    - `trafficManager` ConfigTrafficManagerConfig
      - `enabled` boolean
  - `createdAt` string: The time when this cluster was registered with Signadot.
  - `name` string: The name of the cluster.
  - `operator` ClusterOperator
    - `version` string: The operator version of the cluster. This may be nil if the cluster has not yet connected to Signadot.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `502`: Bad Gateway

## Changes

- **2022-07-19** `5611dcd0cbdb`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/signadot/apis/signadot-api/changes/orgs/:orgName/clusters/:clusterName/get.md)

---

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