Understand App Configuration
App configurations such as the primary details of an app and its supported actions are stored in the config.json file. App configurations defined in the config.json are displayed on the App Details page of a specific app in Orchestrate.
A config.json file is generated automatically after an app is built using Create New App on Orchestrate. For more information on Create New App, see Build a Sample App
To view the contents of a config.json file:
Click Apps and navigate to either Apps or Appstore.
Select an app whose config.json file you need to view. Click More > Export App Package.
Open the app package and double-click on the config.json file.
The following parameters are present in the config.json file:
title: denotes the title of an app, action, or app configuration parameter. For example, CFTR (app name).
description: denotes the description of an app, action, or app configuration parameter.
app_identifier: denotes the unique identifier of an app. For example, cftr.
logo_data: denotes the file name of the app logo in .png format. The value of this parameter is Logo_<app_identifier>.png
config_template: denotes the parameter that stores the configuration parameters required to access the app instance.
field_key: denotes the unique identifier of the app configuration parameters. For example, base_url.
field_type: denotes the field type of the app configuration parameters. For example, text.
is_required: denotes if you need to enter the value of an app configuration parameter to access the app instance. For example, true (required) or false (optional).
actions_data: denotes the parameter that stores all the action input parameters required to perform an action.
action_identifier: denotes the unique identifier of an app action. Example: search_threat_data_in_ctix
accepted_params: describes the input parameters of an action that are used to successfully perform an action.
return_values: describes the values returned by an action after it is successfully executed. The return values parameters include the data key, title, and description of the keys present in the response of an action.
supported_versions: denotes the supported API version of an app. Example: 2.0.0
connector_version: denotes the version of an app. Example: 2.0.0
categories: denotes the category of an app. Example: Analytics and SIEM.
lite_enabled: denotes the compatibility of the app with Cyware Agent. For example, true or false.
published_by: denotes the name of the app publisher. Example: Cyware
published_date: denotes the published date of an app on Orchestrate.
documentation_url: denotes the URL of the app documentation.
publisher_logo_url: denotes the URL of the publisher logo.