Get a summary of Admin Messages.

Prev Next
Get
/admin-messages/summarize

List all summarized Admin Messages generated by the system. This API call is recommended as some of the Admin Messages may be duplicated too much in case of a configuration problem on a heavy loaded system.

Security
HTTP
Type bearer
Responses
200

Summary of Admin Messages.

Expand All
object
data
Array of object
object
level
string

The severity of the Admin Message.

Valid values[ "Information", "Warning", "Error", "Critical" ]
category
string

Message category.

Valid values[ "Configuration", "Connectivity" ]
message
string

The Admin Message.

ExampleIdentity Provider "local" does not have IP Pool assigned.
sources
Array of string

The name of the Appliance(s) that generated this message.

Example[ "controller-1", "controller-2" ]
string
created
string (date-time)

When the Admin Message generated the last time.

count
number

Number of times this Admin Message was generated.

Example152.0
metadata
object
id
string

The uuid of the message metadata.

Example4c07bc67-57ea-42dd-b702-c2d6c45419fc
message
string

The message text.

ExampleIdentity Provider "local" does not have IP Pool assigned.
status
string

The status of the message.

Valid values[ "Unresolved", "Resolved", "Muted" ]
appliedAt
string (date-time)

When the message metadata was updated.

Example2020-01-01T12:00:00Z
appliedBy
string

The distinguished name of who updated the message metadata.

ExampleCN=4c07bc6757ea42ddb702c2d6c45419fc,CN=admin,OU=local
appliedByUsername
string

The username of the user who updated the message metadata.

Exampleadmin
appliedByProviderName
string

The provider name of the user who updated the message metadata.

Examplelocal
appliedByDeviceId
string (uuid)

The device ID of the user who updated the message metadata.

Example4c07bc67-57ea-42dd-b702-c2d6c45419fc
401

Token error. Login again.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

403

Insufficient permissions to access this resource.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

406

Invalid 'Accept' header.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

500

Unexpected server side error.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.