Get Log Entries

GET/users/{userId}/logEntries

Base URL: https://api.tinkermode.com

Get debug and error log entries for user.

Authentication

Send an Authorization header of the form ModeCloud <AUTH_CODE>.

Must contain API key of the matching user, or the API key of a user with permissions to read user logs, or a service account token with the matching permission, or a Project API Key with admin permission.

Path parameters

NameTypeRequiredConstraintsDescription
userIdintegerYesThe unique ID for the specified user.

Query parameters

NameTypeRequiredConstraintsDescription
beginstringYesReturn entries bound by this timestamp. Format must conform to RFC3339.
endstringYesReturn entries bound by this timestamp. Format must conform to RFC3339.
maxEntriesintegerNoLimit the number of entries returned.

Responses

200

Content type: application/json

Entry in a general-purpose log.

An array of objects with the following shape:

PropertyTypeRequiredConstraintsDescription
callerobjectNoInformation about the caller (id, type, display name, sudoer).
levelintegerNoread-only (server-generated)Log level of entry.
sourcestringNoSource from where the message was generated.
textstringNoread-only (server-generated)Text of log message.
timestampstringNoread-only (server-generated); format: date-timeTimestamp of entry creation.

401 Authorization is required to access this resource.

Content type: application/json

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

403 Request failed because of denied permission.

Content type: application/json

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

429 Request failed because of rate limit.

Content type: application/json

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

500 An unexpected error has occurred.

Content type: application/json

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

503 The service is temporarily unavailable.

Content type: application/json

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.