---
title: "Create a new storage gateway"
method: POST
path: "/v1/storage_gateways/"
---

# Create a new storage gateway

`POST /v1/storage_gateways/`

## Request

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

## Headers

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

## Request body

- IconikStorageGatewaySchema
  - `cluster_id` string, uuid
  - `date_created` string, date-time
  - `date_modified` string, date-time
  - `description` string
  - `enabled` boolean, required: Application toggle. If turned off ISG will enter idle state waiting to get enabled again.
  - `id` string, uuid
  - `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
  - `storage_addr` string: Server address for direct transfers between storage gateways
  - `storages` object: Storage mount points mapped by storage ID

## Response `201`

Storage gateway created successfully

- IconikStorageGatewaySchema
  - `cluster_id` string, uuid
  - `date_created` string, date-time
  - `date_modified` string, date-time
  - `description` string
  - `enabled` boolean, required: Application toggle. If turned off ISG will enter idle state waiting to get enabled again.
  - `id` string, uuid
  - `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
  - `storage_addr` string: Server address for direct transfers between storage gateways
  - `storages` object: Storage mount points mapped by storage ID

## Other responses

- `400`: Invalid input
- `401`: Token is invalid
- `403`: Forbidden - requires admin, or ISG PRO is not enabled
- `404`: Storage does not exist
- `409`: Node limit reached, or the limit could not be validated (retry)
- `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)