Skip to main content

Cyware Orchestrate

Configure Open API

Orchestrate 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.

To view the maximum allowed limit of Open APIs that you can create based on your license, go to Admin Panel > License Management.

Generate Open API Credentials

Before you Start

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

Steps

To generate the open API credentials:

  1. Go to Admin Panel > Open APIs.

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

  3. Enter a unique title for the Open API.

  4. Enter an expiry date for Open API keys.

  5. If workspaces are enabled in, then you must select a workspace to assign the Open API. For more information on enabling workspaces, see Configure General Settings.

  6. Select the user that can use the Open API.

    Note

    If the user is not selected as a bot user during the initial user creation, it will not be reflected in the list of bot users available for selection. A user can be selected as a bot user only during the initial user creation process and cannot be edited later.

  7. Toggle the status to Active. If the bot user needs to use the Open API keys, then the Open API must be in active status.

  8. Click Create.

  9. 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.

Important

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

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

Regenerate Open API Token

Administrators with Create/Update Open API permission can regenerate a new token for the active Open APIs from the Open API listing page. After you regenerate a token, then the existing token is discarded and the integration with Cyware Agents and external platforms gets impacted.

To regenerate a token, navigate to a required Open API, click Regenerate Token, and agree to the confirmation dialogue.

Impact of Workspaces on Open API

On enabling workspaces, the existing Open APIs are assigned to your first workspace. 

While creating a new Open API, you must select a workspace. The created Open API can be used to integrate an external application with the selected workspace. For more information on workspaces, see Workspaces.

Note

Once configured, you cannot change the workspace assigned to an Open API. 

Manage Open APIs

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

  • Update the required fields for an Open API. For example, toggle the status of an active Open API to Inactive.

  • Search for specific Open APIs.

  • Filter Open APIs based on specific criteria. For example, filter by Active Open APIs.

  • Sort the APIs based on the following criteria:

    • Modified

    • Created

    • Name

    • Expiry Date

  • Customize the API table to hide or unhide a column and reorder the columns.