Logs

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

Possible values:
Responses
200
Success
get
GET /api/Agent/logs HTTP/1.1
Host: 
Accept: */*

No content

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

Possible values:
Body

Update the Log Level of an Agent

serverTypestring · enumOptional

RAS Logging Server Type

Possible values:
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

Possible values:
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
204
No Content
put
PUT /api/Agent/logs HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 241

{
  "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
}

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

Possible values:
Body

RAS Agent log

serverTypestring · enumOptional

RAS Logging Server Type

Possible values:
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
204
No Content
delete
DELETE /api/Agent/logs HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 113

{
  "serverType": [
    "1 = RDS",
    "2 = Provider",
    "3 = Gateway",
    "7 = Broker",
    "25 = HALBDevice",
    "-1 = All"
  ],
  "server": "text"
}

No content

Was this helpful?