Logs

PreviousAgents NextDiagnostics

Was this helpful?

Get

get

Retrieve RAS Agent Log(s).

Query parameters

serverstringoptional

RAS Agent Server name

siteIdinteger · int32optional

Site ID of the specified server.

serverTypestring · enumoptional

RAS Logging Server Type

Available options:

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/Agent/logs'

200

401

404

No Content

Success

Update

put

Update RAS Agent Log level.

Query parameters

serverstringoptional

RAS Agent Server name

siteIdinteger · int32optional

Site ID of the specified server

serverTypestring · enumoptional

RAS Logging Server Type

Available options:

Body

Update the Log Level of an Agent

serverTypestring · enumoptional

RAS Logging Server Type

Available options:

serverstring | nullableoptional

The name of the RAS agent server. The name can be either FQDN or IP address, but you have to enter the actual name this server has in the RAS farm.

logLevelstring · enumrequired

RAS Log Level

Available options:

durationInSecinteger · int32optional

RAS Log Level Duration The duration before the log level is reset back to Standard level (in seconds). Only applies for 'Extended' and 'Verbose' levels (Default: 43200 (12 hours), Max: 259200 (72 hours), Never: 0).

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/Agent/logs' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "serverType": [
      "1 = RDS",
      "2 = Provider",
      "3 = Gateway",
      "7 = Broker",
      "25 = HALBDevice",
      "-1 = All"
    ],
    "server": "text",
    "logLevel": [
      "0 = Critical",
      "1 = Error",
      "2 = Warning",
      "3 = Standard",
      "4 = Extended",
      "5 = Verbose",
      "-1 = None"
    ],
    "durationInSec": 1
  }'

204

401

404

No Content

Delete

delete

Clear RAS Agent Log(s).

Query parameters

serverstringoptional

RAS Agent Server name

siteIdinteger · int32optional

Site ID of the specified server

serverTypestring · enumoptional

RAS Logging Server Type

Available options:

Body

RAS Agent log

serverTypestring · enumoptional

RAS Logging Server Type

Available options:

serverstring | nullableoptional

The name of the RAS agent server. The name can be either FQDN or IP address, but you have to enter the actual name this server has in the RAS farm.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/Agent/logs' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "serverType": [
      "1 = RDS",
      "2 = Provider",
      "3 = Gateway",
      "7 = Broker",
      "25 = HALBDevice",
      "-1 = All"
    ],
    "server": "text"
  }'

204

401

404

No Content