Create a managed Additional Route

POST

/api/proxy-hosts/{id}/additional-routes

curl --request POST \
  --url https://gateway.example.com/api/proxy-hosts/550e8400-e29b-41d4-a716-446655440000/additional-routes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "path": "example", "enabled": true, "targetKind": "manual", "targetType": "manual", "target": { "additionalProperty": "example" }, "forwardHost": "example", "forwardPort": 1, "forwardScheme": "http", "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", "advancedConfig": "example", "stripPrefix": false, "websocketSupport": false, "requestBuffering": true, "responseBuffering": true, "connectTimeoutSeconds": 60, "readTimeoutSeconds": 60, "sendTimeoutSeconds": 60 }'

• Your Gateway instance

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string

>= 1 characters

Example

550e8400-e29b-41d4-a716-446655440000

Request Body^required

JSON request body

Media typeapplication/json

object

path

required

string

enabled

boolean

default: true

targetKind

string

Allowed values: manual docker_container docker_deployment pages

targetType

string

Allowed values: manual docker_container docker_deployment pages

target

object

key

additional properties

forwardHost

string

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

forwardPort

integer

>= 1 <= 65535

forwardScheme

string

default: http

Allowed values: http https

dockerNodeId

string format: uuid

dockerContainerName

string

>= 1 characters <= 255 characters

dockerComposeProjectId

string format: uuid

dockerComposeServiceName

string

>= 1 characters <= 255 characters

dockerDeploymentId

string format: uuid

dockerContainerPort

integer

>= 1 <= 65535

dockerHostPort

integer

>= 1 <= 65535

dockerProtocol

string

default: tcp

Allowed values: tcp

pageProjectId

string format: uuid

pageTagId

string format: uuid

advancedConfig

string | null

<= 10000 characters

stripPrefix

boolean

websocketSupport

boolean

requestBuffering

boolean

default: true

responseBuffering

boolean

default: true

connectTimeoutSeconds

integer

default: 60 >= 1 <= 3600

readTimeoutSeconds

integer

default: 60 >= 1 <= 3600

sendTimeoutSeconds

integer

default: 60 >= 1 <= 3600

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"
}