GET api/Logs

Returns all log entries. Only 100 log entries can be returned at a time. The following OData query options are allowed: $filter, $orderby, $select, $skip, $top.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of LogEntry
NameDescriptionTypeAdditional information
Id

The ID of the log entry.

globally unique identifier

Required

Category

The category of the log entry. Where: 6 is "AddCommunicationKey"; 7 is "UpdateCommunicationKey"; 8 is "DeleteCommunicationKey"; 9 is "AddKeySeed"; 10 is "UpdateKeySeed"; 11 is "DeleteKeySeed".

byte

Required

Timestamp

The date when the log entry was added (in the ISO 8601 format).

date

Required

ManagementKeyId

The ID of the management key that produced this log entry.

globally unique identifier

None.

RequestUrl

The URL of the request that produced this log entry.

string

None.

RequestBody

The body of the request that produced this log entry.

string

None.

Status Codes

All HTTP status codes must be expected, but the following status codes are the most probable:

  • OK (200) - All found log entries are successfully returned.
  • BadRequest (400) - The OData query is invalid.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": "b4ebd6b0-b352-41cf-8044-28ef5e1ad348",
    "Category": 64,
    "Timestamp": "2024-10-02T17:12:37.2868077+00:00",
    "ManagementKeyId": "2e55285f-30d2-457e-a643-8e5f16edb5c1",
    "RequestUrl": "sample string 4",
    "RequestBody": "sample string 5"
  },
  {
    "Id": "b4ebd6b0-b352-41cf-8044-28ef5e1ad348",
    "Category": 64,
    "Timestamp": "2024-10-02T17:12:37.2868077+00:00",
    "ManagementKeyId": "2e55285f-30d2-457e-a643-8e5f16edb5c1",
    "RequestUrl": "sample string 4",
    "RequestBody": "sample string 5"
  }
]