with cURL
A quick showcase of how cURL can be used to explore the various calls available on our REST API.
Last updated
Was this helpful?
A quick showcase of how cURL can be used to explore the various calls available on our REST API.
Last updated
Was this helpful?
We will here show how cURL can be used to interact with our REST API. As an example, Basic Auth will be used to authenticate a GET request that fetches a list of available projects. All available endpoints are listed in our .
Enable Basic Auth You need to have with Basic Auth enabled. Any role will suffice.
cURL is a command-line tool that can be used to easily make arbitrary HTTP requests. This includes our entire API which can be accessed via a single cURL command. Detailed information about the parameters used can be found under cURLs manpage, man curl
.
The tool comes preinstalled on most Linux and Mac systems. You can verify the install by opening your favorite shell and typing which curl
, and are otherwise readily available in most package managers.
Debian-based distributions: apt install curl
Arch-based distributions: pacman -S curl
Mac: brew install curl
Windows: The cURL client binary can be found .
The following command will fetch a list of all available projects for a Service Account.
-X <command> Specifies the HTTP request method and to which URL it is sent. The method, usually GET or POST, should be changed to accommodate the target URL.
If the valid key-id and secret of a Service Account with sufficient privileges were used, cURL should return a list of the available projects for that account to stdout.
The following command adds the label my-new-label
with value some-value
to the specified device.
-X <command> Specifies the HTTP request method and to which URL it is sent. The method, usually GET or POST, should be changed to accommodate the target URL.
-d <data> Sends the specified data in a POST request to the HTTP server.
If the valid key-id and secret of a Service Account with sufficient privileges were used, cURL should return a list of the available projects for that account to stdout.
The same response as previously now looks like the following.
-u <user:password> Specifies the user for authentication. We use a Service Account, and the key-id and secret can be found when creating the account, as explained in the .
-u <user:password> Specifies the user for authentication. We use a Service Account, and the key-id and secret can be found when creating the account, as explained in the .
cURL alone makes no attempt at formatting its output. By piping the cURL output through a command-line JSON processor like , the result is much more readable.