Custom Routes

List

Retrieve information about one or multiple custom routes.

GET/api/CustomRoutes
Query parameters
Response

Success

Body
idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

namenullable string

Name of the Custom Route

siteIdinteger (int32)

Site ID

descriptionnullable string

Description of the Custom Route

publicAddressnullable string

Public Address of the Custom Route

portinteger (int32)

Port of the Custom Route

sslPortinteger (int32)

SSL Port of the Custom Route

Request
const response = await fetch('/api/CustomRoutes', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
[
  {
    "id": 0,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2025-01-08T17:48:22.459Z",
    "timeLastMod": "2025-01-08T17:48:22.459Z",
    "name": "text",
    "siteId": 0,
    "description": "text",
    "publicAddress": "text",
    "port": 0,
    "sslPort": 0
  }
]

Create

Create a new custom route.

POST/api/CustomRoutes
Body

Custom route settings

name*nullable string

The name of the Custom Route.

siteIdinteger (int32)

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.

descriptionnullable string

A user-defined Custom Route description.

publicAddress*nullable string

Public Address of the Custom Route

portinteger (int32)

Port of the Custom Route. Default: 80

sslPortinteger (int32)

SSL Port of the Custom Route. Default: 443

Response

Created

Body
idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

namenullable string

Name of the Custom Route

siteIdinteger (int32)

Site ID

descriptionnullable string

Description of the Custom Route

publicAddressnullable string

Public Address of the Custom Route

portinteger (int32)

Port of the Custom Route

sslPortinteger (int32)

SSL Port of the Custom Route

Request
const response = await fetch('/api/CustomRoutes', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "name": "text",
      "publicAddress": "text"
    }),
});
const data = await response.json();
Response
{
  "id": 0,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-01-08T17:48:22.459Z",
  "timeLastMod": "2025-01-08T17:48:22.459Z",
  "name": "text",
  "siteId": 0,
  "description": "text",
  "publicAddress": "text",
  "port": 0,
  "sslPort": 0
}

Get

Retrieve information about one custom route by ID.

GET/api/CustomRoutes/{id}
Path parameters
id*integer (int32)

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

Response

Success

Body
idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

namenullable string

Name of the Custom Route

siteIdinteger (int32)

Site ID

descriptionnullable string

Description of the Custom Route

publicAddressnullable string

Public Address of the Custom Route

portinteger (int32)

Port of the Custom Route

sslPortinteger (int32)

SSL Port of the Custom Route

Request
const response = await fetch('/api/CustomRoutes/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "id": 0,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-01-08T17:48:22.459Z",
  "timeLastMod": "2025-01-08T17:48:22.459Z",
  "name": "text",
  "siteId": 0,
  "description": "text",
  "publicAddress": "text",
  "port": 0,
  "sslPort": 0
}

Update

Modify properties of a custom route.

PUT/api/CustomRoutes/{id}
Path parameters
id*integer (int32)

The ID of the custom route to modify.

Body

Custom route settings

namenullable string

The new name of the Custom Route.

descriptionnullable string

A user-defined Custom Route description.

publicAddressnullable string

Public Address of the Custom Route

portnullable integer (int32)

Port of the Custom Route

sslPortnullable integer (int32)

SSL Port of the Custom Route

Response

No Content

Request
const response = await fetch('/api/CustomRoutes/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();
Response
{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}

Delete

Remove a custom route from a site.

DELETE/api/CustomRoutes/{id}
Path parameters
id*integer (int32)

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

Response

No Content

Request
const response = await fetch('/api/CustomRoutes/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();
Response
{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}

Last updated

Other Resources

Feedback

© 2024 Parallels International GmbH. All rights reserved.