Skip to main content

Cyware Situational Awareness Platform

Generate Open API Credentials

Notice

This feature is available in CSAP v3.7.3.0 onwards.

In the Member Portal, use open API credentials for various actions such as viewing the list of alerts, getting details of each alert, sharing threat intel, and other actions. You can generate one set of credentials at a time. Additionally, you can also generate open API credentials for the Intel Library which helps you access data directly from Intel Exchange (CTIX).

After generating the credentials, you can first test connectivity with Collaborate and then start making API calls using these credentials. You can use any endpoint that is available for you, as a member. For more information, see CSAP API Documentation.

Generate Collaborate (CSAP) Credentials

To generate open API credentials for all other actions in Collaborate apart from the Intel Library, ensure this setting is enabled for your organization by the Collaborate administrator.

Steps 

To generate open API credentials for Collaborate, follow these steps :

  1. In the Member Portal, go to Settings > General Settings > API Credentials.

  2. To generate a new set of credentials for CSAP, click CSAP and then click Generate API Credentials.

    • App Name: This name acts as an identifier for the API credentials you generate.

    • Allowed IPs: Enter the IP address from which you want to make API calls from. You can add multiple IP addresses separating each by a comma. You can only make API calls using the specified IP addresses.

  3. After entering the details, click Generate. Your API credentials are available for your reference. Click Download as CSV or copy the credentials for your reference.

    Note

    It is recommended to download or save the API credentials as you cannot recover the credentials later. The access ID and secret key are encrypted after you close the window.

Generate Intel Library API Credentials

To generate open API credentials for Intel Library, ensure this setting is enabled for you, as a member, by the Collaborate administrator.

Steps 

To generate open API credentials for Intel Library, follow these steps:

  1. In the Member Portal, go to Settings > General Settings > API Credentials

  2. To generate a new set of credentials for Intel Library, click Intel Library > Generate Open API Credentials. Your API credentials are available for your reference. Click Download to download a CSV file of the API credentials.

    Note

    It is recommended to download or save the API credentials as you cannot recover the credentials later. The access ID and secret key are encrypted after you close the window.

Manage API Credentials

After you have generated API credentials for the first time, you can do the following:

CSAP 

  • To generate a new set of credentials, click Revoke to first revoke the existing credentials and then generate a new set of credentials.

  • You can copy the base URL and allowed IPs. Other details like access ID and secret key are no longer available after you generate the credentials for the first time.

Intel Library 

To generate a new set of credentials, click Reset Credentials to reset the existing credentials. New credentials are generated and you can no longer use the previous credentials.