Custom Routes | Parallels REST API

Parallels REST API

Products Support Partners Documentation

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

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/CustomRoutes/{id}'

200

401

404

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-04-06T01:09:28.094Z",
  "timeLastMod": "2025-04-06T01:09:28.094Z",
  "name": "text",
  "siteId": 1,
  "description": "text",
  "publicAddress": "text",
  "port": 1,
  "sslPort": 1
}

Success

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

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/CustomRoutes/{id}'

204

401

404

No Content

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

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/CustomRoutes'

200

401

404

[
  {
    "id": 1,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2025-04-06T01:09:28.094Z",
    "timeLastMod": "2025-04-06T01:09:28.094Z",
    "name": "text",
    "siteId": 1,
    "description": "text",
    "publicAddress": "text",
    "port": 1,
    "sslPort": 1
  }
]

Success

Create

post

Create a new custom route.

Body

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.

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

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/CustomRoutes' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "name": "text",
    "siteId": 1,
    "description": "text",
    "publicAddress": "text",
    "port": 1,
    "sslPort": 1
  }'

201

401

409

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-04-06T01:09:28.094Z",
  "timeLastMod": "2025-04-06T01:09:28.094Z",
  "name": "text",
  "siteId": 1,
  "description": "text",
  "publicAddress": "text",
  "port": 1,
  "sslPort": 1
}

Created

Update

put

Modify properties of a custom route.

Path parameters

idinteger · int32required

The ID of the custom route to modify.

Body

Update a Custom Route settings

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

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/CustomRoutes/{id}' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "name": "text",
    "description": "text",
    "publicAddress": "text",
    "port": 1,
    "sslPort": 1
  }'

204

401

404

No Content