Cyware Persistent List API

openapi: 3.2.0
info:
  title: Cyware Orchestrate (CO) Open Persistent List API
  version: v1
  description: 'Public Open API for Cyware Orchestrate, Cyware''s security orchestration, automation and response (SOAR) platform. The API covers playbooks (listing, running, run logs, node results, exports, bulk terminate), app integrations (apps, app actions, app instances, action execution, custom app import), source events, persistent lists (storage manager), code snippets, custom email templates, tags, analytics and connectivity/version checks, plus the inbound webhook endpoints used to push events into Orchestrate.


    Orchestrate is deployed per tenant, so the server host is the customer''s own Orchestrate deployment; the API is mounted under `/soarapi`.


    This document was assembled by API Evangelist from Cyware''s own published, structured API reference documents at https://orchestrateapi.cyware.com — each endpoint page is served as machine-readable markdown carrying a JSON endpoint model, and every page is indexed from that host''s llms.txt. Paths, methods, parameters, descriptions, enumerations and examples are reproduced from those documents; nothing is invented.'
  contact:
    name: Cyware
    url: https://www.cyware.com/contact-us
  termsOfService: https://www.cyware.com/legal/terms-of-use
  x-apievangelist-source: https://orchestrateapi.cyware.com/llms.txt
  x-apievangelist-method: generated
servers:
- url: https://{co_host}/soarapi
  description: Tenant Orchestrate deployment. Replace {co_host} with your own Orchestrate host. Cyware uses https://demo.cyware.com/soar/ as the example host in the config of its open-source MCP server, and its docs reference the /soarapi base path.
  variables:
    co_host:
      default: demo.cyware.com
security:
- coOpenApiSignature: []
tags:
- name: Persistent List
  description: Persistent List
paths:
  /v1/storage-manager/:
    post:
      operationId: createAPersistentList
      summary: Create a Persistent List
      tags:
      - Persistent List
      description: Create a persistent list in Orchestrate.
      externalDocs:
        description: Cyware Orchestrate API reference
        url: https://orchestrateapi.cyware.com/persistent-list/create-a-persistent-list
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  type: string
                  description: "Pass the title for the persistent list. \nFor example: *Incident IDs*."
                  examples:
                  - IP addresses
                storage_manager_data:
                  type: object
                  description: Pass the data object containing the key-value pairs to be added to the persistent list.
                  properties:
                    data:
                      type: object
                      description: "Pass the JSON object containing the key-value pairs to add to the persistent list.\nExample: \"incident data\": {\n      \"id\": \"f8f6af0e-35c8-48e3-8cda-d0fe61476441\",\n      \"id\": \"e8f6af0e-35c8-48e3-8cda-d0fe61476322\"\n}"
              required:
              - title
            example:
              title: IP addresses
              storage_manager_data:
                data: {}
      responses:
        '201':
          description: HTTP 201 response
          content:
            application/json:
              schema:
                type: object
                properties:
                  title:
                    type: string
                    description: Returns the title of the persistent list.
                    examples:
                    - incident IDs
                  unique_id:
                    type: string
                    description: Returns the unique ID of the persistent list.
                    examples:
                    - 6e54a44b-b7bf-4680-b8ee-950bfebae2b4
                  readable_id:
                    type: string
                    description: Returns the readable ID of the persistent list.
                    examples:
                    - PL129
                  slug:
                    type: string
                    description: Returns the resource identifier of the persistent list.
                    examples:
                    - sm
                  description:
                    type: object
                    description: Returns the description of the persistent list.
                  created:
                    type: string
                    description: Returns the date and time when the persistent list was created.
                    examples:
                    - '2022-05-12T10:40:04.338353Z'
                  modified:
                    type: string
                    description: Returns the date and time when the persistent list was last modified.
                    examples:
                    - '2022-05-12T10:40:04.338353Z'
                  created_by_data:
                    type: object
                    description: Returns the details of the user who created the persistent list.
                    properties:
                      unique_id:
                        type: string
                        description: Returns the unique ID of the user who created the persistent list.
                        examples:
                        - bf62bdbe-c280-4882-b947-c750b31062fb
                      first_name:
                        type: string
                        description: Returns the first name of the user who created the persistent list.
                        examples:
                        - John
                      last_name:
                        type: string
                        description: Returns the last name of the user who created the persistent list.
                        examples:
                        - Doe
                      full_name:
                        type: string
                        description: Returns the full name of the user who created the persistent list.
                        examples:
                        - John Doe
                  modified_by_data:
                    type: object
                    description: Returns the details of the user who last modified the persistent list.
                    properties:
                      unique_id:
                        type: string
                        description: Returns the unique ID of the user who last modified the persistent list.
                        examples:
                        - bf62bdbe-c280-4882-b947-c750b31062fb
                      first_name:
                        type: string
                        description: Returns the first name of the user who last modified the persistent list.
                        examples:
                        - John
                      last_name:
                        type: string
                        description: Returns the last name of the user who last modified the persistent list.
                        examples:
                        - Doe
                      full_name:
                        type: string
                        description: Returns the full name of the user who last modified the persistent list.
                        examples:
                        - John Doe
                      modified_by:
                        type: string
                        description: Returns the details on whether a user or a playbook execution modified the persistent list.
                        examples:
                        - User
                      display_name:
                        type: string
                        description: Returns the display name of the user who modified the persistent list.
                        examples:
                        - John Doe
                  storage_manager_data:
                    type: object
                    description: Returns the JSON object containing the `unique_id and data of the persistent list.
                    properties:
                      unique_id:
                        type: string
                        description: Returns the unique ID of storage data.
                        examples:
                        - 28bfee2d-5599-4584-98a7-fd1ea8c5d2f5
                      data:
                        type: object
                        description: Returns the JSON object of data stored.
                        properties:
                          name:
                            type: string
                            description: Returns the data stored in the persistent list.
                            examples:
                            - dev
              example:
                title: incident IDs
                unique_id: 6e54a44b-b7bf-4680-b8ee-950bfebae2b4
                readable_id: PL129
                slug: sm
                description: {}
                created: '2022-05-12T10:40:04.338353Z'
                modified: '2022-05-12T10:40:04.338353Z'
                created_by_data:
                  unique_id: bf62bdbe-c280-4882-b947-c750b31062fb
                  first_name: John
                  last_name: Doe
                  full_name: John Doe
                modified_by_data:
                  unique_id: bf62bdbe-c280-4882-b947-c750b31062fb
                  first_name: John
                  last_name: Doe
                  full_name: John Doe
                  modified_by: User
                  display_name: John Doe
                storage_manager_data:
                  unique_id: 28bfee2d-5599-4584-98a7-fd1ea8c5d2f5
                  data:
                    name: dev
    get:
      operationId: persistentLists
      summary: Get Persistent Lists
      tags:
      - Persistent List
      description: Returns a list of persistent lists.
      externalDocs:
        description: Cyware Orchestrate API reference
        url: https://orchestrateapi.cyware.com/persistent-list/persistent-lists
      parameters:
      - name: page
        in: query
        required: false
        schema:
          type: integer
          description: Pass the page number to retrieve the persistent lists.
          default: '1'
          examples:
          - '1'
        description: Pass the page number to retrieve the persistent lists.
      - name: page_size
        in: query
        required: false
        schema:
          type: integer
          description: Pass the number of items to retrieve per page.
          default: '10'
          examples:
          - '10'
        description: Pass the number of items to retrieve per page.
      - name: q
        in: query
        required: false
        schema:
          type: string
          description: Pass the title or query string to search for a persistent list.
          examples:
          - storage
        description: Pass the title or query string to search for a persistent list.
      responses:
        '200':
          description: HTTP 200 response
          content:
            application/json:
              schema:
                type: object
                properties:
                  link:
                    type: object
                    description: Returns the links for the next and previous pages.
                  count:
                    type: number
                    description: Returns the total count of persistent lists.
                    examples:
                    - '1'
                  results:
                    type: array
                    description: Returns the list of persistent lists.
                    items:
                      type: object
                      properties:
                        title:
                          type: string
                          description: Returns the title of persistent list.
                          examples:
                          - playbook edited
                        unique_id:
                          type: string
                          description: Returns the unique ID of the persistent list.
                          examples:
                          - 9b8b64f4-6366-4541-89cc-0ef739511bc9
                        readable_id:
                          type: string
                          description: Returns the readable ID of the persistent list.
                          examples:
                          - PL104
                        slug:
                          type: string
                          description: Returns the unique resource identifier of the persistent list.
                          examples:
                          - playbook-edited
                        description:
                          type: object
                          description: Returns the description of the persistent list.
                        created:
                          type: string
                          description: Returns the date and time when the persistent list was created.
                          examples:
                          - '2022-05-10T08:27:25.941286Z'
                        modified:
                          type: string
                          description: Returns the date and time when the persistent list was last modified.
                          examples:
                          - '2022-05-12T09:19:39.971523Z'
                        created_by_data:
                          type: object
                          description: Returns the details of a user who created the persistent list
                          properties:
                            unique_id:
                              type: string
                              description: Returns the unique ID of the user who created the persistent list.
                              examples:
                              - 4695189b-4878-42dd-bd03-2b16f95bb330
                            first_name:
                              type: string
                              description: Returns the first name of the user who created the persistent list.
                              examples:
                              - John
                            last_name:
                              type: string
                              description: Returns the last name of the user who created the persistent list.
                              examples:
                              - Doe
                            full_name:
                              type: string
                              description: Returns the full name of the user who created the persistent list.
                              examples:
                              - John Doe
                        modified_by_data:
                          type: object
                          description: Returns the details of the user or playbook that modified the persistent list.
                          properties:
                            unique_id:
                              type: string
                              description: Returns the unique ID of the user or playbook that modified the persistent list.
                              examples:
                              - c4d82da1-2e76-4831-9f4b-086071add09b
                            playbook_data:
                              type: object
                              description: Returns the details of a playbook that modified a persistent list
                              properties:
                                unique_id:
                                  type: string
                                  description: Returns the unique ID of the playbook that modified the persistent list.
                                  examples:
                                  - dc57c723-e51e-4c7c-80b1-861b76563f10
                                title:
                                  type: string
                                  description: Returns the title of the playbook that modified the persistent list.
                                  examples:
                                  - Report Incident
                                labels:
                                  type: array
                                  description: Returns the list of labels added to the persistent list.
                                  items: {}
                                status:
                                  type: string
                                  description: Returns if the playbook that modified the persistent list is active or inactive.
                                  examples:
                                  - ACTIVE
                                playbook_last_run:
                                  type: string
                                  description: Returns the date and time when the playbook that modified the persistent list was last executed.
                                  examples:
                                  - '2022-05-12T09:19:38.490532Z'
                                output_params:
                                  type: object
                                  description: Returns the output parameters of the playbook that modified the persistent list.
                                description:
                                  type: object
                                  description: Returns the description of the playbook that modified the persistent list.
                                sub_playbook:
                                  type: number
                                  description: Returns the number of sub-playbooks in the playbook that modified the persistent list.
                                  examples:
                                  - '0'
                                categories:
                                  type: array
                                  description: Returns the playbook categories if the playbook is available in Orchestrate > Manage Playbooks > Playbook Store.
                                  items: {}
                                apps_count:
                                  type: number
                                  description: Returns the number of apps in the playbook that modified the persistent list.
                                  examples:
                                  - '1'
                                schedule_info:
                                  type: object
                                  description: Returns the details of the playbook schedule that modified the persistent list..
                            modified_by:
                              type: string
                              description: Returns details on whether a user or a playbook modified the persistent list.
                              examples:
                              - PlaybookResult
                            display_name:
                              type: string
                              description: Returns the display name of the playbook that modified the persistent list.
                              examples:
                              - John Doe's Playbook - Persistent List DEMO
              example:
                link: {}
                count: '1'
                results:
                - title: playbook edited
                  unique_id: 9b8b64f4-6366-4541-89cc-0ef739511bc9
                  readable_id: PL104
                  slug: playbook-edited
                  description: {}
                  created: '2022-05-10T08:27:25.941286Z'
                  modified: '2022-05-12T09:19:39.971523Z'
                  created_by_data:
                    unique_id: 4695189b-4878-42dd-bd03-2b16f95bb330
                    first_name: John
                    last_name: Doe
                    full_name: John Doe
                  modified_by_data:
                    unique_id: c4d82da1-2e76-4831-9f4b-086071add09b
                    playbook_data:
                      unique_id: dc57c723-e51e-4c7c-80b1-861b76563f10
                      title: Report Incident
                      labels: []
                      status: ACTIVE
                      playbook_last_run: '2022-05-12T09:19:38.490532Z'
                      output_params: {}
                      description: {}
                      sub_playbook: '0'
                      categories: []
                      apps_count: '1'
                      schedule_info: {}
                    modified_by: PlaybookResult
                    display_name: John Doe's Playbook - Persistent List DEMO
  /v1/storage-manager/{persistent_storage_unique_id}/:
    put:
      operationId: deletePersistentStorageObject
      summary: Delete Persistent Storage Object
      tags:
      - Persistent List
      description: Delete a persistent list by passing the unique ID. You can delete the persistent list only if it is not used in a playbook. A successful request returns a 200 status code, else the response includes a `non_field_error` object.
      externalDocs:
        description: Cyware Orchestrate API reference
        url: https://orchestrateapi.cyware.com/persistent-list/delete-persistent-storage-object
      parameters:
      - name: persistent_storage_unique_id
        in: path
        required: true
        schema:
          type: string
          description: Pass the unique ID of the persistent list to retrieve the details. You can retrieve the unique ID of a persistent list using the **Get Persistent Lists** endpoint.
          examples:
          - '{persistent_storage_unique_id}'
        description: Pass the unique ID of the persistent list to retrieve the details. You can retrieve the unique ID of a persistent list using the **Get Persistent Lists** endpoint.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                is_removed:
                  type: string
                  description: Pass true to delete the persistent list.
                  examples:
                  - 'true'
              required:
              - is_removed
            example:
              is_removed: 'true'
      responses:
        '400':
          description: HTTP 400 response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    description: Returns an object explaining why the deletion of the persistent list was unsuccessful.
                    properties:
                      non_field_error:
                        type: string
                        description: Returns the reason the persistent list was not deleted.
                        examples:
                        - This persistent list has associated playbooks
                  status_code:
                    type: number
                    description: Returns a status code for the failure of the deletion. For example, *400*.
                    examples:
                    - '400'
              example:
                result:
                  non_field_error: This persistent list has associated playbooks
                status_code: '400'
      x-alternate-documents:
      - title: Update a Persistent List
        operationId: updateAPersistentList
        url: https://orchestrateapi.cyware.com/persistent-list/update-a-persistent-list
    get:
      operationId: persistentListDetails
      summary: Get Persistent List Details
      tags:
      - Persistent List
      description: Returns the details of a specific persistent list.
      externalDocs:
        description: Cyware Orchestrate API reference
        url: https://orchestrateapi.cyware.com/persistent-list/persistent-list-details
      parameters:
      - name: persistent_storage_unique_id
        in: path
        required: true
        schema:
          type: string
          description: Pass the unique ID of the persistent list to retrieve the details. You can retrieve the unique ID of a persistent list using the **Get Persistent Lists** endpoint.
          examples:
          - '{persistent_storage_unique_id}'
        description: Pass the unique ID of the persistent list to retrieve the details. You can retrieve the unique ID of a persistent list using the **Get Persistent Lists** endpoint.
      responses:
        '200':
          description: HTTP 200 response
          content:
            application/json:
              schema:
                type: object
                properties:
                  title:
                    type: string
                    description: Returns the title of the persistent list.
                    examples:
                    - playbook edited
                  unique_id:
                    type: string
                    description: Returns the unique ID of the persistent list.
                    examples:
                    - 9b8b64f4-6366-4541-89cc-0ef739511bc9
                  readable_id:
                    type: string
                    description: Returns the readable ID of the persistent list.
                    examples:
                    - PL104
                  slug:
                    type: string
                    description: Returns the unique identifier of the persistent list.
                    examples:
                    - playbook-edited
                  description:
                    type: object
                    description: Returns the description of the persistent list.
                  created:
                    type: string
                    description: Returns the date and time of when the persistent list was created.
                    examples:
                    - '2022-05-10T08:27:25.941286Z'
                  modified:
                    type: string
                    description: Returns the date and time of when the persistent list was last modified.
                    examples:
                    - '2022-05-12T09:19:39.971523Z'
                  created_by_data:
                    type: object
                    description: Returns the details of a user who created the persistent list.
                    properties:
                      unique_id:
                        type: string
                        description: Returns the unique ID of the user who created the persistent list.
                        examples:
                        - 4695189b-4878-42dd-bd03-2b16f95bb330
                      first_name:
                        type: string
                        description: Returns the first name of the user who created the persistent list.
                        examples:
                        - John
                      last_name:
                        type: string
                        description: Returns the last name of the user who created the persistent list.
                        examples:
                        - Doe
                      full_name:
                        type: string
                        description: Returns the full name of the user who created the persistent list.
                        examples:
                        - John Doe
                  modified_by_data:
                    type: object
                    description: Returns the details of the user who last modified the persistent list.
                    properties:
                      unique_id:
                        type: string
                        description: Returns the first name of the user who last modified the persistent list.
                        examples:
                        - c4d82da1-2e76-4831-9f4b-086071add09b
                      playbook_data:
                        type: object
                        description: Returns the details of a playbook that modified the persistent list.
                        properties:
                          unique_id:
                            type: string
                            description: Returns the unique ID of the playbook that modified the persistent list.
                            examples:
                            - dc57c723-e51e-4c7c-80b1-861b76563f10
                          title:
                            type: string
                            description: Returns the title of the playbook that modified the persistent list.
                            examples:
                            - Report Incident
                          labels:
                            type: array
                            description: Returns the list of labels added to the playbook that modified the persistent list.
                            items: {}
                          status:
                            type: string
                            description: Returns if the playbook that modified the persistent list is active or inactive.
                            examples:
                            - ACTIVE
                          playbook_last_run:
                            type: string
                            description: Returns the date and time of when the playbook that modified the persistent list was last executed.
                            examples:
                            - '2022-05-12T09:19:38.490532Z'
                          output_params:
                            type: object
                            description: Returns the output parameters of the playbook that modified the persistent list.
                          description:
                            type: object
                            description: Returns the description of the playbook that modified the persistent list.
                          sub_playbook:
                            type: number
                            description: Returns the number of sub-playbooks in the playbook that modified the persistent list.
                            examples:
                            - '0'
                          categories:
                            type: array
                            description: Returns the categories if the playbook is available in Orchestrate > Manage Playbooks > Playbook Store.
                            items: {}
                          apps_count:
                            type: number
                            description: Returns the number of apps in the playbook that modified the persistent list.
                            examples:
                            - '1'
                          schedule_info:
                            type: object
                            description: Returns the details of the playbook schedule that modified the persistent list.
                      modified_by:
                        type: string
                        description: Returns details on whether a user or a playbook execution modified the persistent list.
                        examples:
                        - PlaybookResult
                      display_name:
                        type: string
                        description: Returns the display name of the user or playbook that modified the persistent list.
                        examples:
                        - John Doe's Playbook - Persistent List DEMO
                  storage_manager_data:
                    type: object
                    description: Returns an object containing the `unique_id` and associated data of a persistent list.
                    properties:
                      unique_id:
                        type: string
                        description: Returns the unique ID of the storage data.
                        examples:
                        - 4555e183-dae4-4ecc-8c1c-8fd2a9d7c365
                      data:
                        type: object
                        description: Returns the data stored in the persistent list.
                        properties:
                          new:
                            type: object
                            description: Returns the persistent list data as key-value pairs.
                            properties:
                              data:
                                type: string
                                description: Returns the data stored in the persistent list.
                                examples:
                                - Some random string
              example:
                title: playbook edited
                unique_id: 9b8b64f4-6366-4541-89cc-0ef739511

# --- truncated at 32 KB (41 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cyware/refs/heads/main/openapi/cyware-persistent-list-api-openapi.yml