Custom Routes

List

get

Retrieve information about one or multiple custom routes.

Query parameters

SiteIdinteger · int32Optional

Site ID from which to retrieve the custom route information (optional).

NamestringOptional

The name of the custom route for which to retrieve the information.

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

/api/CustomRoutes

HTTPcURLJavaScriptPython

GET /api/CustomRoutes HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": 1,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2025-12-19T15:43:42.418Z",
    "timeLastMod": "2025-12-19T15:43:42.418Z",
    "enabled": true,
    "name": "text",
    "siteId": 1,
    "description": "text",
    "publicAddress": "text",
    "port": 1,
    "sslPort": 1
  }
]

Create

post

Create a new custom route.

Body

application/json; api-version=1.0

Create a new Custom Route

namestring | nullableRequired

The name of the Custom Route.

siteIdinteger · int32Optional

Site ID in which to add the specified Custom Route. If the parameter is omitted, the site ID of the Licensing Server will be used.

enabledbooleanOptional

Whether Custom Route is enabled or not

descriptionstring | nullableOptional

A user-defined Custom Route description.

publicAddressstring | nullableRequired

Public Address of the Custom Route

portinteger · int32Optional

Port of the Custom Route. Default: 80

sslPortinteger · int32Optional

SSL Port of the Custom Route. Default: 443

Responses

201

Created

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

/api/CustomRoutes

HTTPcURLJavaScriptPython

POST /api/CustomRoutes HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 106

{
  "name": "text",
  "siteId": 1,
  "enabled": true,
  "description": "text",
  "publicAddress": "text",
  "port": 1,
  "sslPort": 1
}

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-12-19T15:43:42.418Z",
  "timeLastMod": "2025-12-19T15:43:42.418Z",
  "enabled": true,
  "name": "text",
  "siteId": 1,
  "description": "text",
  "publicAddress": "text",
  "port": 1,
  "sslPort": 1
}

Get

get

Retrieve information about one custom route by ID.

Path parameters

idinteger · int32Required

The ID of a custom route for which to retrieve the information.

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

/api/CustomRoutes/{id}

HTTPcURLJavaScriptPython

GET /api/CustomRoutes/{id} HTTP/1.1
Host: 
Accept: */*

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-12-19T15:43:42.418Z",
  "timeLastMod": "2025-12-19T15:43:42.418Z",
  "enabled": true,
  "name": "text",
  "siteId": 1,
  "description": "text",
  "publicAddress": "text",
  "port": 1,
  "sslPort": 1
}

Update

put

Modify properties of a custom route.

Path parameters

idinteger · int32Required

The ID of the custom route to modify.

Body

application/json; api-version=1.0

Update a Custom Route settings

enabledboolean | nullableOptional

Whether Custom Route is enabled or not

namestring | nullableOptional

The new name of the Custom Route.

descriptionstring | nullableOptional

A user-defined Custom Route description.

publicAddressstring | nullableOptional

Public Address of the Custom Route

portinteger · int32 | nullableOptional

Port of the Custom Route

sslPortinteger · int32 | nullableOptional

SSL Port of the Custom Route

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

/api/CustomRoutes/{id}

HTTPcURLJavaScriptPython

PUT /api/CustomRoutes/{id} HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 95

{
  "enabled": true,
  "name": "text",
  "description": "text",
  "publicAddress": "text",
  "port": 1,
  "sslPort": 1
}

No content

Delete

delete

Remove a custom route from a site.

Path parameters

idinteger · int32Required

The ID of a custom route to remove from the site.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

/api/CustomRoutes/{id}

HTTPcURLJavaScriptPython

DELETE /api/CustomRoutes/{id} HTTP/1.1
Host: 
Accept: */*

No content