Skip to content

API Integration

Ryan Thomas edited this page Oct 13, 2023 · 2 revisions

Integrating the Command Center with the Stormcloud API

Base URLs and Endpoints

All interaction with the Stormcloud API should be done through HTTPS requests. The base URL for the API is: https://www2.darkage.io:8443/api/. Any additional API endpoints will be added after the base URL.

For example, for the API endpoint queue-file-for-restore, the full URL used is https://www2.darkage.io:8443/api/queue-file-for-restore.

HTTP GET vs. POST

HTTPS requests can use a variety of "verbs", chiefly among them are GET and POST. Most of the Stormcloud API endpoints are HTTPS POST requests. With POST requests, parameters can be specified in the body of the request, whereas GET requests generally feature parameters solely passed in the URL itself.

API Endpoints for SCC Integration

queue-file-for-restore [POST]

Request parameters (must be formatted as an application/json):

  • api_key - the API key associated with the customer
  • agent_id - the Agent ID associated with the device in question
  • file_path - the full POSIX path to the file on the client's machine. i.e. E:/DarkAge/Stormcloud/Test/file.txt

Clone this wiki locally