Create an ingress route

POST

/api/proxy-hosts

curl --request POST \
  --url https://gateway.example.com/api/proxy-hosts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "type": "proxy", "nodeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "ingressGroupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "domainNames": [ "example" ], "upstreamKind": "manual", "forwardHost": "example", "forwardPort": 1, "forwardScheme": "http", "upstreamIpv6Enabled": false, "dockerNodeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "dockerContainerName": "example", "dockerComposeProjectId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "dockerComposeServiceName": "example", "dockerDeploymentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "dockerContainerPort": 1, "dockerHostPort": 1, "dockerProtocol": "tcp", "pageProjectId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "pageTagId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "relaySpreadMode": "inherit", "relaySpreadCount": 1, "sslEnabled": false, "sslForced": false, "http2Support": true, "websocketSupport": false, "sslCertificateId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "internalCertificateId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "redirectUrl": "https://example.com", "redirectStatusCode": 301, "customHeaders": [], "cacheEnabled": false, "cacheOptions": { "maxAge": 1, "staleWhileRevalidate": 1 }, "rateLimitEnabled": false, "rateLimitMode": "inherit", "rateLimitOptions": { "requestsPerSecond": 1, "burst": 1, "connectionsPerIp": 1 }, "customRewrites": [], "advancedConfig": "example", "rawConfig": "example", "rawConfigEnabled": true, "accessListId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "folderId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "nginxTemplateId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "templateVariables": { "additionalProperty": "example" }, "healthCheckEnabled": false, "healthCheckUrl": "example", "healthCheckInterval": 1, "healthCheckExpectedStatus": 1, "healthCheckExpectedBody": "example", "healthCheckBodyMatchMode": "includes", "healthCheckSlowThreshold": 1 }'

• Your Gateway instance

Authorizations

• bearerAuth

Parameters

Header Parameters

Idempotency-Key

string

>= 1 characters <= 255 characters

Optional retry key (1-255 printable ASCII characters), bound to your token or session and its current scopes. A retry with the same key and request within 24 hours replays the original response with Idempotency-Replayed: true; a different request under the same key returns 422 IDEMPOTENCY_KEY_REUSED, a retry while the first request still runs returns 409 IDEMPOTENCY_KEY_IN_PROGRESS with Retry-After, and a completed request whose response was not stored returns 409 IDEMPOTENCY_RESPONSE_WITHHELD.

Request Body^required

JSON request body

Media typeapplication/json

object

type

string

default: proxy

Allowed values: proxy redirect 404 raw

nodeId

string format: uuid

ingressGroupId

string format: uuid

domainNames

required

Array<string>

>= 1 items

upstreamKind

string

default: manual

Allowed values: manual docker_container docker_deployment pages

forwardHost

string

>= 1 characters <= 255 characters /^[a-zA-Z0-9._-]+$/

forwardPort

integer

>= 1 <= 65535

forwardScheme

string

default: http

Allowed values: http https

upstreamIpv6Enabled

boolean

dockerNodeId

string format: uuid

dockerContainerName

string | null

>= 1 characters <= 255 characters

dockerComposeProjectId

string | null format: uuid

dockerComposeServiceName

string | null

>= 1 characters <= 255 characters

dockerDeploymentId

string format: uuid

dockerContainerPort

integer

>= 1 <= 65535

dockerHostPort

integer

>= 1 <= 65535

dockerProtocol

string

Allowed values: tcp

pageProjectId

string format: uuid

pageTagId

string format: uuid

relaySpreadMode

string

Allowed values: inherit fixed all

relaySpreadCount

integer | null

>= 1 <= 64

sslEnabled

boolean

sslForced

boolean

http2Support

boolean

default: true

websocketSupport

boolean

sslCertificateId

string format: uuid

internalCertificateId

string format: uuid

redirectUrl

string format: uri

<= 2048 characters

redirectStatusCode

Any of:

number

number

Allowed values: 301

number

number

Allowed values: 302

number

number

Allowed values: 307

number

number

Allowed values: 308

customHeaders

Array<object>

default:

object

name

required

string

>= 1 characters <= 255 characters

value

required

string

>= 1 characters <= 4096 characters

cacheEnabled

boolean

cacheOptions

object

maxAge

integer

staleWhileRevalidate

integer

rateLimitEnabled

boolean

rateLimitMode

string

default: inherit

Allowed values: inherit custom disabled

rateLimitOptions

object

requestsPerSecond

required

integer

>= 1

burst

integer

>= 1

connectionsPerIp

integer

>= 1

customRewrites

Array<object>

default:

object

source

required

string

>= 1 characters <= 1024 characters

destination

required

string

>= 1 characters <= 1024 characters

type

required

string

Allowed values: permanent temporary

advancedConfig

string

<= 10000 characters

rawConfig

string

<= 100000 characters

rawConfigEnabled

boolean

accessListId

string format: uuid

folderId

string format: uuid

nginxTemplateId

string format: uuid

templateVariables

object

key

additional properties

Any of:

string

string

number

number

boolean

boolean

healthCheckEnabled

boolean

healthCheckUrl

string

<= 500 characters /^\//

healthCheckInterval

integer

>= 5 <= 3600

healthCheckExpectedStatus

integer

>= 100 <= 599

healthCheckExpectedBody

string

<= 500 characters

healthCheckBodyMatchMode

string

Allowed values: includes exact starts_with ends_with

healthCheckSlowThreshold

integer

<= 100

Responses

201

Created

Media typeapplication/json

object

data

required

Resource object. Exact fields depend on the endpoint.

object

id

string

name

string

key

additional properties

Example

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "domainNames": [
      "app.example.com"
    ],
    "forwardHost": "10.0.0.10",
    "forwardPort": 3000,
    "enabled": true
  }
}

400

Bad request

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "VALIDATION_ERROR",
  "message": "Request validation failed",
  "details": [
    {
      "path": [
        "name"
      ],
      "message": "Required"
    }
  ]
}

401

Authentication required

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "UNAUTHORIZED",
  "message": "Authentication required"
}

403

Forbidden

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "FORBIDDEN",
  "message": "Insufficient permissions"
}

404

Not found

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "NOT_FOUND",
  "message": "Resource not found"
}

409

Conflict

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "CONFLICT",
  "message": "Resource already exists"
}

422

Unprocessable entity

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "UNPROCESSABLE_ENTITY",
  "message": "Request could not be processed"
}

500

Internal server error

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "INTERNAL_ERROR",
  "message": "Internal server error"
}