Programmatic Access to Fortanix Key Insight APIs

1.0 Introduction

This guide provides examples and use cases for using Fortanix Key Insight APIs to automate key discovery, risk assessment, and compliance operations.

2.0 Prerequisites

Before using the Fortanix Key Insight APIs, ensure that you have obtained an access token as described in the Programmatic Access to Fortanix Armor IAM.

3.0 Example - Retrieve an AWS Assessment Report

After obtaining the access token, you can use it to make authorized REST API requests.

For example, to retrieve an AWS assessment report from Fortanix Key Insight, use the following REST API request:

curl -X GET \ 'https://api.armor.fortanix.com/api/v1/discovery/scans/{scan_id}/assessment_report/aws' \
  -H 'X-Csrf-Header;' \
  -H "Authorization: Bearer ${access_token}"

Here,

• Replace scan_id with the relevant scan identifier. To obtain the Scan ID, use one of the following methods:

  • REST API: Get the Scan ID from the /api/v1/discovery/scans API response (scan_id field).

  • User interface (UI):

    1. Navigate to the Fortanix Key Insight Overview page.

    2. Select the required connection. For example, AWS connection.

    3. Open the Developer Tools → Network and locate the request for scans?filter.

    4. Under the Response tab, retrieve the scan_id from the JSON response.

       

• Replace access_token with the access token you obtained earlier.

4.0 Additional Use Cases

In addition to retrieving assessment reports, the Fortanix Key Insight REST APIs can be used to automate broader discovery and assessment operations, including:

• Retrieving all configured connection details.

• Retrieving all created policies and their details.

• Retrieving all configured authentication details.

• Retrieving information for each scan of a specific connection.

• Retrieving detailed information for each connection, including:

  • Discovery information for all assets, including keys, resources, cryptographic assets, and certificates.

  • Overview and assessment reports.

  • Post Quantum Cryptography (PQC) readiness details.

5.0 Fortanix Key Insight REST APIs

For detailed information on Fortanix Armor and Fortanix Key Insight REST APIs, refer to the Fortanix Armor API documentation.