Rules

Get

get

Retrieve a rule from the Rule List of a session server with the specified ID.

Path parameters

idinteger · int32Required

The ID of a session server for which to retrieve the Rule settings.

ruleIdinteger · int32Required

The ID of the Rule to retrieve.

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

/api/PubItems/{id}/Rules/{ruleId}

HTTPcURLJavaScriptPython

GET /api/PubItems/{id}/Rules/{ruleId} HTTP/1.1
Host: 
Accept: */*

{
  "id": 1,
  "priority": 1,
  "enabled": true,
  "name": "text",
  "description": "text",
  "criteria": {
    "securityPrincipals": {
      "enabled": true,
      "matchingMode": [
        "0 = IsNotOneOfTheFollowing",
        "1 = IsOneOfTheFollowing"
      ],
      "members": [
        {
          "account": "text",
          "type": [
            "1 = User",
            "2 = Group",
            "3 = ForeignSecurityPrincipal",
            "4 = Computer"
          ],
          "sid": "text"
        }
      ]
    },
    "gateways": {
      "enabled": true,
      "matchingMode": [
        "0 = IsNotOneOfTheFollowing",
        "1 = IsOneOfTheFollowing"
      ],
      "members": [
        {
          "gatewayIP": "text"
        }
      ]
    },
    "oSs": {
      "enabled": true,
      "matchingMode": [
        "0 = IsNotOneOfTheFollowing",
        "1 = IsOneOfTheFollowing"
      ],
      "allowedOSes": {
        "chrome": true,
        "android": true,
        "webClient": true,
        "iOS": true,
        "linux": true,
        "mac": true,
        "wyse": true,
        "windows": true
      }
    },
    "iPs": {
      "enabled": true,
      "matchingMode": [
        "0 = IsNotOneOfTheFollowing",
        "1 = IsOneOfTheFollowing"
      ],
      "allowedIPs": {
        "iPv4s": [
          {
            "from": "text",
            "to": "text"
          }
        ],
        "iPv6s": [
          {
            "from": "text",
            "to": "text"
          }
        ]
      }
    },
    "hardwareIDs": {
      "enabled": true,
      "matchingMode": [
        "0 = IsNotOneOfTheFollowing",
        "1 = IsOneOfTheFollowing"
      ],
      "members": [
        {
          "hardwareID": "text"
        }
      ]
    },
    "access": [
      "0 = DenyCriteriaWhen",
      "1 = AllowCriteriaWhen"
    ],
    "devices": {
      "enabled": true,
      "matchingMode": [
        "0 = IsNotOneOfTheFollowing",
        "1 = IsOneOfTheFollowing"
      ],
      "members": [
        {
          "client": "text"
        }
      ]
    },
    "themes": {
      "enabled": true,
      "matchingMode": [
        "0 = IsNotOneOfTheFollowing",
        "1 = IsOneOfTheFollowing"
      ],
      "ids": [
        1
      ]
    }
  }
}

Update

put

Update a rule within the Rule List of a session server with the specified ID.

Path parameters

idinteger · int32Required

The ID of a session server for which to modify the Rule settings.

ruleIdinteger · int32Required

The ID of the Rule to retrieve.

Body

application/json; api-version=1.0

Add a rule to the Rule list

enabledboolean | nullableOptional

Whether the rule will be enabled or disabled.

ruleNamestring | nullableOptional

The modified name of the rule.

descriptionstring | nullableOptional

The modified description of the rule.

prioritystring · enumOptional

Move Direction.

Possible values:

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

/api/PubItems/{id}/Rules/{ruleId}

HTTPcURLJavaScriptPython

PUT /api/PubItems/{id}/Rules/{ruleId} HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 88

{
  "enabled": true,
  "ruleName": "text",
  "description": "text",
  "priority": [
    "0 = Up",
    "1 = Down"
  ]
}

No content

Remove

delete

Remove a rule from the Rule List of a session server with the specified ID.

Path parameters

idinteger · int32Required

The ID of a session server for which to modify the Rule settings.

ruleIdinteger · int32Required

The ID of the Rule to remove.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

/api/PubItems/{id}/Rules/{ruleId}

HTTPcURLJavaScriptPython

DELETE /api/PubItems/{id}/Rules/{ruleId} HTTP/1.1
Host: 
Accept: */*

