V-Spark Online Help

Using the /status API with cURL

The cURL utility makes it easy to test using the V‑Spark API by providing a command-line mechanism for invoking APIs such as the /status API. The next few sections provide examples of using the GET method with the /status API from the command line via the cURL command.

If you are unfamiliar with the cURL command, see Using cURL for REST API Testing for a short introduction and an explanation of how cURL examples are displayed. See Tips for Debugging and Managing cURL Calls for suggestions about how to debug and manage cURL calls.

An example of a cURL command to retrieve status information from from the company "DocTestCo," organization "DocTestCo-DocTesting," folder "Test01" on the host example.company.com is the following:

curl -s 'http://example.company.com/status/DocTestCo/DocTestCo-DocTesting/Test01 \
    ?token=01234567890123456789012345678901'    

To produce this same output in CSV format, execute a command like the following instead:

curl -s 'http://example.company.com/status/DocTestCo/DocTestCo-DocTesting/Test01 \
    ?format=csv&token=01234567890123456789012345678901'    

To produce this output in a more legible format, and to write that output to the file log.out, you could execute a command like the following:

curl -s 'http://example.company.com/status/DocTestCo/DocTestCo-DocTesting/Test01 \
    ?token=012345678901234567890123456789012' | \
    python -m json.tool > log.out