Skip to main content

Cyware Fusion and Threat Response

Configure Open API

CFTR allows you to integrate with other applications using the REST API protocol. To integrate with other applications and access the features using an API, you must have the appropriate API credentials for secure information exchange. Open API enables you to generate and manage the API credentials to authorize information exchange. The API credentials are a combination of API URL, Access ID, and Secret Key.

Generate Open API Credentials

To generate the open API credentials, do the following:

Note

Your user group must have Create/Update permission for Open API.

  1. Go to Admin Panel > Open APIs.

  2. Click Add New API at the top-right.

  3. Enter the following details:

    • API Title: Enter a unique title for the Open API.

    • API Description: Enter a description for the Open API.

    • API Expiration Date: Enter an expiry date for the Open API keys.

      Note

      Cyware recommends you to enter an expiry date for all Open APIs, else the Open API keys never expire.

    • Status: Toggle the status to Active.

    • Associated User: Select a user to assign the permissions of the user to the Open API.

      Note

      Users who are marked as bot users in User Management can be selected as the associated users.

  4. Click Create.

  5. Click Download Keys to download the API credentials in CSV format. You can also click Copy to copy the API URL, Secret Key, or Access ID.

The format of the API URL is https://<cftr-domain>/cftrapi/openapi/. For example, https://prod.sampledomain.com/cftrapi/openapi.

Important

Cyware recommends downloading the API credentials since you cannot recover the credentials later.

To make an API request to CFTR, you must create a signature using the Access ID and Secret Key of the API credentials with an expiry time. For more information, see CFTR API Reference.

Manage Open APIs

On the Open API page, you can view all the open APIs that are created in CFTR. You can perform the following activities on the Open APIs page:

  • Search Open APIs using the title.

  • Filter Open APIs based on the status.

  • Sort Open APIs based on the following parameters:

    • Expiration

    • Started On