Show API Log

POST /Api/Read/Log
Authorization key & Authorization date & Authorization hmac

This process returns the log details that are available for the LogRequestId passed in with parameter LogRequestId. To store all details during a previous call, pass the key x-LogLevel with a value of 2 on the initial request, then call this process with the x-RequestID returned to get the details back. Note that RequestId values must be called with the same API Key. A week after the log record is created, extra details are removed and they are removed entirely after a month. Secret Hmac Required. No Caching unless repeated.

Body Required

  • LogRequestId number

    The previous x-RequestId call to return detailed log information.

Responses

  • 200

    API Log successfully returned

    Hide response attributes Show response attributes object
    • RequestTime string

      HTTP-formatted GMT/UTC date/time for when the API call was requested

    • Http_Host string

      The domain name used to make the call

    • Server_Name string

      The server the responded to the call. This typically will be SV plus the cloud server id.

    • Server_Addr string

      The ipv4 server address.

    • Server_Port number

      The server port used.

    • Remote_Addr string

      The ipv4 remote address.

    • Request_Scheme string

      if this was HTTP or HTTPS.

    • Request_Method string

      if this was a GET or POST call.

    • Api_Acl number

      The acl id for the call

    • Api_Function string

      the endpoint that was called.

    • Request_Url string

      The requested url to make the call. This is only stored with x-LogLevel > 1.

    • Http_User_Agent string

      The user agent text passed when making the call. This is only stored with x-LogLevel > 1.

    • Raw_Request string

      Json Encoded raw resquest information sent with the call. This is only stored with x-LogLevel > 1.

    • Response_Code number

      The HTTP response code returned to the calling program.

    • Rsponse string

      The response message returned to the calling program.

    • Bandwidth number

      Bandwidth in bytes used by the call.
POST /Api/Read/Log 
curl \
 -X POST https://Api.StrandVision.com/v1.0/Api/Read/Log \
 -H "Authorization: X-apikey $ACCESS_TOKEN" \
 -H "Authorization: X-apidate $ACCESS_TOKEN" \
 -H "Authorization: X-apihmac $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"LogRequestId":23}'
Request example 
{
  "LogRequestId": 23
}
Request examples 
{
  "LogRequestId": 23
}
Response examples (200) 
{
  "Request_Time": "Mon, 15 May 2023 14:34:17 GMT",
  "Http_Host": "DV1",
  "Server_Name": "localhost",
  "Server_Addr": "127.0.0.1",
  "Server_Port": 443,
  "Remote_Addr": "127.0.0.1",
  "Request_Scheme": "HTTPS",
  "Request_Method": "POST",
  "Api_Acl": 2,
  "Api_Function": "api/Read/Limits",
  "Request_Url": "/v1.0/Api/Read/Limits",
  "Http_User_Agent": "Mozilla/5.0 (compatible; SVDSBot/1.0; +http://www.strandvision.com/bot.html)",
  "Raw_Request": "",
  "Response_Format": "JSON",
  "Response_Code": 200,
  "Response": "{\"1Sec\":{\"Limit\":50,\"Remain\":13,\"ResetDate\":\"Mon, 15 May 2023 14:34:17 GMT\",\"TimeLeft\":\"0 Seconds\"},\"1Hour\":{\"Limit\":500,\"Remain\":174,\"ResetDate\":\"Mon, 15 May 2023 15:18:00 GMT\",\"TimeLeft\":\"43.72 Minutes\"},\"1Mon\":{\"Limit\":100000,\"Remain\":99674,\"ResetDate\":\"Thu, 15 Jun 2023 00:00:00 GMT\",\"TimeLeft\":\"1 Month\"}}",
  "Seconds": 0.0308,
  "Bandwidth": 874
}
Response examples (200) 
{
  "RequestTime": "Wed, 10 May 2023 19:11:31 GMT",
  "Http_Host": "localhost",
  "Server_Name": "SV22",
  "Server_Addr": "127.0.0.1",
  "Server_Port": 443,
  "Remote_Addr": "127.0.0.1",
  "Request_Scheme": "HTTPS",
  "Request_Method": "GET",
  "Api_Acl": 2,
  "Api_Function": "api/Read/Limits",
  "Request_Url": "v1.0/Api/Read/Limits",
  "Http_User_Agent": "Mozilla/5.0 (compatible; SVDSBot/1.0; +http://www.strandvision.com/bot.html)",
  "Raw_Request": "string",
  "Response_Code": 200,
  "Rsponse": {
    "1Mon": {
      "Limit": 100000,
      "Remain": 99674,
      "TimeLeft": "1 Month",
      "ResetDate": "Thu, 15 Jun 2023 00:00:00 GMT"
    },
    "1Sec": {
      "Limit": 50,
      "Remain": 13,
      "TimeLeft": "0 Seconds",
      "ResetDate": "Mon, 15 May 2023 14:34:17 GMT"
    },
    "1Hour": {
      "Limit": 500,
      "Remain": 174,
      "TimeLeft": "43.72 Minutes",
      "ResetDate": "Mon, 15 May 2023 15:18:00 GMT"
    }
  },
  "Bandwidth": 874
}