---
title: "Get a specific storage gateway cluster"
method: GET
path: "/v1/storage_gateway_clusters/{cluster_id}/"
---

# Get a specific storage gateway cluster

`GET /v1/storage_gateway_clusters/{cluster_id}/`

## Request

- Base URL: `https://app.iconik.io/API/files`
- URL: `https://app.iconik.io/API/files/v1/storage_gateway_clusters/{cluster_id}/`
- Auth: none declared. Required headers: `App-ID`, `Auth-Token`
- TypeScript: <https://skmtc.dev/iconik/apis/iconik-files/docs/v1/storage_gateway_clusters/:cluster_id/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `cluster_id` string, required

## Query parameters

- `view_nodes` boolean
- `view_stats` boolean
- `get_connection_uri` boolean

## Headers

- `App-ID` string, required
- `Auth-Token` string, required

## Response `200`

Returns the cluster

- IconikStorageGatewayClusterReadSchema
  - `date_created` string, date-time
  - `date_modified` string, date-time
  - `db_connection_uri` string: Database connection URI
  - `description` string
  - `enabled` boolean, required: Application toggle. If turned off ISG will enter idle state waiting to get enabled again.
  - `id` string, uuid
  - `leader_changed_at` string, date-time
  - `leader_id` string, uuid: Last reported leader ID.
  - `name` string, required
  - `nodes` IconikStorageGatewayRead[]
    - `cluster_id` string, uuid
    - `cluster_storage_ids` string[]: Cluster storage IDs
    - `date_created` string, date-time
    - `date_modified` string, date-time
    - `dedicated_storage_ids` string[]: Dedicated storage IDs
    - `description` string
    - `enabled` boolean, required: Application toggle. If turned off ISG will enter idle state waiting to get enabled again.
    - `id` string, uuid
    - `merged_settings` ISGConfigClusterSettingsSchema
      - `checksum_max_workers` integer
      - `file_download_parallel_downloads_num` integer
      - `file_upload_parallel_uploads_num` integer
      - `ingest_concurrency_value` integer
      - `max_transcoding_jobs` integer
      - `scanner_concurrency_value` integer
    - `name` string, required
    - `public_identity` string
    - `roles` string[]: Set of roles this gateway can perform when part of cluster
    - `settings` union: Application configuration settings as key-value pairs
      - ISGConfigSettingsSchema
        - `checksum_max_workers` integer
        - `file_download_parallel_downloads_num` integer
        - `file_upload_parallel_uploads_num` integer
        - `ingest_concurrency_value` integer
        - `max_transcoding_jobs` integer
        - `scanner_concurrency_value` integer
      - object, nullable
    - `status` 'OFFLINE' | 'ACTIVE' | 'WARNING' | 'ERROR' | 'STOPPED'
    - `storage_addr` string: Server address for direct transfers between storage gateways
    - `storages` object: Storage mount points mapped by storage ID
    - `telemetry` IconikStorageGatewayTelemetry
      - `error_log_lines` string[]
      - `host_info` string
      - `host_ip` string
      - `host_name` string
      - `is_leader` boolean
      - `log_lines` string[]
      - `start_last_date` string, date-time
      - `start_status` 'SUCCESS' | 'FAILED'
      - `start_status_message` string
      - `status` 'OFFLINE' | 'LIVE' | 'UNKNOWN' | 'WARNING' | 'ERROR' | 'STOPPED'
      - `storage_gateway_id` string, uuid
      - `version` string
      - `worker_id` string, uuid, required
  - `settings` ISGConfigClusterSettingsSchema
    - `checksum_max_workers` integer
    - `file_download_parallel_downloads_num` integer
    - `file_upload_parallel_uploads_num` integer
    - `ingest_concurrency_value` integer
    - `max_transcoding_jobs` integer
    - `scanner_concurrency_value` integer
  - `status` 'OFFLINE' | 'ACTIVE' | 'WARNING' | 'ERROR' | 'STOPPED'
  - `storage_ids` string[], required
  - `total_files_number` integer: Total number of files
  - `transcode_queue_total` integer: Total number of scheduled transcode jobs
  - `uploads_queue_total` integer: Total number of scheduled auto-uploads
  - `visibility_timeout` integer: The number of seconds jobs should remain invisible to other nodes

## Other responses

- `401`: Token is invalid
- `403`: Forbidden - requires admin, or ISG PRO is not enabled
- `404`: Cluster doesn't exist
- `default`: Error response

---

[API](https://skmtc.dev/iconik/apis/iconik-files.md) - [All operations](https://skmtc.dev/iconik/apis/iconik-files/llms.txt) - [OpenAPI document](https://skmtc.dev/iconik/apis/iconik-files/revisions/ed57d13791a2?raw)