Creating REST Output Connector
Outputs an event to a REST API. This output connector can also be used as an alerting system.
- On the Data Source tab, select Output > Rest in the Connector drop-down list.
- Define or select the following properties:
Property Description Authentication Type
-
Basic
Enter the URL of the REST API. Then enter the User Id and the Password that will be used to the connect to the REST API.
-
OAuth
Then enter the following settings:
-
Token URL – The URL to retrieve the access token from.
-
Token Request Body – The request body used for access token requests.
-
Add Access Token To - The Access token retrieved from the Token URL can be added to headers, URL or request body, depending on how the REST endpoint needs the token.
-
Request Header - A header is automatically added to the REST API request.
-
Request URL - The URL needs to be manually parameterised with a {access_token} parameter, before calling the REST API, the parameter is replaced with the actual token.
-
Request Body - The Request Body needs to be manually parameterised with a {access_token} parameter, before calling the REST API, the parameter is replaced with the actual token.
-
-
-
URL – The URL of the REST API.
HTTP Method
Select the appropriate HTTP method for the request from the following options:
-
GET – retrieve data
-
POST – add new data
-
PUT – replace existing data
-
DELETE – remove existing data
Timeout
The length of time to wait for the server response (10 to 300). Default is 10.
Content Type
The required Content Type. Default is application/json.
Request Body
The Request Body for HTTP POST.
-
- Click
. The new data source is added in the Data Sources list.
(c) 2013-2024 Altair Engineering Inc. All Rights Reserved.