Skip to content

Latest commit

 

History

History
222 lines (175 loc) · 5.1 KB

API.md

File metadata and controls

222 lines (175 loc) · 5.1 KB
Raw

Shimenawa API Details

This document will provide endpoints available inside Shimenawa

Contents

Authentication

None (Left blank intentionally for flexibility).

APIs

Root

Gets root document describing major api endpoints/links.

Operation

GET /api/v1

Request

No request parameters required.

Response

Returns a root document.

Content type: application/hal+json

Response Status
-  200 (successful)
Response sample
{
  "_links": {
    "self": {
      "href": "http://localhost:5311/api/v1"
    },
    "create_request": {
      "href": "http://localhost:5311/api/v1/requests",
      "title": "Create Sumo Log Search Request",
      "type": "application/json"
    },
    "request_id": {
      "href": "http://localhost:5311/api/v1/requests{?request_uuid}",
      "templated": true
    }
  }
}

Create Request

Creates a Sumo Log Search Request.

Operation

POST /api/v1/requests

Request

Request body contains the details for the search job request.

- `query` : sumo logic query string
- `from` : start date time to analyze. The format should be ISO 8601.
- `to` : end date time to analyze. The format should be ISO 8601.
- `callback_endpoint`(optional) : POST api endpoint to receive notification if request search is finished.

Content type: application/json

Request Sample
{
  "query": "b490ab294b0f0838",
  "from": "2016-09-06T00:00:10Z",
  "to": "2016-09-07T23:59:59Z",
  "callback_endpoint" : "http://abc.xyz.com/api/v1/request_search"
}
Response

Returns a HAL document that contains the request uuid and request parameters.

Content type: application/hal+json

Response Status
- 201 (for successful creation of request)
- 200 (if same request parameters are found in Shimenawa DB)
- 400 (for invalid request body, comes with an error message)
Response sample
{
  "request_uuid": "00000000-0000-0000-0000-000000000012",
  "query": "b490ab294b0f0838",
  "from": "2016-09-06T00:00:10Z",
  "to": "2016-09-07T23:59:59Z",
  "callback_endpoint" : "http://abc.xyz.com/api/v1/request_search",
  "_links": {
    "self": {
      "href": "http://localhost:5311/api/v1/requests/00000000-0000-0000-0000-000000000012"
    }
  }
}

Get Request

Gets full information about a request.

Operation

GET /api/v1/requests{/?request_uuid}

Request Query Parameter
- `request_uuid` : request uuid.
Response

Returns a HAL document of the request.

Content type: application/hal+json

Response Status
- 200 (for successful fetch)
- 404 (request not found)
Response sample
{
  "request_uuid": "00000000-0000-0000-0000-000000000012",
  "query": "b490ab294b0f0838",
  "from": "2016-09-06T00:00:10Z",
  "to": "2016-09-07T23:59:59Z",
  "success": true,
  "status_message": "Done",
  "request_time": "2016-09-07T23:59:59Z",
  "completed_request_time": "2016-09-08T00:01:00Z",
  "apps": [],
  "exceptionApps": [],
  "callback_endpoint" : "http://abc.xyz.com/api/v1/request_search",
  "_links": {
    "self": {
      "href": "http://localhost:5311/api/v1/requests/00000000-0000-0000-0000-000000000012"
    },
    "logs": {
      "href": "http://localhost:5311/api/v1/requests/00000000-0000-0000-0000-000000000012/logs"
    }
  }
}

Get Logs

Get Logs of a request.

Operation

GET /api/v1/requests{/?request_uuid}/logs

Request Query Parameter
- `request_uuid` : request uuid.
Response

Returns a json array that lists logs for the request.

Content type: application/json

Response Status
- 200 (for successful fetch)
- 404 (request not found)
Response sample
[
	{ "timestamp": "01", "message": "help" },
	{ "timestamp": "02", "message": "exception"  }
]

Notification

Callback Notification

After request is done and callback_endpoint is specified, Shimenawa will POST the request information through the specified callback_endpoint

Operation

POST {callback_endpoint}

Request

Remote endpoint should be expecting this Request body that contains the details for the Sumo Log search request.

Content type: application/hal+json

Request Sample
{
  "request_uuid": "00000000-0000-0000-0000-000000000012",
  "query": "b490ab294b0f0838",
  "from": "2016-09-06T00:00:10Z",
  "to": "2016-09-07T23:59:59Z",
  "success": true,
  "status_message": "Done",
  "request_time": "2016-09-07T23:59:59Z",
  "completed_request_time": "2016-09-08T00:01:00Z",
  "apps": [],
  "exceptionApps": [],
  "callback_endpoint" : "http://abc.xyz.com/api/v1/request_search",
  "_links": {
    "self": {
      "href": "http://localhost:5311/api/v1/requests/00000000-0000-0000-0000-000000000012"
    },
    "logs": {
      "href": "http://localhost:5311/api/v1/requests/00000000-0000-0000-0000-000000000012/logs"
    }
  }
}
Response

Response must be 200 (OK) to consider it as successful.