API references and example API call

API references

All API references and corresponding information can be found in the Delphix Compliance Services API page.

Example API call

1. If you have not already created a ruleset, create one with the selected sandbox/connector.

2. Generate a DCS API token by following the instructions provided in the Creating a new token section of this page. This API token will be valid for the customized lifespan.

3. Access the API references page and look for the ruleset APIs.

4. Use the API call to get all rulesets:

   curl --request GET
        --url 'https://api.apps.delphix.com/v1/compliance/rulesets'
        --header 'Authorization: Bearer <TOKEN>'
        --header 'Content-Type: application/json'
   

5. Find the UUID of the ruleset you just created.

6. Use the API call to get all rules in the ruleset:

   curl --request GET
        --url 'https://api.apps.delphix.com/v1/compliance/rulesets/<UUID>/rules?page_size=1000&page_number=1'
        --header 'Authorization: Bearer <TOKEN>'
        --header 'Content-Type: application/json'
   

7. Continue calling the API for all pages.