Remote Syslogs

API used to manage remote syslog on the Appliance

List remote syslogs

get/appliances/{id}/remotesyslogs
Request
path Parameters
id
required
integer <int64>

Appliance ID

query Parameters
cursor
string
Default: ""

String value pointing to the next page of results after the last request.

limit
integer <int32>
Default: 10

Limits the number of objects returned per page.

header Parameters
api-version
required
string

API Version, e.g. v1

Value: "v1"
Responses
200

OK

401

Unauthorized

403

Forbidden

404

The appliance is not found, or it does not support this API.

Response samples
application/json
{
  • "totalCount": 0,
  • "next": "string",
  • "remotesyslogs": [
    ]
}

Create remote syslog

post/appliances/{id}/remotesyslogs
Request
path Parameters
id
required
integer <int64>

Appliance ID

header Parameters
api-version
required
string

API Version, e.g. v1

Value: "v1"
Request Body schema: application/json

Configuration of remote syslog

certificateName
string

certificate name

enabled
boolean

enabled

host
string

host name of the syslog server

port
integer <int32>

port of the syslog server

Responses
201

Created

401

Unauthorized

403

Forbidden

404

The appliance is not found, or it does not support this API.

409

Remote syslog already exists for the appliance

Request samples
application/json
{
  • "host": "string",
  • "port": 0,
  • "certificateName": "string",
  • "enabled": true
}
Response samples
application/json
{
  • "id": 0,
  • "host": "string",
  • "port": 0,
  • "certificateName": "string",
  • "enabled": true,
  • "status": "string",
  • "message": "string"
}

Get remote syslog configuration

get/appliances/{id}/remotesyslogs/{remoteSyslogId}
Request
path Parameters
id
required
integer <int64>

Appliance ID

remoteSyslogId
required
integer <int64>

Remote Syslog ID, currently always 1

header Parameters
api-version
required
string

API Version, e.g. v1

Value: "v1"
Responses
200

OK

401

Unauthorized

403

Forbidden

404

The appliance is not found, or it does not support this API.

Response samples
application/json
{
  • "id": 0,
  • "host": "string",
  • "port": 0,
  • "certificateName": "string",
  • "enabled": true,
  • "status": "string",
  • "message": "string"
}

Update remote syslog configuration

post/appliances/{id}/remotesyslogs/{remoteSyslogId}
Request
path Parameters
id
required
integer <int64>

Appliance ID

remoteSyslogId
required
integer <int64>

Remote Syslog ID, currently always 1

header Parameters
api-version
required
string

API Version, e.g. v1

Value: "v1"
Request Body schema: application/json

Configuration of remote syslog

certificateName
string

certificate name

enabled
boolean

enabled

host
string

host name of the syslog server

port
integer <int32>

port of the syslog server

Responses
200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

Request samples
application/json
{
  • "host": "string",
  • "port": 0,
  • "certificateName": "string",
  • "enabled": true
}
Response samples
application/json
{
  • "id": 0,
  • "host": "string",
  • "port": 0,
  • "certificateName": "string",
  • "enabled": true,
  • "status": "string",
  • "message": "string"
}

Delete remote syslog configuration

delete/appliances/{id}/remotesyslogs/{remoteSyslogId}
Request
path Parameters
id
required
integer <int64>

Appliance ID

remoteSyslogId
required
integer <int64>

Remote Syslog ID, currently always 1

header Parameters
api-version
required
string

API Version, e.g. v1

Value: "v1"
Responses
204

No Content

401

Unauthorized

403

Forbidden

404

The appliance is not found, or it does not support this API.