Get the Gateway configuration

GET

https://example.itential.io/gatewayConfiguration

GET

/gatewayConfiguration

curl https://example.itential.io/gatewayConfiguration \
     -u "<username>:<password>"

{
  "state": "Success",
  "config": {
    "features": {
      "integrations": {
        "overrideGlobalCluster": true,
        "executionMode": "direct",
        "cluster": "string",
        "proxy": null
      },
      "runCode": {
        "defaultCluster": "string",
        "allowedClusters": [
          "string"
        ]
      }
    },
    "default": "string"
  },
  "gateways": [
    {
      "_id": "string",
      "cluster_id": "string",
      "description": "string",
      "enabled": true,
      "readonly": true,
      "groups": [
        "string"
      ],
      "certificates": [
        "string"
      ],
      "created": "2024-01-15T09:30:00Z",
      "created_by": "string",
      "last_updated": "2024-01-15T09:30:00Z",
      "last_updated_by": "string",
      "last_connected": "2024-01-15T09:30:00Z",
      "last_connected_to": "string",
      "last_discovery": "2024-01-15T09:30:00Z",
      "connection_status": "connected"
    }
  ]
}

Returns the Gateway configuration including feature settings and available gateways.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Response

The Gateway configuration response including config and available gateways.

stateenum

Status of the operation

Allowed values:

configobject

The Gateway feature configuration object

gatewayslist of objects

Array of available gateway instances

Errors

500

Internal Server Error