No content

List

get

Retrieve the Rule List of a session server with the specified ID.

Path parameters

idinteger · int32Required

The ID of a session server for which to retrieve the Rule settings.

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

/api/PubItems/{id}/Rules

HTTPcURLJavaScriptPython

GET /api/PubItems/{id}/Rules HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": 1,
    "priority": 1,
    "enabled": true,
    "name": "text",
    "description": "text",
    "criteria": {
      "securityPrincipals": {
        "enabled": true,
        "matchingMode": [
          "0 = IsNotOneOfTheFollowing",
          "1 = IsOneOfTheFollowing"
        ],
        "members": [
          {
            "account": "text",
            "type": [
              "1 = User",
              "2 = Group",
              "3 = ForeignSecurityPrincipal",
              "4 = Computer"
            ],
            "sid": "text"
          }
        ]
      },
      "gateways": {
        "enabled": true,
        "matchingMode": [
          "0 = IsNotOneOfTheFollowing",
          "1 = IsOneOfTheFollowing"
        ],
        "members": [
          {
            "gatewayIP": "text"
          }
        ]
      },
      "oSs": {
        "enabled": true,
        "matchingMode": [
          "0 = IsNotOneOfTheFollowing",
          "1 = IsOneOfTheFollowing"
        ],
        "allowedOSes": {
          "chrome": true,
          "android": true,
          "webClient": true,
          "iOS": true,
          "linux": true,
          "mac": true,
          "wyse": true,
          "windows": true
        }
      },
      "iPs": {
        "enabled": true,
        "matchingMode": [
          "0 = IsNotOneOfTheFollowing",
          "1 = IsOneOfTheFollowing"
        ],
        "allowedIPs": {
          "iPv4s": [
            {
              "from": "text",
              "to": "text"
            }
          ],
          "iPv6s": [
            {
              "from": "text",
              "to": "text"
            }
          ]
        }
      },
      "hardwareIDs": {
        "enabled": true,
        "matchingMode": [
          "0 = IsNotOneOfTheFollowing",
          "1 = IsOneOfTheFollowing"
        ],
        "members": [
          {
            "hardwareID": "text"
          }
        ]
      },
      "access": [
        "0 = DenyCriteriaWhen",
        "1 = AllowCriteriaWhen"
      ],
      "devices": {
        "enabled": true,
        "matchingMode": [
          "0 = IsNotOneOfTheFollowing",
          "1 = IsOneOfTheFollowing"
        ],
        "members": [
          {
            "client": "text"
          }
        ]
      },
      "themes": {
        "enabled": true,
        "matchingMode": [
          "0 = IsNotOneOfTheFollowing",
          "1 = IsOneOfTheFollowing"
        ],
        "ids": [
          1
        ]
      }
    }
  }
]

Add

post

Add an Rule to the Rule List of a session server with the specified ID.

Path parameters

idinteger · int32Required

The ID of a session server for which to modify the Rule settings.

Body

application/json; api-version=1.0

Add a rule to the Rule list

enabledbooleanOptional

Whether the new rule will be enabled or disabled.

ruleNamestring | nullableRequired

The name of the rule to add to the Criteria.

descriptionstring | nullableOptional

Description for the new rule.

Responses

201

Created

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

/api/PubItems/{id}/Rules

HTTPcURLJavaScriptPython

POST /api/PubItems/{id}/Rules HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 55

{
  "enabled": true,
  "ruleName": "text",
  "description": "text"
}

No content