Logs

Get

Retrieve RAS Agent Log(s).

GET/api/Agent/logs

Query parameters

Response

200401404

Success

Request

JavaScriptCurlPython

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

Response

401404

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

Update

Update RAS Agent Log level.

PUT/api/Agent/logs

Query parameters

Body

application/json; api-version=1.0

RAS Agent Log Level

serverTypeRASLogSrvType (enum)

RAS Logging Server Type

1 = RDS,2 = Provider,3 = Gateway,7 = Broker,25 = HALBDevice,-1 = All

servernullable string

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.

logLevel*RASLogLevel (enum)

RAS Log Level

0 = Critical,1 = Error,2 = Warning,3 = Standard,4 = Extended,5 = Verbose,-1 = None

durationInSecinteger (int32)

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

Response

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/Agent/logs', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "logLevel": [
        "0 = Critical",
        "1 = Error",
        "2 = Warning",
        "3 = Standard",
        "4 = Extended",
        "5 = Verbose",
        "-1 = None"
      ]
    }),
});
const data = await response.json();

Response

401404

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

Delete

Clear RAS Agent Log(s).

DELETE/api/Agent/logs

Query parameters

Body

application/json; api-version=1.0

RAS Agent server

serverTypeRASLogSrvType (enum)

RAS Logging Server Type

1 = RDS,2 = Provider,3 = Gateway,7 = Broker,25 = HALBDevice,-1 = All

servernullable string

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.

Response

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/Agent/logs', {
    method: 'DELETE',
    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"
}