Skip to main content

curl

curl -X POST|GET|PUT|DELETE [url] -H "Content-Type: application/json" -d '{"login":"my_login","password":"my_password"}'

Curl stands for client URL, it is a free command-line tool for transferring files with URL syntax. The curl implementation in crul is a small subset of the most common HTTP tasks performed with curl. See the api for a full featured HTTP client.

arguments:

Url

The URL syntax is protocol-dependent. You find a detailed description in RFC 3986. (type: string)

flags:

--appendStage

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)

--basic

This option is purely a pass-thru, see --user for details on HTTP Basic authentication.

--cache

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

--checkpoint

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. Not encrypted. Can be accessed using $CHECKPOINTS.{CHECKPOINT NAME}$

--cookies

Sends the specified cookie as a cookie header in the HTTP request. The cookie string can be in the format "name=content", which will be sent as a cookie header, or in the Netscape format.

--data

Sends the specified data in a POST request to the HTTP server.

--filter

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

--guid

Adds a populated random guid column.

--head

Fetch the headers only!

--header

Extra header to include in information sent.

--json

(HTTP) Sends the specified JSON data in a POST request to the HTTP server. --json works as a shortcut for passing on these three options: --data [arg] --header "Content-Type: application/json" --header "Accept: application/json"

--labelStage

Used to label a stage with a user provided label.

--location

If the server reports that the requested page has moved to a different location (indicated with a Location: header and a 3XX response code), this option will redo the request on the new place.

--oauth2-bearer

Specify the Bearer Token for OAUTH 2.0 server authentication.

--pagination.argIndex

The index of the argument to store the pagination context.

--pagination.argKey

The key to store the pagination context in the argument (assumes key value is JSON).

--pagination.done

The value of pagination.next thats indicates that pagination is complete.

--pagination.filter

Filter the results using a filter expression.

--pagination.flag

The flag to store the pagination context.

--pagination.flagKey

The key to store the pagination context in the flag (assumes key value is JSON).

--pagination.max

Maximum number of pages visited.

--pagination.next

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

--pagination.url

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

--randomizeHash

Randomizes the stage hash, even if args and flags are the same.

--referer

Sends the "Referrer Page" information to the HTTP server.

--request

(HTTP) Specifies a custom request method to use when communicating with the HTTP server. The specified request method will be used instead of the method otherwise used (which defaults to GET). Read the HTTP 1.1 specification for details and explanations.

--stats

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

--table

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

--type

Each command has a default type, either "mapping" or "reducing". Some commands can operate as either, when "reducing" they will operate on all rows at once, when "mapping", they will operate on one row at a time.

--url

URL to work with.

--user

Specify the user name and password to use for server authentication split up on the first colon.

--variable

Format: "{VARIABLE 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 variable in other stages. Can be accessed using $VARIABLES.{VARIABLE NAME}$. Stored as an encrypted secret. Not stored across queries.

--verbose

Makes curl verbose during the operation. Useful for debugging and seeing what's going on "under the hood".

support

AMI_ENTERPRISE AMI_FREE AMI_PRO BINARY_ENTERPRISE BINARY_FREE BINARY_PRO DESKTOP_ENTERPRISE DESKTOP_FREE DESKTOP_PRO DOCKER_ENTERPRISE DOCKER_FREE DOCKER_PRO