ShadowControl Report API

Using the ShadowControl Report API requires experience with the following:

• Making HTTP requests in a RESTful environment
• Programming or scripting skills and text parsing
• JSON-formatted output

Important! Arcserve does not support any of these processes and provides this content solely on an AS-IS basis.

The ShadowControl Report API lets third-parties request endpoint report data from the ShadowControl appliance for external use. Report data is available in two ways:

• Historical Data: /api/reports/history/
• Current Status: /api/reports/status/

When ShadowControl receives a request, it then:

• Filters the data based on the access credentials provided in the request.
• Sorts these results by organization then by each site in that organization.

Note: Arcserve recommends using Tokens to provide access to the ShadowControl Report API. For more information, see Creating Tokens. For example, a curl request for a status report data might look like the following:

curl -v -k -H "CMD_TOKEN:<Token>" https://<;appliance>/api/reports/status/<UUID of endpoint>/

where:

• -v is an option to show verbose errors,
• -k is an option to allow a connection to an appliance that does not have a trusted cert.
• -H CMD_TOKEN <token> is a required argument which adds the access token to the request header.
• Note: The quote marks are optional, as the marks are only required when there's a space in the string.
• <UUID of endpoint> is an option to indicate which endpoint data to return. Without this option, ShadowControl responses with data on all endpoints subscribed to the appliance.