Introduction to Igneous APIs
  • 10 Aug 2020
  • 1 Minute To Read
  • Contributors
  • Print
  • Share
  • Dark
    Light

Introduction to Igneous APIs

  • Print
  • Share
  • Dark
    Light

Igneous provides a rich set of APIs to automate various data management activities such as applying policies to an export or share, conversion of backup targets into archive targets and making data available directly to end user via a Read-Only NFS export. All available APIs are documented with use case examples for your reference.

In order to use the APIs, you will first need to obtain the instance specific API token. This is done by visiting the Igneous management page here.

Once logged in, click on the gear icon on the bottom left-hand menu and select Account Information
account_info

The API token is now visible
API_token

This token will need to be presented as part of the RESTful API call in the http header request as the "Authentication" value. For example,

curl -X POST \
   http://demo.igneous.io/x/igneous/v1/tasks \
   -H 'Authorization: B775UB6L69KN155...' \
   -H 'Content-Type: application/json' \
   -d ' { JSON body }'

Igneous provides a Postman collection bundle for ease of use. The Authorization field is pre-created for each request but you will need to edit the field with your instance's API token.

For any API command, the IP value can be found by navigating to your systems page in the UI, and retirieving the IP portion of the URL from that location. Using either port:4900 or port:80 will succeed. VM-based customer will need to use http for now, as SSL is not yet supported.
Screen Shot 2020-08-07 at 10.06.19 AM

Was This Article Helpful?