Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Localtabgroup
Localtab
activetrue
titleRequest
Localtabgroup
Localtab
activetrue
titleSuccessful invocation
Code Block
{
   “archiveFileUrl” : “https://link-to-archive-file”,
   “validPeriodInSeconds” : 300
}
Localtab
titleUnsuccessful invocations
Code Block
{
 "message": "2019-04/08 is an invalid date format. Valid format is year-month-day (yyyy-mm-dd) Pacific Standard Time"
}
Code Block{ "message": "load-balance is an invalid 'logType' value. Valid values are : [load-balancer, gateway]" }
HTTP request methodGET
URL

https://gateway.api.cloud.wso2.com/api/logs?logType=<log-type>&date=

yyyy

<yyyy-mm-

dd
Headers

Content-Type: application/json
Authorization: Bearer <Bearer token received by following prerequisites>

Localtab
titleResponse

dd>

The following table describes the valid logType and date values that you can pass in the URL:

ParameterValid values
logType

Either load-balancer or gateway.

dateThe current date or a prior date in the

yyyy-mm-dd format. For example, 2019-03-20.

Note
titleNote

You should not specify a future date. Specifying a future date will result in an unsuccessful invocation.

Headers

Content-Type: application/json
Authorization: Bearer <Bearer token received by following prerequisites>

Localtab
titleResponse
Localtabgroup
Localtab
activetrue
titleSuccessful invocation
Code Block
{
  "message": "Logs are not available for the specified type : load-balancer and date : 2019-04-07"
}
Code Block
{
  "message": "An internal server error occurred during the log retrieval process"
}
Code Block
{
 “archiveFileUrl” : “https://link-to-archive-file”,
   “validPeriodInSeconds” : 300
}
Localtab
titleUnsuccessful invocation
Code Block
{
 "message": "Unauthorized<An user.error Usermessage mustdescribing havethe adminreason privilegesthat tocaused invokean the log download API"unsuccesful invocation>
}


REST APIs that can be invoked with a subscriber access token

...