---
title: "Get the Gateway configuration"
method: GET
path: "/gatewayConfiguration"
tags: ["Gateway Configuration"]
---

# Get the Gateway configuration

`GET /gatewayConfiguration`

## Request

- Base URL: `https://example.itential.io`
- URL: `https://example.itential.io/gatewayConfiguration`
- Auth: none declared

Returns the Gateway configuration including feature settings and available gateways.

## Response `200`

The Gateway configuration response including config and available gateways.

- GatewayConfigurationGetGatewayConfigurationResponse200
  - `state` 'Success' | 'Error', required: Status of the operation
  - `config` GatewayConfigurationGetResponsesContentApplicationJsonSchemaConfig, required: The Gateway feature configuration object
    - `default` string, nullable: Default gateway cluster ID
    - `features` GatewayConfigurationGetResponsesContentApplicationJsonSchemaConfigFeatures, required: Feature-specific configurations
      - `integrations` GatewayConfigurationGetResponsesContentApplicationJsonSchemaConfigFeaturesIntegrations, required: Integration feature configuration for gateway routing
        - `overrideGlobalCluster` boolean, required: Whether to override the global cluster configuration for integrations
        - `cluster` string, nullable: The cluster ID to use for integrations when overriding global
        - `executionMode` 'direct' | 'proxy' | 'cluster_no_proxy', required: The execution mode for integrations
        - `proxy` GatewayConfigurationGetResponsesContentApplicationJsonSchemaConfigFeaturesIntegrationsProxy: Proxy configuration for integrations
          - `host` string, required: Proxy host address
          - `port` string, required: Proxy port number
          - `auth` GatewayConfigurationGetResponsesContentApplicationJsonSchemaConfigFeaturesIntegrationsProxyAuth: Proxy authentication credentials
            - `authMode` 'none' | 'basic' | 'secrets_manager', required: Authentication mode for the proxy
            - `username` string: Proxy authentication username
            - `password` string: Proxy authentication password (encrypted when stored)
      - `runCode` GatewayConfigurationGetResponsesContentApplicationJsonSchemaConfigFeaturesRunCode, required: Run Code Task feature configuration for gateway routing
        - `defaultCluster` string, nullable, required: Cluster ID used automatically when a Run Code Task does not specify a cluster, or when its assigned cluster is no longer allowed. Null for no default.
        - `allowedClusters` string[], required: Additional cluster IDs builders may select for a Run Code Task, beyond the default cluster
  - `gateways` GatewayConfigurationGetResponsesContentApplicationJsonSchemaGatewaysItems[], required: Array of available gateway instances
    - `_id` string: Gateway MongoDB ObjectId
    - `cluster_id` string: Gateway cluster identifier
    - `description` string: User-defined description of the gateway
    - `enabled` boolean: Whether the gateway is enabled
    - `readonly` boolean: Whether the gateway is readonly
    - `groups` string[]: Groups that can access this gateway
    - `certificates` string[]: Certificate IDs associated with this gateway
    - `created` string, date-time: Gateway creation timestamp
    - `created_by` string: Username who created the gateway
    - `last_updated` string, date-time: Last update timestamp
    - `last_updated_by` string: Username who last updated the gateway
    - `last_connected` string, date-time: Last connection timestamp
    - `last_connected_to` string: IAP instance the gateway last connected to
    - `last_discovery` string, date-time: Last discovery timestamp
    - `connection_status` 'connected' | 'disconnected': Current connection status of the gateway

## Other responses

- `500`: Error response from API

## Changes

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

[Operation history](https://skmtc.dev/itential/apis/itential-2/changes/gatewayConfiguration/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)