Skip to main content


api [get|post|put|patch|delete|head] [url]
api get [url]
api post [url] --data [json]
api put [url] --data [json]
api patch [url] --data [json]
api delete [url]

Constructs and sends an http request.



The HTTP method (GET, POST, PUT, PATCH, DELETE, HEAD). (type: string)


The url for the request. (type: string)



api get


api post --data '{"bobby": "billy"}'


api put --data '{"bobby": "billy"}'


api patch --data '{"bobby": "billy"}'


api delete



Used to append the results from a previous stage to the current stage. (provide a label, stage index, or boolean true to append the previous results)


bearer authentication (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. The name “Bearer authentication” can be understood as “give access to the bearer of this token.” The bearer token is a cryptic string, usually generated by the server in response to a login request.


A boolean value of true/false that determines whether or not to use the cache. Generally most commands will default to true.


Format: "{CHECKPOINT NAME}:{COLUMN}" Used to store the value of the provided column (in the first row of results) in the provided name for use as a checkpoint in scheduled queries or other stages. Can be accessed using $CHECKPOINTS.{CHECKPOINT NAME}$


Provider reference stored in vault. Contains the provider and auth related information. Signs the HTTP request following the AWS Signature Version 4 specification.


Provider reference stored in vault. Contains the provider and auth related information.


data to send in the body of the request


Enriches each result row with the previous row. The previous columns will be appended with a _previous.


A filter to run on the command results before completing the command. If not provided, no filter is run on the results.


Starts the stage as if it was a fresh query, so will not use any previous result.


Adds a populated random guid column.


headers to send in the request


Used to label a stage with a user provided label.


Override for the system max concurrent workers for a stage.


If enabled, will allow for pagination (one api command will make multiple requests according to the pagination strategy described in pagination flags)


If the request is a POST operation and pagination is handled through the post body, the --pagination.dataKey flag is the key to add to the post data payload, where the value will be the value contained in the flag


Maximum number of pages visited

The location within the results set describing the location of the next set of results. If not a complete URL, use the --pagination.url to construct the url using a token


The url of the next set of results, which can include a token to substitute in the value selected by If blank, the url is assumed to be contained in the value described by


params to send in the query string for the request


The URI for a http, https, socks(v5), socks5, socks4, or pac proxy


include request data


include response data


The serializer to use on response data. 'auto' (default) - Automatically serialize based on the response content-type.

jsonapplication/jsonJSON parse the response text and serialize the response content as a JSON string.
xmlapplication/xmlXML parse the response text and serialize to JSON format.
csvtext/csvCSV parse the response text and serialize to JSON format.
yamlapplication/x-yamlYAML parse the response text and serialize to JSON format.
texttext/plainSerialize the response content as a utf8 string assigned to a content attribiute (e.g., { content: <String> }).


Controls if a stats calculation is run on a stage after it completes.


A comma separated list of columns to include in the command results. If not provided, all columns will be included.


sets the bearer authentication header (see --bearer) and propogates the token.access_token value to results


The User-Agent request header is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent. <>


will skip SSL cert verification if set to false


Will rerun the stage until the provided expression is valid for the first line of results.