Get Logs for a Device
get
/api/config/ViewConfigs/readView
Gets the logs for the device specified by either the configuration collection name or the configuration collection ID.
Request
Query Parameters
-
ConfigCollectionID(required): integer
The configuration collection ID. Provide either ConfigCollectionName or ConfigCollectionID, but not both.Example:
1001
-
ConfigCollectionName(required): string
The configuration collection name. Provide either ConfigCollectionName or ConfigCollectionID, but not both.Example:
SSH Actions
-
limit: integer(int32)
The number of records to limit results by.Example:
100
-
start: integer(int32)
The page of results to start from.Default Value:
0
Example:1
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulGetOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Loaded 1 entries
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object
-
data: array
data
The logs for the specified device.
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : configViewConfigsReadView
Type:
Show Source
object
-
CommitDate: string
Commit DateExample:
2023-03-15 10:59:09
-
Message: string
Message showing details like configuration changesExample:
Config Mgr Commit
-
Revision: integer
Revision IDExample:
2340
-
Username: string
UsernameExample:
admin
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
errors: array
errors
The list of errors reported. Validation errors will be keyed by record field.
-
message: string
The response message.Example:
Exception thrown
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
false
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object