Custom Routes
Retrieve information about one or multiple custom routes.
Site ID from which to retrieve the custom route information (optional).
The name of the custom route for which to retrieve the information.
GET /api/CustomRoutes HTTP/1.1
Host:
Accept: */*
[
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-06-30T21:31:53.053Z",
"timeLastMod": "2025-06-30T21:31:53.053Z",
"name": "text",
"siteId": 1,
"description": "text",
"publicAddress": "text",
"port": 1,
"sslPort": 1
}
]Create a new custom route.
Create a new Custom Route
The name of the Custom Route.
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.
A user-defined Custom Route description.
Public Address of the Custom Route
Port of the Custom Route. Default: 80
SSL Port of the Custom Route. Default: 443
POST /api/CustomRoutes HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 91
{
"name": "text",
"siteId": 1,
"description": "text",
"publicAddress": "text",
"port": 1,
"sslPort": 1
}{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-06-30T21:31:53.053Z",
"timeLastMod": "2025-06-30T21:31:53.053Z",
"name": "text",
"siteId": 1,
"description": "text",
"publicAddress": "text",
"port": 1,
"sslPort": 1
}Retrieve information about one custom route by ID.
The ID of a custom route for which to retrieve the information.
GET /api/CustomRoutes/{id} HTTP/1.1
Host:
Accept: */*
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-06-30T21:31:53.053Z",
"timeLastMod": "2025-06-30T21:31:53.053Z",
"name": "text",
"siteId": 1,
"description": "text",
"publicAddress": "text",
"port": 1,
"sslPort": 1
}Modify properties of a custom route.
The ID of the custom route to modify.
Update a Custom Route settings
The new name of the Custom Route.
A user-defined Custom Route description.
Public Address of the Custom Route
Port of the Custom Route
SSL Port of the Custom Route
PUT /api/CustomRoutes/{id} HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 80
{
"name": "text",
"description": "text",
"publicAddress": "text",
"port": 1,
"sslPort": 1
}No content
Remove a custom route from a site.
The ID of a custom route to remove from the site.
DELETE /api/CustomRoutes/{id} HTTP/1.1
Host:
Accept: */*
No content
Last updated
Was this helpful?