In this guide:
Description
This API endpoint can be used to get counts of currenlty held messages for each hold reason. Hold reasons can reference policy actions or definition names.
Pre-requisites
- In order to successfully use this endpoint the logged in user must be a Mimecast administrator with at least the Account | Monitoring | Held Summary | Read permission.
URI
To use this endpoint you send a POST request to:
- /api/gateway/get-hold-summary-list
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,
|
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,
|
Request Body
{
"data": []
}
data
Field | Type | Required | Description |
---|
Response
{
"fail": [],
"meta": {
"status": 200
},
"data": [
{
"policyInfo": "String",
"numberOfItems": "Number"
}
]
}
meta object
Field | Type | Description |
---|---|---|
status | Number | The function level status of the request. |
meta
Field | Type | Description |
---|---|---|
status | Number | The function level status of the request. |
data
Field | Type | Description |
---|---|---|
policyInfo | String | The name of the policy or definition that held a message |
numberOfItems | Number | The number of messages currently held for this reason |
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/gateway/get-hold-summary-list
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":[
{
"data":[]
}
]
}