bmc-ade-http-pull plug-in
This plug-in is an extension of the http_pull plug-in that you can use to pull data from REST APIs.
Plug-in parameters
The following table lists the parameters and their usage:
Parameter | Description | Mandatory |
|---|---|---|
@type | Specify the type of plug-in. For this plug-in, the type is bmc_ade_http_pull. Type: String | Yes |
tag | Specify the tag name. Type: String | Yes |
url | Specify the URL of the remote server. Type: String | Yes |
agent | Specify the user agent details. Type: String Default: bmc-ade-http-pull | No |
interval | Specify the time interval between periodic requests. You can specify the time interval in terms of seconds, minutes, hours, or days. Type: time Example interval 1s interval 24h | Yes |
format | Specify the response body format. | Yes |
status_only | Specify whether to parse the request body. Set one of the following values:
Type: Boolean Default: False | No |
http_method | Specify the http request method. You can set one of the following values:
If the status_only parameter is set to true, the http_method value is set to head by default. Type: enum Default: get | No |
timeout | Specify the timeout of each request. Type: time Default: 10s | No |
proxy | Specify the HTTP proxy URL to use for requests. You can choose to send your requests through the proxy server. Type: string Default: Nil | No |
user | Specify the user details. This parameter applies to the HTTP basic authentication type. Type: string Default: Nil | No |
password | Specify the password for the specified user. This parameter applies to the HTTP basic authentication type. Type: string Default: Nil | No |
payload | Specify the payload of the post request. Type: string Default: Nil | No |
response_header | Specify the name of the response header. If you want to monitor the response header along with the response body, provide the name of header in response_header sections. Type: section Default: Nil | No |
request_header | Specify the name-value pair of the custom request header. Type: section Default: Nil | No |
verify_ssl | Specify whether to confirm the SSL verification. Set one of the following values: true: Apply SSL verification. false: Skip SSL verification. Type: Boolean Default: true | No |
ca_path | Specify the absolute path of the directory where the ca_file is stored. Use this parameter with ca_file. Type: String Default: Nil Note: If your infrastructure has https endpoints secured by a self-signed certification, you can provide the custom certification file by using the ca_path and ca_file parameters. | No |
ca_file | Specify the name of the ca_file stored in the directory path specified in the ca_path directory. Type: String Default: Nil | No |
Related topic