HTTP

`core.http_request`

Perform a HTTP request to a given URL.

Secrets

Optional secrets:

mtls: required values TLS_CERTIFICATE, TLS_PRIVATE_KEY.
ca_cert: required values CA_CERTIFICATE.

Inputs

method

string

required

HTTP request methodAllowed values: GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS.

url

string

required

The destination of the HTTP request

auth

map[string, string] | null

Basic auth credentials with username and password keysDefault: null.

base64_encode_data

boolean

Base64 encode the raw response body before returning. Use this for binary downloads to prevent corruption from text decoding.Default: false.

files

map[string, string | FileUploadData] | null

Files to upload using multipart/form-data. The dictionary key is the form field name. The value can be a simple base64 encoded string (filename defaults to form field name), or a dictionary with ‘filename’, ‘content_base64’, and optional ‘content_type’.Default: null.

follow_redirects

boolean

Follow HTTP redirectsDefault: false.

form_data

object | null

Form encoded data in request body (POST, PUT, and PATCH)Default: null.

headers

map[string, string] | null

HTTP request headersDefault: null.

ignore_status_codes

array[integer] | null

If specified, these status codes will not be treated as errors. Defaults to None.Default: null.

max_redirects

integer

Maximum number of redirectsDefault: 20.

params

object | null

URL query parametersDefault: null.

payload

object | array[any] | null

JSON serializable data in request body (POST, PUT, and PATCH)Default: null.

timeout

number

Timeout in secondsDefault: 10.0.

verify_ssl

boolean

Verify SSL certificates. Defaults to True, disable at own risk.Default: true.

Examples

Basic request

- ref: fetch_alert
  action: core.http_request
  args:
    url: https://api.example.com/alerts/${{ TRIGGER.alert_id }}
    method: GET
    headers:
      Authorization: Bearer ${{ SECRETS.alerts.API_TOKEN }}

`core.http_poll`

Perform a HTTP request to a given URL with optional polling.

Secrets

Optional secrets:

mtls: required values TLS_CERTIFICATE, TLS_PRIVATE_KEY.
ca_cert: required values CA_CERTIFICATE.

Inputs

method

string

required

HTTP request methodAllowed values: GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS.

url

string

required

The destination of the HTTP request

auth

map[string, string] | null

Basic auth credentials with username and password keysDefault: null.

follow_redirects

boolean

Follow HTTP redirectsDefault: false.

form_data

object | null

Form encoded data in request body (POST, PUT, and PATCH)Default: null.

headers

map[string, string] | null

HTTP request headersDefault: null.

max_redirects

integer

Maximum number of redirectsDefault: 20.

params

object | null

URL query parametersDefault: null.

payload

object | array[any] | null

JSON serializable data in request body (POST, PUT, and PATCH)Default: null.

poll_condition

string | null

Python lambda function when evaluated to True, stops polling. The function receives a dict with headers, data, and status_code fields.Default: null.

poll_interval

number | null

Interval in seconds between polling attempts. If not specified, defaults to polling with exponential wait.Default: null.

poll_max_attempts

integer

Maximum number of polling attempts. If set to 0, the action will poll indefinitely (until timeout).Default: 10.

poll_retry_codes

integer | array[integer] | null

Status codes on which the action will retry. Ignored if poll_condition is provided. If neither are specified, an error will be raised.Default: null.

timeout

number

Timeout in secondsDefault: 10.0.

verify_ssl

boolean

Verify SSL certificates. Defaults to True, disable at own risk.Default: true.

Examples

Poll until complete

- ref: wait_for_export
  action: core.http_poll
  args:
    url: https://api.example.com/exports/${{ TRIGGER.export_id }}
    method: GET
    headers:
      Authorization: Bearer ${{ SECRETS.exports.API_TOKEN }}
    poll_interval: 5
    poll_max_attempts: 24
    poll_condition: "lambda response: response['data'].get('status') == 'completed'"

`core.http_paginate`

Paginate through a HTTP response.

Inputs

method

string

required

HTTP request methodAllowed values: GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS.

next_request

string

required

Python lambda function that returns the next request as a JSON of url, method, headers, params, payload, form_data to paginate to. The function receives a dict with headers, data, and status_code fields.

stop_condition

string

required

Python lambda function that determines when pagination should STOP. The function receives a dict with headers, data, and status_code fields.

url

string

required

The destination of the HTTP request

auth

map[string, string] | null

Basic auth credentials with username and password keysDefault: null.

follow_redirects

boolean

Follow HTTP redirectsDefault: false.

form_data

object | null

Form encoded data in request body (POST, PUT, and PATCH)Default: null.

headers

map[string, string] | null

HTTP request headersDefault: null.

items_jsonpath

string | null

JSONPath expression that evaluates to the items to paginate through.Default: null.

limit

integer

Maximum number of items to paginate through. Defaults to 1000.Default: 1000.

max_redirects

integer

Maximum number of redirectsDefault: 20.

params

object | null

URL query parametersDefault: null.

payload

object | array[any] | null

JSON serializable data in request body (POST, PUT, and PATCH)Default: null.

timeout

number

Timeout in secondsDefault: 10.0.

verify_ssl

boolean

Verify SSL certificates. Defaults to True, disable at own risk.Default: true.

Examples

Follow next page links

- ref: list_findings
  action: core.http_paginate
  args:
    url: https://api.example.com/findings
    method: GET
    headers:
      Authorization: Bearer ${{ SECRETS.findings.API_TOKEN }}
    params:
      limit: 100
    items_jsonpath: $.items[*]
    stop_condition: "lambda response: response['data'].get('next_cursor') is None"
    next_request: "lambda response: {'url': 'https://api.example.com/findings', 'method': 'GET', 'headers': {'Authorization': 'Bearer ${{ SECRETS.findings.API_TOKEN }}'}, 'params': {'limit': 100, 'cursor': response['data']['next_cursor']}}"

Overview

Building automations

Building agents

Building custom actions

Self-hosting

Authentication

Audit logs

`core.http_request`

Secrets

Inputs

Examples

`core.http_poll`

Secrets

Inputs

Examples

`core.http_paginate`

Inputs

Examples

​core.http_request

​Secrets

​Inputs

​Examples

​core.http_poll

​Secrets

​Inputs

​Examples

​core.http_paginate

​Inputs

​Examples

`core.http_request`

Secrets

Inputs

Examples

`core.http_poll`

Secrets

Inputs

Examples

`core.http_paginate`

Inputs

Examples