Retrieve API Management Logs
This page is no longer maintained (Mar 29, 2023). For the most current information, go to https://docs.snaplogic.com/public-apis/post-apim-get-api-log-org.html.
Â
POST /apim/get_api_log/{org}
Â
Overview
This API retrieves the API Management log information.
Prerequisites
Org Admin permissions
Â
Request
Path Parameters
Key | Description |
---|---|
| Required. The path to your SnapLogic pod. Example: |
| Required. The name of the SnapLogic Org. |
Query Parameters
None.
Request Header
Specify Basic
for authorization and application/json
for content type.
Request Body
Key | Type | Description |
---|---|---|
| integer | Returns log entries since the specified time. Provide time as Unix time in seconds. |
| integer | Returns log entries before the specified time. Provide time as Unix time in seconds. Default: The current time. |
The difference between start_ts
and end_ts
must be no more than one hour. Otherwise, an exception is thrown.
Response
Response Body
{
"response_map": {
"log": [
{
"log": {
"auth_type": "...",
"invoker_snode": "...",
"request_time": ...,
"roles": [],
"remote_addr": "127.0.0.1",
"processing_time": ...,
"request_status_code": ...,
"bytes_sent": null,
"client": "127.0.0.1",
"target_status_code": ...,
"request_method": "...",
"path_info": "...",
"error": ...,
"request_url": "..."
},
"time": "..."
},
...
]
},
"http_status_code": 200
}
Â
Key | Type | Description |
---|---|---|
| string | The authentication type of the request. |
| string | The ID of the Triggered Task or Ultra Task that generated the log entry. |
| integer | The time when the request was received, as Unix time in milliseconds. |
| array | The roles of the API consumer that sent the request. |
| string | The IP address of the API consumer. |
| integer | The length of time to process the request, in milliseconds. |
| integer | The HTTP response code from the authentication and validation step of the request. |
| integer | The length of the response sent to the client, in bytes. |
| string | If Basic Authentication is used with the username and password, this field contains the username. If the API is accessed using a token value in the Task setting, this field is empty. Otherwise, this field contains the IP address of the application that consumes the API. |
| integer | The HTTP response code from the Pipeline execution. |
| string | The REST API method used in the request. |
| string | Additional path information at the end of the request URL. |
| Boolean | If |
| string | The URL used in the request. |
| string | The timestamp when the request was received, in UTC format. |
Â
Have feedback? Email documentation@snaplogic.com | Ask a question in the SnapLogic Community
© 2017-2024 SnapLogic, Inc.