Description

The latest channel token will return the most recent set of events, minimizing the historical event ingestion. This is useful when getting started with an event stream, and you do not want to pull extensive historical logs.

Pre-requisites

  • In order to successfully use this endpoint the logged in user must be a Mimecast administrator with at least the Event Steaming Service | Event Streaming | Read permission.

URI

To use this endpoint you send a POST request to:

  • /api/ess/get-latest-channel-token

Request Headers

The following request headers must be included in your request:

Field Description
Authorization Please see the Authorization guide for more information on building the Authorization header.
x-mc-req-id

A randomly generated GUID, for example,

8578FCFC-A305-4D9A-99CB-F4D5ECEFE297
x-mc-app-id The Application ID provided with your Registered API Application.
x-mc-date

The current date and time in the following format, for example,

Tue, 24 Nov 2015 12:50:11 UTC

Request Body

{
"data": [
{
"channelId": "B8Y43U-GYVS-WHAU6M"
}
]
}
Data
Field Type Required Description
channelId String Required The channel ID of the logs to retrieve. This ID can be configured and found in the Mimecast Administration Console: Administration / Services / API and Platform Integrations / Event Channels.

Response

{
"fail": [],
"meta": {
"status": 200
},
"data": [
{
"channelId": "LJVbe8oI57N8gX9YernAz2-bZ_U37IUygUcT32hb8n2"
}
]
}
meta
Field Type Description
status Number The function level status of the request.
data
Field Type Description
channelId String The most recent channel ID token.

Sample Code

Sample code is provided to demonstrate how to use the API and is not representative of a production application. To use the sample code; complete the required variables as described, populate the desired values in the request body, and execute in your favorite IDE.  Please see the Global Base URL's page to find the correct base URL to use for your account.

POST {base_url}/api/ess/get-latest-channel-token
Authorization: MC {accesskKey}:{Base64 encoded signed Data To Sign}
x-mc-date: {dateTime}
x-mc-req-id: {unique id}
x-mc-app-id: {applicationId}
Content-Type: application/json
Accept: application/json
{
"data": [
{
"channelId": "B8Y43U-GYVS-WHAU6M"
}
]
}
Back to Top