POST /v2/macros
Creates a new macro.
Servers
- https://api.au.sumologic.com/api/
- https://api.ca.sumologic.com/api/
- https://api.de.sumologic.com/api/
- https://api.eu.sumologic.com/api/
- https://api.fed.sumologic.com/api/
- https://api.jp.sumologic.com/api/
- https://api.kr.sumologic.com/api/
- https://api.in.sumologic.com/api/
- https://api.sumologic.com/api/
- https://api.us2.sumologic.com/api/
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
definition |
String | Yes |
The definition of the macro. Use a valid Sumo Log Search expression. |
macroCreationSuggestionId |
String | No |
Identifier if the suggestion comes from an macro creation suggestion. This id is used to track macro creation suggestions, and to delete the suggestion once the macro is created. |
name |
String | Yes |
Name of the macro. |
description |
String | No |
Description of the macro. |
arguments[] |
Array | No |
Arguments used in the macro. |
arguments[].name |
String | Yes |
Argument name for the macro. |
arguments[].type |
String | No |
The type of the macro. Default value: "String" |
enabled |
Boolean | No |
If the macro is enabled or not (default True) Default value: true |
argumentValidations[] |
Array | No |
Validation expressions for the arguments. |
argumentValidations[].errorMessage |
String | Yes |
Error message to be shown if the macro argument validation fails. |
argumentValidations[].evalExpression |
String | Yes |
The expression to validate a macro argument. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.