Sites

List

Retrieve the list of all the available Sites.

GET/api/Site

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 site.

licensingSiteboolean

Whether this is a licensing site or not.

enableHttpHostAttackProtectionboolean

Whether Http Host Attack protection is enabled for this site or not.

Request

JavaScriptCurlPython

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

Response

200401404

[
  {
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2024-11-07T07:26:29.648Z",
    "timeLastMod": "2024-11-07T07:26:29.648Z",
    "name": "text",
    "licensingSite": false,
    "enableHttpHostAttackProtection": false
  }
]

Create

Add a new site to the RAS farm.

POST/api/Site

Query parameters

Body

application/json; api-version=1.0

The Site to be created

server*nullable string

The target server FQDN or IP address.

namenullable string

The name you want to use for the new site.

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 site.

licensingSiteboolean

Whether this is a licensing site or not.

enableHttpHostAttackProtectionboolean

Whether Http Host Attack protection is enabled for this site or not.

Request

JavaScriptCurlPython

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

Response

201401409

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T07:26:29.648Z",
  "timeLastMod": "2024-11-07T07:26:29.648Z",
  "name": "text",
  "licensingSite": false,
  "enableHttpHostAttackProtection": false
}

Get

Retrieve a Site.

GET/api/Site/{id}

Path parameters

id*integer (int32)

ID of the Site to be retrieved

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 site.

licensingSiteboolean

Whether this is a licensing site or not.

enableHttpHostAttackProtectionboolean

Whether Http Host Attack protection is enabled for this site or not.

Request

JavaScriptCurlPython

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

Response

200401404

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T07:26:29.648Z",
  "timeLastMod": "2024-11-07T07:26:29.648Z",
  "name": "text",
  "licensingSite": false,
  "enableHttpHostAttackProtection": false
}

Update

Modify the Site properties.

PUT/api/Site/{id}

Path parameters

id*integer (int32)

ID of the Site to be updated

Body

application/json; api-version=1.0

The Site to be updated

namenullable string

A new name to assign to the site.

enableHttpHostAttackProtectionnullable boolean

Whether Http Host Attack protection is enabled for this site or not.

Response

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/Site/{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

Delete a Site from the RAS farm.

DELETE/api/Site/{id}

Path parameters

id*integer (int32)

ID of the Site to be deleted

Response

204401404

No Content

Request

JavaScriptCurlPython

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

Response

401404

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