Custom Routes

List

Retrieve information about one or multiple custom routes.

GET/api/CustomRoutes

Query parameters

Response

200401404

Success

Body

application/json; api-version=1.0

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

JavaScriptCurlPython

const response = await fetch('/api/CustomRoutes', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

[
  {
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2024-11-07T07:42:27.895Z",
    "timeLastMod": "2024-11-07T07:42:27.895Z",
    "name": "text",
    "description": "text",
    "publicAddress": "text"
  }
]

Create

Create a new custom route.

POST/api/CustomRoutes

Body

application/json; api-version=1.0

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

201401409

Created

Body

application/json; api-version=1.0

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

JavaScriptCurlPython

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

201401409

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T07:42:27.895Z",
  "timeLastMod": "2024-11-07T07:42:27.895Z",
  "name": "text",
  "description": "text",
  "publicAddress": "text"
}

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

200401404

Success

Body

application/json; api-version=1.0

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

JavaScriptCurlPython

const response = await fetch('/api/CustomRoutes/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T07:42:27.895Z",
  "timeLastMod": "2024-11-07T07:42:27.895Z",
  "name": "text",
  "description": "text",
  "publicAddress": "text"
}

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

application/json; api-version=1.0

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

204401404

No Content

Request

JavaScriptCurlPython

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

401404

{
  "type": "text",
  "title": "text",
  "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

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/CustomRoutes/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

401404

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}