cURL

cURL is a command-line tool and application library used to transfer data to or from a server. It uses URL syntax, such as HTTP and HTTPS. All API requests sent to a Vertica server must be made using HTTPS. A request made using HTTP will fail.

There are four HTTP requests that can be passed using cURL to call API methods:

Request Description
GET

Retrieves data.

PUT

Updates data.

POST

Creates new data.

DELETE

Deletes data.

Syntax

curl https://<NODE>:5444/

Options

-h --help

Lists all available command-line options.

-H --header

Allows you to use custom headers in your command. This is useful for sending a request that requires a VerticaAPIKEY.

curl -H "VerticaApiKey: ValidAPIKey" https://<NODE>:5444/
					
-k --insecure

Allows SSL connections without certificate validation.

curl -k https://<NODE>:5444/
						
-X --request

Specifies the custom request used when communicating with a server.

curl -X REQUEST https://<NODE>:5444/
						

Can be one of the following values:

  • GET
  • PUT
  • POST
  • DELETE

If no request is specified, cURL automatically defaults to the GET request.

There are many more options available to add to your cURL query. For a comprehensive list with descriptions, visit the cURL Documentation Website.