Important Update: Cohesity Products Documentation

All Cohesity product documentation are now managed via the Cohesity Docs Portal: https://docs.cohesity.com/HomePage/Content/home.htm. Some documentation available here may not reflect the latest information or may no longer be accessible.

Veritas Access Getting Started Guide

Last Published:
Product(s): Access (7.4.2)
Platform: Linux

Using the Veritas Access RESTful APIs

You can use the Veritas Access RESTful APIs using the cURL command. You need to be authenticated first and then use the returned token in subsequent requests.

To use the Veritas Access RESTful APIs

  1. Make sure that the Veritas Access GUI is running on the host.
    When you execute the Veritas Access RESTful APIs, you have to provide
the host name and the port on which the Veritas Access GUI is running. 
By default, the GUI runs on port 14161.
  2. Authenticate the user.
    curl --cookie-jar /tmp/cookies/cookies.txt -g -k -X 
POST -d "username=username&
password=password" https://hostname:port/api/rest/authenticate
    username Username of the host on which the Veritas Access GUI 
is running. 
password Password of the host where the Veritas Access GUI 
is running.
    The call returns a token.
  3. Use the returned token and cookie.
  4. Call the RESTful API.
    curl--cookie /tmp/cookies/cookies.txt hostname:port/resturl 
-g -k -header "Authorization: Bearer token"
    hostname Host name on which the Veritas Access GUI is running.
port Port on which the Veritas Access GUI is running.
resturl URL for the RESTful API.
token Token that is returned in step 2.

    Example:

    You want to call the API to get all the disks available in the cluster.
curl --cookie /tmp/cookies/cookies.txt
https://10.182.197.183:14161/api/storage/getrecords -g -k --header "Authorization:
Bearer
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJjYWZjNmFhZTIyNzEiLCJpYXQiOjE0NzAyNz
k3ODh9.P2CTswezKv-n6wNQTSmSsePC0YBAHRI_VPWF_69yI3o"