Get HTTP Access Log Entries
GET/homes/{homeId}/httpLogEntries
Base URL: https://api.tinkermode.com
Get HTTP access log entries for home.
Authentication
Send an Authorization header of the form ModeCloud <AUTH_CODE>.
Must contain the API key of a user or service account with permissions to read home logs or a Project API Key.
Path parameters
| Name | Type | Required | Constraints | Description |
|---|---|---|---|---|
homeId | integer | Yes | The unique ID for a specified home. |
Query parameters
| Name | Type | Required | Constraints | Description |
|---|---|---|---|---|
begin | string | Yes | Return entries bound by this timestamp. Format must conform to RFC3339. | |
end | string | Yes | Return entries bound by this timestamp. Format must conform to RFC3339. | |
maxEntries | integer | No | Limit the number of entries returned. |
Responses
200
Content type: application/json
Entry in an HTTP access log.
An array of objects with the following shape:
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
clientIp | string | No | read-only (server-generated) | IP address of caller. |
latency | integer | No | read-only (server-generated) | Elapsed time of call in nanoseconds. |
method | string | No | read-only (server-generated) | HTTP method. |
path | string | No | read-only (server-generated) | URI path of HTTP request. |
statusCode | integer | No | read-only (server-generated) | Returned status code of HTTP request. |
timestamp | string | No | read-only (server-generated); format: date-time | Timestamp of entry creation. |
401 Authorization is required to access this resource.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
403 Request failed because of denied permission.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
429 Request failed because of rate limit.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
500 An unexpected error has occurred.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
503 The service is temporarily unavailable.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |