Orchestrate Next Gen API Reference ## Sections • [Authentication](https://orchestrateapiv3.cyware.com/authentication.md): Users with access to Cyware Orchestrate’s Open APIs module can generate the credentials for API authentication. Generate Open API Credentials You can… • [Test Connectivity](https://orchestrateapiv3.cyware.com/authentication/test-connectivity.md): Returns the status of the test connectivity with the Orchestrate application. • [Product Release Version](https://orchestrateapiv3.cyware.com/authentication/product-release-version.md): Returns the current release version of the Orchestrate instance. • [Integrations](https://orchestrateapiv3.cyware.com/integrations.md): Cyware Orchestrate offers a robust App Store with a comprehensive library of apps required to integrate, orchestrate, and respond using various… • [Get Apps](https://orchestrateapiv3.cyware.com/integrations/get-apps.md): Returns a list of apps from My Apps in Orchestrate. • [Get App Details](https://orchestrateapiv3.cyware.com/integrations/get-app-details.md): Returns the details of a specific app including its configuration template and available actions count. • [List App Instances](https://orchestrateapiv3.cyware.com/integrations/list-app-instances.md): Returns a paginated list of app instances configured in Orchestrate. • [Create App Instance](https://orchestrateapiv3.cyware.com/integrations/create-app-instance.md): Creates a new app instance with the specified configuration. • [Get App Instance](https://orchestrateapiv3.cyware.com/integrations/get-app-instance.md): Returns the configuration and connectivity details of a specific app instance. • [Test App Instance Connectivity](https://orchestrateapiv3.cyware.com/integrations/test-app-instance-connectivity.md): Tests the connectivity of a specific app instance and returns the connection status. • [Get App Actions](https://orchestrateapiv3.cyware.com/integrations/get-app-actions.md): Returns a list of actions available for a specific app. • [Get Action Details](https://orchestrateapiv3.cyware.com/integrations/get-action-details.md): Returns the details of a specific app action including its accepted parameters and return values. • [Execute Action](https://orchestrateapiv3.cyware.com/integrations/execute-action.md): Executes a specific app action. • [Export App Package](https://orchestrateapiv3.cyware.com/integrations/export-app-package.md): Downloads the app package file for a specific installed app. • [Install App](https://orchestrateapiv3.cyware.com/integrations/install-app.md): Uploads and installs a custom app package into Orchestrate. • [Playbooks](https://orchestrateapiv3.cyware.com/playbooks.md): Playbooks are a structured sequence of actions organized into workflows to automate and orchestrate security responses, standardizing processes for… • [Export Playbook](https://orchestrateapiv3.cyware.com/playbooks/export-playbook.md): Returns the export of a playbook in JSON format. • [Get Playbook Run Logs](https://orchestrateapiv3.cyware.com/playbooks/get-playbook-run-logs.md): Returns the playbook runlogs based on the unique ID of the playbook. If no payload is passed, it returns the complete list of playbook run logs. • [Get Playbook Run Log Details](https://orchestrateapiv3.cyware.com/playbooks/get-playbook-run-log-details.md): Returns the run logs details of a specific playbook run. • [Get Playbook Run Logs by Playbook](https://orchestrateapiv3.cyware.com/playbooks/get-playbook-run-logs-by-playbook.md): Returns the run logs for a specific playbook. • [Filter Playbooks](https://orchestrateapiv3.cyware.com/playbooks/filter-playbooks.md): Returns a filtered list of playbooks. • [Run Playbook](https://orchestrateapiv3.cyware.com/playbooks/run-playbook.md): Run a playbook by passing the playbook’s unique ID through the payload. • [Get Playbook List](https://orchestrateapiv3.cyware.com/playbooks/get-playbook-list.md): Returns a list of active playbooks in Orchestrate. • [Export Playbook Result](https://orchestrateapiv3.cyware.com/playbooks/export-playbook-result.md): Downloads the input data that was passed to a specific playbook run. • [Export Node Result](https://orchestrateapiv3.cyware.com/playbooks/export-node-result.md): Downloads the input data for a specific node within a playbook run. Use this endpoint for large node input payloads. • [Bulk Terminate Playbook Run Logs](https://orchestrateapiv3.cyware.com/playbooks/bulk-terminate-playbook-run-logs.md): Terminate playbook runs in bulk. You can terminate a maximum of 100 playbook runs at a time with the run status in progress, in-queue, waiting, or on… • [Custom Email Templates](https://orchestrateapiv3.cyware.com/custom-email-templates.md): These endpoints provide read access to the custom email templates configured in your workspace. Use them to list all templates or retrieve the HTML body of a specific template. • [Get Custom Email Template List](https://orchestrateapiv3.cyware.com/custom-email-templates/get-custom-email-template-list.md): Returns a paginated list of all custom email templates in the workspace. • [Get Email Template Details](https://orchestrateapiv3.cyware.com/custom-email-templates/get-email-template-details.md): Returns the details and HTML body of a specific email template. • [Code Snippets](https://orchestrateapiv3.cyware.com/code-snippets.md): These endpoints provide read access to the code snippets stored in your workspace. Use them to list all snippets or retrieve the source code of a specific snippet. • [Get Code Snippet List](https://orchestrateapiv3.cyware.com/code-snippets/get-code-snippet-list.md): Returns a paginated list of all code snippets in the workspace. • [Get Code Snippet Details](https://orchestrateapiv3.cyware.com/code-snippets/get-code-snippet-details.md): Returns the details and source code of a specific code snippet. • [Persistent List](https://orchestrateapiv3.cyware.com/persistent-list.md): Persistent lists are key-value stores that retain data across playbook executions. Use these endpoints to create, retrieve, update, and delete persistent lists, and to query which playbooks reference a specific list. • [Get Persistent Lists](https://orchestrateapiv3.cyware.com/persistent-list/get-persistent-lists.md): Returns a paginated list of all persistent lists in the workspace. • [Create Persistent List](https://orchestrateapiv3.cyware.com/persistent-list/create-persistent-list.md): Creates a new persistent list. • [Get Persistent List Details](https://orchestrateapiv3.cyware.com/persistent-list/get-persistent-list-details.md): Returns the details and data of a specific persistent list. • [Update Persistent List](https://orchestrateapiv3.cyware.com/persistent-list/update-persistent-list.md): Updates the data or metadata of an existing persistent list. • [Delete Persistent List](https://orchestrateapiv3.cyware.com/persistent-list/delete-persistent-list.md): Deletes a persistent list by its ID. • [Get Persistent List Slugs](https://orchestrateapiv3.cyware.com/persistent-list/get-persistent-list-slugs.md): Returns the list of slugs for all persistent lists in the workspace. • [Get Associated Playbooks](https://orchestrateapiv3.cyware.com/persistent-list/get-associated-playbooks.md): Returns the list of playbooks that reference a specific persistent list. • [Get Associated Playbook Count](https://orchestrateapiv3.cyware.com/persistent-list/get-associated-playbook-count.md): Returns the number of playbooks that reference a specific persistent list. • [Analytics](https://orchestrateapiv3.cyware.com/analytics.md): The Analytics Dashboard in Orchestrate provides an overview of activities across modules. Upon signing in, users can view dashboards that offer… • [Get Analytics Data](https://orchestrateapiv3.cyware.com/analytics/get-analytics-data.md): Returns the number of times playbooks were executed for the non-purged data within the specified date range. • [Events](https://orchestrateapiv3.cyware.com/events.md): A Source Event acts as a trigger for a playbook to execute. You can configure triggers to automatically trigger the execution of a playbook based on… • [Create Event](https://orchestrateapiv3.cyware.com/events/create-event.md): Creates an event by passing the app identifier, action identifier, and data through the payload. • [List Source Events](https://orchestrateapiv3.cyware.com/events/list-source-events.md): Returns the list of events. • [Source Event Details](https://orchestrateapiv3.cyware.com/events/source-event-details.md): Returns the details of a specific event. • [Configure Trigger](https://orchestrateapiv3.cyware.com/events/configure-trigger.md): Creates a new webhook trigger configuration by mapping an app identifier and action identifier to a playbook trigger. • [Export Event Data](https://orchestrateapiv3.cyware.com/events/export-event-data.md): Returns a token that can be used to download the raw data payload associated with a specific event. • [Tags](https://orchestrateapiv3.cyware.com/tags.md): These endpoints provide read access to the tags defined in your Orchestrate workspace. Use them to list all tags or retrieve the details of a specific tag. • [Get Tags List](https://orchestrateapiv3.cyware.com/tags/get-tags-list.md): Returns a paginated list of all tags in the workspace. • [Get Tag Details](https://orchestrateapiv3.cyware.com/tags/get-tag-details.md): Returns the details of a specific tag.