Connection Brokers

List

Retrieve information about a list of RAS Connection Broker servers.

GET/api/Broker

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.

servernullable string

Server name.

enabledboolean

Whether the server is enabled or not.

descriptionnullable string

Description of the server.

siteIdinteger (int32)

ID of the site.

priorityinteger (int32)

Priority of the specified RAS Connection Broker.

ipnullable string

IP address of RAS Connection Broker.

alternativeIPsnullable string

Alternative IPs to access the RAS Connection Broker.

standbyboolean

Whether the RAS Connection Broker is in standby mode or not.

markedForDeletionboolean

Whether the RAS Connection Broker is marked for deletion or not.

Request

JavaScriptCurlPython

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

Response

200401404

[
  {
    "id": 0,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2024-12-21T14:17:05.976Z",
    "timeLastMod": "2024-12-21T14:17:05.976Z",
    "server": "text",
    "enabled": false,
    "description": "text",
    "siteId": 0,
    "priority": 0,
    "ip": "text",
    "alternativeIPs": "text",
    "standby": false,
    "markedForDeletion": false
  }
]

Create

Add a new RAS Connection Broker server to a site. The agent software will be installed on the server by default. You can optionally skip the agent installation by including the noInstall parameter.

POST/api/Broker

Query parameters

Body

application/json; api-version=1.0

RAS Connection Broker server

server*nullable string

FQDN or IP address of the server to add to a site as a RAS Connection Broker.

siteIdinteger (int32)

Site ID to which to add the RAS Connection Broker server. If the parameter is omitted, the Licensing Server site ID will be used.

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.

servernullable string

Server name.

enabledboolean

Whether the server is enabled or not.

descriptionnullable string

Description of the server.

siteIdinteger (int32)

ID of the site.

priorityinteger (int32)

Priority of the specified RAS Connection Broker.

ipnullable string

IP address of RAS Connection Broker.

alternativeIPsnullable string

Alternative IPs to access the RAS Connection Broker.

standbyboolean

Whether the RAS Connection Broker is in standby mode or not.

markedForDeletionboolean

Whether the RAS Connection Broker is marked for deletion or not.

Request

JavaScriptCurlPython

const response = await fetch('/api/Broker', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "server": "text"
    }),
});
const data = await response.json();

Response

201401409

{
  "id": 0,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-12-21T14:17:05.976Z",
  "timeLastMod": "2024-12-21T14:17:05.976Z",
  "server": "text",
  "enabled": false,
  "description": "text",
  "siteId": 0,
  "priority": 0,
  "ip": "text",
  "alternativeIPs": "text",
  "standby": false,
  "markedForDeletion": false
}

Get

Retrieve a specific Connection Broker by ID.

GET/api/Broker/{id}

Path parameters

id*integer (int32)

RAS Connection Broker server ID

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.

servernullable string

Server name.

enabledboolean

Whether the server is enabled or not.

descriptionnullable string

Description of the server.

siteIdinteger (int32)

ID of the site.

priorityinteger (int32)

Priority of the specified RAS Connection Broker.

ipnullable string

IP address of RAS Connection Broker.

alternativeIPsnullable string

Alternative IPs to access the RAS Connection Broker.

standbyboolean

Whether the RAS Connection Broker is in standby mode or not.

markedForDeletionboolean

Whether the RAS Connection Broker is marked for deletion or not.

Request

JavaScriptCurlPython

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

Response

200401404

{
  "id": 0,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-12-21T14:17:05.976Z",
  "timeLastMod": "2024-12-21T14:17:05.976Z",
  "server": "text",
  "enabled": false,
  "description": "text",
  "siteId": 0,
  "priority": 0,
  "ip": "text",
  "alternativeIPs": "text",
  "standby": false,
  "markedForDeletion": false
}

Update

Modify settings of a RAS Connection Broker server. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.

PUT/api/Broker/{id}

Path parameters

id*integer (int32)

RAS Connection Broker server ID

Body

application/json; api-version=1.0

RAS Connection Broker server

enablednullable boolean

Enable or disable the specified RAS Connection Broker.

descriptionnullable string

A user-defined RAS Connection Broker description.

ipnullable string

An IP address of the RAS Connection Broker server.

alternativeIPsnullable string

A list of alternative IP addresses separated by a comma.

standbynullable boolean

Set the specified RAS Secondary Connection Broker in Standby (or vice versa).

Response

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/Broker/{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",
  "status": 0,
  "detail": "text",
  "instance": "text"
}

Delete

Delete a RAS Connection Broker server from a site. The RAS Connection Broker server will be uninstalled from the server by default. You can optionally keep it by including the noUninstall parameter.

DELETE/api/Broker/{id}

Path parameters

id*integer (int32)

RAS Connection Broker server ID

Query parameters

Response

204401404

No Content

Request

JavaScriptCurlPython

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

Response

401404

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