API Symphony (2.20241218-12384654911-5d13e754e7e2ad8f4934b0aceb7580fe78ce534a)

Download OpenAPI specification:Download

Symphony Application API

Playbooks

Manage Playbooks (list, create, activate, etc.)

List available playbooks

This endpoint does not include the playbooks’ content in the results.

The following permissions are required:

  • SYMPHONY_READ_PLAYBOOKS (e75117b9-bb99-4248-8e1d-77c0914b15bd): View playbook listing and details
Authorizations:
accessToken
query Parameters
match[community_uuid]
string

Communities to match (separated by commas).

limit
integer [ 1 .. 100 ]
Default: 20

limit a number of items (allowed range is 1-100), default is 20.

offset
integer >= 0
Default: 0

a number of items to skip, default is 0.

match[status]
string

Match playbooks by their status (separated by commas).

match[name]
string

Match playbooks by their name (separated by commas).

match[trigger_uuid]
string

Match playbooks by their trigger UUID.

match[module_uuid]
string

Match playbooks by their module UUID.

meta_playbook
boolean
Default: true

Exclude meta-playbooks from the response and display child playbooks instead

date[updated_at]
string

Filter playbooks by their update date (see rfc3339).

sort
string
Default: "updated_at"
Enum: "updated_at" "name" "status"

Sort playbooks by one of their attributes

direction
string
Default: "desc"
Enum: "asc" "desc"

Direction of the sort.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0
}

Create a new playbook

The provided playbook definition must follow the Symphony Playbook Language.

The following permissions are required:

  • SYMPHONY_WRITE_PLAYBOOKS (1d231a6b-9010-4fa1-a9cc-9fafeabb60a0): Create, edit, delete playbook and playbook settings. Manage playbook activation.
Authorizations:
accessToken
query Parameters
required
object

Definition of the playbook under the Symphony Playbook Language (SPL)

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "version": 0,
  • "community_uuid": "e391588b-4c35-45eb-a5af-211fba0cde08",
  • "meta_community_uuids": [
    ],
  • "status": "string",
  • "status_message": "string",
  • "name": "string",
  • "description": "string",
  • "meta_playbook": true,
  • "parent_uuid": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "created_by_type": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "updated_by": "string",
  • "updated_by_type": "string",
  • "activated_at": "2019-08-24T14:15:22Z",
  • "activated_by": "string",
  • "activated_by_type": "string",
  • "trigger_configurations": [
    ],
  • "status_tags": [
    ]
}

Retrieve Playbook statistics

The following permissions are required:

  • SYMPHONY_READ_PLAYBOOKS (e75117b9-bb99-4248-8e1d-77c0914b15bd): View playbook listing and details
Authorizations:
accessToken
query Parameters
match[community_uuid]
string

Communities to match (separated by commas).

limit
integer [ 1 .. 100 ]
Default: 20

limit a number of items (allowed range is 1-100), default is 20.

offset
integer >= 0
Default: 0

a number of items to skip, default is 0.

match[status]
string

Match playbooks by their status (separated by commas).

match[name]
string

Match playbooks by their name (separated by commas).

match[trigger_uuid]
string

Match playbooks by their trigger UUID.

match[module_uuid]
string

Match playbooks by their module UUID.

meta_playbook
boolean
Default: true

Exclude meta-playbooks from the response and display child playbooks instead

date[updated_at]
string

Filter playbooks by their update date (see rfc3339).

sort
string
Default: "updated_at"
Enum: "updated_at" "name" "status"

Sort playbooks by one of their attributes

direction
string
Default: "desc"
Enum: "asc" "desc"

Direction of the sort.

Responses

Response samples

Content type
application/json
{
  • "statuses": { }
}

Get a specific playbook given its UUID

The following permissions are required:

  • SYMPHONY_READ_PLAYBOOKS (e75117b9-bb99-4248-8e1d-77c0914b15bd): View playbook listing and details
Authorizations:
accessToken
path Parameters
uuid
required
string
query Parameters
version
integer

Specific Playbook version to retrieve

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "version": 0,
  • "community_uuid": "e391588b-4c35-45eb-a5af-211fba0cde08",
  • "meta_community_uuids": [
    ],
  • "status": "string",
  • "status_message": "string",
  • "name": "string",
  • "description": "string",
  • "meta_playbook": true,
  • "parent_uuid": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "created_by_type": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "updated_by": "string",
  • "updated_by_type": "string",
  • "activated_at": "2019-08-24T14:15:22Z",
  • "activated_by": "string",
  • "activated_by_type": "string",
  • "trigger_configurations": [
    ],
  • "status_tags": [
    ],
  • "content": { }
}

Update a specific playbook

The following permissions are required:

  • SYMPHONY_WRITE_PLAYBOOKS (1d231a6b-9010-4fa1-a9cc-9fafeabb60a0): Create, edit, delete playbook and playbook settings. Manage playbook activation.
Authorizations:
accessToken
path Parameters
uuid
required
string
query Parameters
required
object

Definition of the playbook under the Symphony Playbook Language (SPL)

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "version": 0,
  • "community_uuid": "e391588b-4c35-45eb-a5af-211fba0cde08",
  • "meta_community_uuids": [
    ],
  • "status": "string",
  • "status_message": "string",
  • "name": "string",
  • "description": "string",
  • "meta_playbook": true,
  • "parent_uuid": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "created_by_type": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "updated_by": "string",
  • "updated_by_type": "string",
  • "activated_at": "2019-08-24T14:15:22Z",
  • "activated_by": "string",
  • "activated_by_type": "string",
  • "trigger_configurations": [
    ],
  • "status_tags": [
    ],
  • "content": { }
}

Delete a specific Playbook

The following permissions are required:

  • SYMPHONY_WRITE_PLAYBOOKS (1d231a6b-9010-4fa1-a9cc-9fafeabb60a0): Create, edit, delete playbook and playbook settings. Manage playbook activation.
Authorizations:
accessToken
path Parameters
uuid
required
string

Responses

Activate a Playbook

The following permissions are required:

  • SYMPHONY_WRITE_PLAYBOOKS (1d231a6b-9010-4fa1-a9cc-9fafeabb60a0): Create, edit, delete playbook and playbook settings. Manage playbook activation.
Authorizations:
accessToken
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "version": 0,
  • "community_uuid": "e391588b-4c35-45eb-a5af-211fba0cde08",
  • "meta_community_uuids": [
    ],
  • "status": "string",
  • "status_message": "string",
  • "name": "string",
  • "description": "string",
  • "meta_playbook": true,
  • "parent_uuid": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "created_by_type": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "updated_by": "string",
  • "updated_by_type": "string",
  • "activated_at": "2019-08-24T14:15:22Z",
  • "activated_by": "string",
  • "activated_by_type": "string",
  • "trigger_configurations": [
    ],
  • "status_tags": [
    ],
  • "content": { }
}

get_playbook_children_resource

The following permissions are required:

  • SYMPHONY_READ_PLAYBOOKS (e75117b9-bb99-4248-8e1d-77c0914b15bd): View playbook listing and details
Authorizations:
accessToken
path Parameters
uuid
required
string

Responses

Deactivate a Playbook

The following permissions are required:

  • SYMPHONY_WRITE_PLAYBOOKS (1d231a6b-9010-4fa1-a9cc-9fafeabb60a0): Create, edit, delete playbook and playbook settings. Manage playbook activation.
Authorizations:
accessToken
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "version": 0,
  • "community_uuid": "e391588b-4c35-45eb-a5af-211fba0cde08",
  • "meta_community_uuids": [
    ],
  • "status": "string",
  • "status_message": "string",
  • "name": "string",
  • "description": "string",
  • "meta_playbook": true,
  • "parent_uuid": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "created_by_type": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "updated_by": "string",
  • "updated_by_type": "string",
  • "activated_at": "2019-08-24T14:15:22Z",
  • "activated_by": "string",
  • "activated_by_type": "string",
  • "trigger_configurations": [
    ],
  • "status_tags": [
    ],
  • "content": { }
}

get_playbook_logs_resource

The following permissions are required:

  • SYMPHONY_READ_PLAYBOOKS (e75117b9-bb99-4248-8e1d-77c0914b15bd): View playbook listing and details
Authorizations:
accessToken
path Parameters
uuid
required
string
query Parameters
match[community_uuid]
string

Communities to match (separated by commas).

limit
integer
Default: 20
offset
integer
Default: 0
match[log_level]
string

Match logs by their log level

match[message]
string

Match logs the content of the message

Responses

post_re_run_failed_playbook_runs_resource

The following permissions are required:

  • SYMPHONY_WRITE_PLAYBOOK_RUNS (d3791fbf-0752-4a50-ab67-0eb8345d1762): Re-run playbook and playbook runs.
Authorizations:
accessToken
path Parameters
uuid
required
string

Responses

Playbooks Runs

Retrieve information about executions of Playbook (a.k.a. “Playbook Runs”).

List available playbook runs

The following permissions are required:

  • SYMPHONY_READ_PLAYBOOK_RUNS (9648daab-0c06-4624-b610-0b69a06d95df): View playbook runs, node runs and associated logs.
Authorizations:
accessToken
query Parameters
match[community_uuid]
string

Communities to match (separated by commas).

limit
integer [ 1 .. 100 ]
Default: 20

limit a number of items (allowed range is 1-100), default is 20.

offset
integer >= 0
Default: 0

a number of items to skip, default is 0.

match[event]
string

Match playbook runs by their event name (separated by commas).

match[status]
string

Match playbook runs by their status name (separated by commas).

match[playbook_uuid]
string

Match playbook runs by playbook (separated by commas).

date[started_at]
string

Match playbook runs by their starting date (separated by commas).

sort
string
Default: "started_at"
Enum: "started_at" "event" "status"

Sort returned playbook runs (accepted values: 'started_at, 'event', 'status'

direction
string
Default: "desc"
Enum: "asc" "desc"

Direction of the sort (accepted values: ('asc', 'desc'))

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0
}

Get a playbook run by its UUID

The following permissions are required:

  • SYMPHONY_READ_PLAYBOOK_RUNS (9648daab-0c06-4624-b610-0b69a06d95df): View playbook runs, node runs and associated logs.
Authorizations:
accessToken
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "playbook_content": { },
  • "playbook_uuid": "string",
  • "playbook_name": "string",
  • "community_uuid": "string",
  • "event": "string",
  • "status": "string",
  • "store": { },
  • "started_at": "2019-08-24T14:15:22Z",
  • "started_by": "string",
  • "started_by_type": "string",
  • "pending_at": "2019-08-24T14:15:22Z",
  • "running_at": "2019-08-24T14:15:22Z",
  • "finished_at": "2019-08-24T14:15:22Z"
}

Get full details about a playbook run by its UUID

The following permissions are required:

  • SYMPHONY_READ_PLAYBOOK_RUNS (9648daab-0c06-4624-b610-0b69a06d95df): View playbook runs, node runs and associated logs.
Authorizations:
accessToken
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "playbook_run": {
    },
  • "playbook": { },
  • "node_runs": { }
}

Get the content of a playbook run file

The following permissions are required:

  • SYMPHONY_READ_PLAYBOOK_RUNS (9648daab-0c06-4624-b610-0b69a06d95df): View playbook runs, node runs and associated logs.
Authorizations:
accessToken
path Parameters
uuid
required
string
query Parameters
filepath
required
string

Filepath to retrieve

Responses

post_re_run_playbook

The following permissions are required:

  • SYMPHONY_WRITE_PLAYBOOK_RUNS (d3791fbf-0752-4a50-ab67-0eb8345d1762): Re-run playbook and playbook runs.
Authorizations:
accessToken
path Parameters
uuid
required
string
query Parameters
only_failed_actions
boolean
Default: false

Whether only the failed actions should be re-run instead of the whole playbook

Responses

Action Runs

Manage Action Runs

Update a specific Action Run

Authorizations:
accessToken
path Parameters
uuid
required
string
query Parameters
status
required
string
Enum: "running" "finished"

Status of the Action Run

results
object

Action Run's Results

outputs
object

Action Run's Outputs (playbook branches)

error
string

Error raised during execution

logs
string

Action Run's logs

secrets
object

Action run secrets to update

need_secrets
boolean

Ask for secrets in the response

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "node_type": "string",
  • "node_id": 0,
  • "parent_node_run_id": 0,
  • "iteration": 0,
  • "status": "string",
  • "error": "string",
  • "started_at": "2019-08-24T14:15:22Z",
  • "pending_at": "2019-08-24T14:15:22Z",
  • "running_at": "2019-08-24T14:15:22Z",
  • "finished_at": "2019-08-24T14:15:22Z",
  • "arguments": { },
  • "outputs": { },
  • "results": { },
  • "logs": "string",
  • "module_configuration": {
    }
}

Trigger Configurations

Manage Trigger Configurations

List existing Trigger Configurations

The following permissions are required:

  • SYMPHONY_READ_PLAYBOOKS (e75117b9-bb99-4248-8e1d-77c0914b15bd): View playbook listing and details
Authorizations:
accessToken
query Parameters
match[community_uuid]
string

Communities to match (separated by commas).

limit
integer [ 1 .. 100 ]
Default: 20

limit a number of items (allowed range is 1-100), default is 20.

offset
integer >= 0
Default: 0

a number of items to skip, default is 0.

date[created_at]
string

Match node configurations by their last updater (separated by commas).

date[updated_at]
string

Filter node configurations by their update date (see rfc3339).

direction
string
Default: "desc"
Enum: "asc" "desc"

Direction of the sort.

community_uuid
string

UUID of the community

sort
string
Default: "updated_at"
Enum: "updated_at" "created_at" "trigger_id" "name"

Sort trigger configurations by one of their attributes

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0
}

Create a trigger configuration

The following permissions are required:

  • SYMPHONY_WRITE_PLAYBOOKS (1d231a6b-9010-4fa1-a9cc-9fafeabb60a0): Create, edit, delete playbook and playbook settings. Manage playbook activation.
Authorizations:
accessToken
query Parameters
name
required
string

The name of the node configuration

value
object

The value of the configuration for the node configuration

module_configuration_uuid
string

The uuid from the module configuration

community_uuid
string

UUID of the community

trigger_uuid
required
string

The uuid from the trigger which owns the trigger configuration

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "community_uuid": "e391588b-4c35-45eb-a5af-211fba0cde08",
  • "module_configuration_uuid": "d0b95458-227e-4b75-a872-2ecbe5c5ac28",
  • "name": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "created_by_type": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "updated_by": "string",
  • "updated_by_type": "string",
  • "deleted": true,
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_by": "string",
  • "deleted_by_type": "string",
  • "value": { },
  • "trigger_uuid": "43e2987b-434b-472d-969b-3472dba75b7d"
}

Get a specific trigger configuration given its UUID

The following permissions are required:

  • SYMPHONY_READ_PLAYBOOKS (e75117b9-bb99-4248-8e1d-77c0914b15bd): View playbook listing and details
Authorizations:
accessToken
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "community_uuid": "e391588b-4c35-45eb-a5af-211fba0cde08",
  • "module_configuration_uuid": "d0b95458-227e-4b75-a872-2ecbe5c5ac28",
  • "name": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "created_by_type": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "updated_by": "string",
  • "updated_by_type": "string",
  • "deleted": true,
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_by": "string",
  • "deleted_by_type": "string",
  • "value": { },
  • "trigger_uuid": "43e2987b-434b-472d-969b-3472dba75b7d"
}

Create an event for a specific trigger configuration

The following permissions are required:

  • SYMPHONY_WRITE_PLAYBOOK_RUNS (d3791fbf-0752-4a50-ab67-0eb8345d1762): Re-run playbook and playbook runs.
Authorizations:
accessToken
path Parameters
uuid
required
string
query Parameters
name
string

Display name for the event

event
required
object

Event to create

directory
string

(Relative) File Directory to add to the event

playbook_uuid
string
Default: null

Start only this playbook, which should reference this trigger configuration

Responses

Edit an event for a specific trigger configuration

The following permissions are required:

  • SYMPHONY_WRITE_PLAYBOOKS (1d231a6b-9010-4fa1-a9cc-9fafeabb60a0): Create, edit, delete playbook and playbook settings. Manage playbook activation.
Authorizations:
accessToken
path Parameters
uuid
required
string
query Parameters
name
string

Name of the node configuration

value
object

The node's configuration

module_configuration_uuid
string

The uuid from the module configuration

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "community_uuid": "e391588b-4c35-45eb-a5af-211fba0cde08",
  • "module_configuration_uuid": "d0b95458-227e-4b75-a872-2ecbe5c5ac28",
  • "name": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "created_by_type": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "updated_by": "string",
  • "updated_by_type": "string",
  • "deleted": true,
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_by": "string",
  • "deleted_by_type": "string",
  • "value": { },
  • "trigger_uuid": "43e2987b-434b-472d-969b-3472dba75b7d"
}

Delete a specific trigger configuration

The following permissions are required:

  • SYMPHONY_WRITE_PLAYBOOKS (1d231a6b-9010-4fa1-a9cc-9fafeabb60a0): Create, edit, delete playbook and playbook settings. Manage playbook activation.
Authorizations:
accessToken
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "community_uuid": "e391588b-4c35-45eb-a5af-211fba0cde08",
  • "module_configuration_uuid": "d0b95458-227e-4b75-a872-2ecbe5c5ac28",
  • "name": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "created_by_type": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "updated_by": "string",
  • "updated_by_type": "string",
  • "deleted": true,
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_by": "string",
  • "deleted_by_type": "string",
  • "value": { },
  • "trigger_uuid": "43e2987b-434b-472d-969b-3472dba75b7d"
}

Create an event for a specific trigger configuration

Authorizations:
accessToken
path Parameters
uuid
required
string
query Parameters
name
string

Display name for the event

event
required
object

Event to create

directory
string

(Relative) File Directory to add to the event

playbook_uuid
string
Default: null

Start only this playbook, which should reference this trigger configuration

Responses

get_trigger_logs

The following permissions are required:

  • SYMPHONY_READ_PLAYBOOK_RUNS (9648daab-0c06-4624-b610-0b69a06d95df): View playbook runs, node runs and associated logs.
Authorizations:
accessToken
path Parameters
uuid
required
string
query Parameters
limit
integer
Default: 20
offset
integer
Default: 0
match[log_level]
string

Match logs by their log level

match[message]
string

Match logs the content of the message

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "errors": 0
}

Add the logs of a trigger to the database

Authorizations:
accessToken
path Parameters
uuid
required
string
query Parameters
Array of objects

Responses

Get a specific trigger configuration secrets given its UUID

Authorizations:
accessToken
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "value": { }
}

Update the status for the trigger configuration

The following permissions are required:

  • SYMPHONY_WRITE_PLAYBOOKS (1d231a6b-9010-4fa1-a9cc-9fafeabb60a0): Create, edit, delete playbook and playbook settings. Manage playbook activation.
Authorizations:
accessToken
path Parameters
uuid
required
string
query Parameters
status
required
string
Enum: "running" "stopped" "starting" "stopping" "error"

The status of the node configuration

reason
string

The reason of the status for the node configuration

Responses

Update the trigger configuration webhook

Authorizations:
accessToken
path Parameters
uuid
required
string
token
required
string

Responses

Actions

List actions available to create playbooks and get information about specific ones.

This namespace also contains some admin level endpoints to manage available actions (which requires the SYMPHONY_ADMIN_WRITE_MODULES permission).

List available actions available to create playbooks

The following permissions are required:

  • SYMPHONY_READ_MODULES (b7413c71-cec8-49ec-9b9c-327ee328a383): View integration modules.
Authorizations:
accessToken
query Parameters
limit
integer [ 1 .. 100 ]
Default: 20

limit a number of items (allowed range is 1-100), default is 20.

offset
integer >= 0
Default: 0

a number of items to skip, default is 0.

match[name]
string

Action's name.

match[docker]
string

Match actions by their docker image name.

match[uuid]
string

Match actions by their uuid.

sort
string
Default: "name"
Enum: "name" "module_name"

Sort returned actions (accepted values: 'name', module_name')

direction
string
Default: "desc"
Enum: "asc" "desc"

Direction of the sort (accepted values: ('asc', 'desc'))

extended
boolean
Default: false

Returns the extended version of the actions

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0
}

Creates a new action

This is an administration endpoint, only available to people that has the SYMPHONY_ADMIN_WRITE_MODULES permission.

The following permissions are required:

  • SYMPHONY_ADMIN_WRITE_MODULES (a5379397-3d5a-4cc6-b698-715de3ebd4ac): Create or update available automation modules in the platform.
Authorizations:
accessToken
query Parameters
uuid
string

The uuid assigned to the action.

module_uuid
required
string

The action's module uuid

name
required
string

The name of the action

description
string

The description of the action

docker
required
string

The docker's name

docker_parameters
string

The parameters for Docker

arguments
object

The action's arguments

outputs
object

The action's outputs

results
object

The action's results.

template
string

The template to display the result of an action execution

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "description": "string",
  • "docker": "string",
  • "docker_parameters": "string",
  • "outputs": { },
  • "module_uuid": "string",
  • "arguments": { },
  • "results": { },
  • "template": "string"
}

Get a specific action

The following permissions are required:

  • SYMPHONY_READ_MODULES (b7413c71-cec8-49ec-9b9c-327ee328a383): View integration modules.
Authorizations:
accessToken
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "description": "string",
  • "docker": "string",
  • "docker_parameters": "string",
  • "outputs": { },
  • "module_uuid": "string",
  • "arguments": { },
  • "results": { },
  • "template": "string"
}

Update a specific action

This is an administration endpoint, only available to people that has the SYMPHONY_ADMIN_WRITE_MODULES permission.

The following permissions are required:

  • SYMPHONY_ADMIN_WRITE_MODULES (a5379397-3d5a-4cc6-b698-715de3ebd4ac): Create or update available automation modules in the platform.
Authorizations:
accessToken
path Parameters
uuid
required
string
query Parameters
name
string

The name of the action

description
string

The description of the action

docker
string

The docker's name

docker_parameters
string

The parameters for Docker

arguments
object

The action's arguments

outputs
object

The action's outputs

results
object

The action's results

template
string

The template to display the result of an action execution

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "description": "string",
  • "docker": "string",
  • "docker_parameters": "string",
  • "outputs": { },
  • "module_uuid": "string",
  • "arguments": { },
  • "results": { },
  • "template": "string"
}

Run a standalone action

The following permissions are required:

  • SYMPHONY_RUN_SINGLE_ACTION (eea32165-d596-4673-8ac5-2941e073b59b): Execute in standalone a single playbook action
Authorizations:
accessToken
path Parameters
uuid
required
string
query Parameters
module_configuration_uuid
string <uuid>

UUID of the module configuration to use to run the action

arguments
required
object

Arguments to use to execute the action

Responses

Response samples

Content type
application/json
{
  • "node_run_uuid": "string"
}

Triggers

Triggers management endpoint

List existing Triggers

The following permissions are required:

  • SYMPHONY_READ_MODULES (b7413c71-cec8-49ec-9b9c-327ee328a383): View integration modules.
Authorizations:
accessToken
query Parameters
limit
integer [ 1 .. 100 ]
Default: 20

limit a number of items (allowed range is 1-100), default is 20.

offset
integer >= 0
Default: 0

a number of items to skip, default is 0.

match[name]
string

Match node or module name.

match[docker]
string

Match Nodes by their docker image name.

sort
string
Default: "name"
Enum: "name" "module_name"

Sort returned Nodes (accepted values: 'name', module_name')

direction
string
Default: "desc"
Enum: "asc" "desc"

Direction of the sort (accepted values: ('asc', 'desc'))

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0
}

Creates a Trigger

The following permissions are required:

  • SYMPHONY_ADMIN_WRITE_MODULES (a5379397-3d5a-4cc6-b698-715de3ebd4ac): Create or update available automation modules in the platform.
Authorizations:
accessToken
query Parameters
name
string

The name of the node

description
string

The description of the node

docker
string

The docker's name

docker_parameters
string

The parameters for Docker

arguments
object

The node's arguments

uuid
string

The uuid assigned to the new node

module_uuid
required
string

The node's module uuid

webhook
boolean

The Trigger is a webhook (push)

outputs
object

The trigger's outputs

results
object

The trigger's results

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "description": "string",
  • "docker": "string",
  • "docker_parameters": "string",
  • "module_uuid": "string",
  • "community_uuid": "string",
  • "arguments": { },
  • "webhook": true,
  • "outputs": { },
  • "results": { }
}

Get a specific Trigger

The following permissions are required:

  • SYMPHONY_READ_MODULES (b7413c71-cec8-49ec-9b9c-327ee328a383): View integration modules.
Authorizations:
accessToken
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "description": "string",
  • "docker": "string",
  • "docker_parameters": "string",
  • "module_uuid": "string",
  • "community_uuid": "string",
  • "arguments": { },
  • "webhook": true,
  • "outputs": { },
  • "results": { }
}

Update a specific trigger

The following permissions are required:

  • SYMPHONY_ADMIN_WRITE_MODULES (a5379397-3d5a-4cc6-b698-715de3ebd4ac): Create or update available automation modules in the platform.
Authorizations:
accessToken
path Parameters
uuid
required
string
query Parameters
name
string

The name of the node

description
string

The description of the node

docker
string

The docker's name

docker_parameters
string

The parameters for Docker

arguments
object

The node's arguments

webhook
boolean

The Trigger is a webhook (push)

outputs
object

The trigger's outputs

results
object

The trigger's results

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "description": "string",
  • "docker": "string",
  • "docker_parameters": "string",
  • "module_uuid": "string",
  • "community_uuid": "string",
  • "arguments": { },
  • "webhook": true,
  • "outputs": { },
  • "results": { }
}

Modules

Modules management endpoint

List existing Modules

The following permissions are required:

  • SYMPHONY_READ_MODULES (b7413c71-cec8-49ec-9b9c-327ee328a383): View integration modules.
Authorizations:
accessToken
query Parameters
limit
integer [ 1 .. 100 ]
Default: 20

limit a number of items (allowed range is 1-100), default is 20.

offset
integer >= 0
Default: 0

a number of items to skip, default is 0.

match[name]
string

Module's name.

match[uuid]
string

Match modules by their uuid.

kind
string
Default: "both"

Filter for kind of modules

match[category]
string

Only return modules that match a given category

match[content_type]
string

Only return modules that match a given content type

match[release_status]
string

Only return modules that match a given release status

sort
string
Default: "name"

Order modules.

direction
string
Default: "asc"

Direction of the sort (accepted values: ('asc', 'desc'))

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0
}

Creates a Module

The following permissions are required:

  • SYMPHONY_ADMIN_WRITE_MODULES (a5379397-3d5a-4cc6-b698-715de3ebd4ac): Create or update available automation modules in the platform.
Authorizations:
accessToken
query Parameters
description
string

The module's description

docker
string

The module's docker image

image
string

The module's logo (as a Data URI)

configuration
object

The module's configuration

changelog
string

The changelog of the module

categories
Array of strings
Items Enum: "Applicative" "Email" "Generic" "IAM" "Cloud Providers" "Endpoint" "Network" "Threat Intelligence" "Collaboration Tools"

The categories of the module

supports_validation
boolean

The module supports online validation

version
string

The module's version

uuid
string

The uuid assigned to the module.

name
required
string

The module's name

release_status
string
Default: "published"

Responses

get_module_categories_resource

The following permissions are required:

  • SYMPHONY_READ_MODULES (b7413c71-cec8-49ec-9b9c-327ee328a383): View integration modules.
Authorizations:
accessToken

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0
}

Create a module from a git repository

The following permissions are required:

  • SYMPHONY_WRITE_CUSTOM_MODULES (f98b60dc-49e9-4587-8732-4ab2a1fa5723): Create, update or delete a custom integration module
Authorizations:
accessToken
query Parameters
git
required
string

The git repository to clone.

branch
string

The branch to checkout.

path
string

The path to the module.

ssh_key_id
string <uuid>

The SSH key to use for cloning the repository.

Responses

Response samples

Content type
application/json
{
  • "task_uuid": "string"
}

Validate a module URL

The following permissions are required:

  • SYMPHONY_READ_MODULES (b7413c71-cec8-49ec-9b9c-327ee328a383): View integration modules.
Authorizations:
accessToken
query Parameters
url
required
string

The URL of the module Git repository to validate.

ssh_key_id
string <uuid>

The SSH key to use for accessing the repository.

Responses

Response samples

Content type
application/json
{
  • "branches": "string"
}

Get a specific Module

The following permissions are required:

  • SYMPHONY_READ_MODULES (b7413c71-cec8-49ec-9b9c-327ee328a383): View integration modules.
Authorizations:
accessToken
path Parameters
module_uuid
required
string
query Parameters
detailed
boolean
Default: false

Return the fully detailed module

Responses

Edit a specific module

The following permissions are required:

  • SYMPHONY_ADMIN_WRITE_MODULES (a5379397-3d5a-4cc6-b698-715de3ebd4ac): Create or update available automation modules in the platform.
Authorizations:
accessToken
path Parameters
module_uuid
required
string
query Parameters
description
string

The module's description

docker
string

The module's docker image

image
string

The module's logo (as a Data URI)

configuration
object

The module's configuration

changelog
string

The changelog of the module

categories
Array of strings
Items Enum: "Applicative" "Email" "Generic" "IAM" "Cloud Providers" "Endpoint" "Network" "Threat Intelligence" "Collaboration Tools"

The categories of the module

supports_validation
boolean

The module supports online validation

version
string

The module's version

name
string

The module's name

release_status
string

New release status for the module

Responses

Delete the target module if not in use

The following permissions are required:

  • SYMPHONY_WRITE_CUSTOM_MODULES (f98b60dc-49e9-4587-8732-4ab2a1fa5723): Create, update or delete a custom integration module
Authorizations:
accessToken
path Parameters
module_uuid
required
string

Responses

Verify if a custom module has available changes

The following permissions are required:

  • SYMPHONY_WRITE_CUSTOM_MODULES (f98b60dc-49e9-4587-8732-4ab2a1fa5723): Create, update or delete a custom integration module
Authorizations:
accessToken
path Parameters
module_uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "task_uuid": "string"
}

Update a module to latest version

The following permissions are required:

  • SYMPHONY_WRITE_CUSTOM_MODULES (f98b60dc-49e9-4587-8732-4ab2a1fa5723): Create, update or delete a custom integration module
Authorizations:
accessToken
path Parameters
module_uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "task_uuid": "string"
}

Module Configurations

Manage Module Configurations

List existing module configurations

The following permissions are required:

  • SYMPHONY_READ_PLAYBOOKS (e75117b9-bb99-4248-8e1d-77c0914b15bd): View playbook listing and details
Authorizations:
accessToken
query Parameters
match[community_uuid]
string

Communities to match (separated by commas).

limit
integer [ 1 .. 100 ]
Default: 20

limit a number of items (allowed range is 1-100), default is 20.

offset
integer >= 0
Default: 0

a number of items to skip, default is 0.

date[created_at]
string

Match module configurations by their last updater (separated by commas).

date[updated_at]
string

Filter module configurations by their update date (see rfc3339).

match[name]
string

filter by module configuration names.

match[module_uuid]
string

filter by module uuid.

sort
string
Default: "updated_at"
Enum: "updated_at" "created_at" "name"

Sort module configurations by one of their attributes

direction
string
Default: "desc"
Enum: "asc" "desc"

Direction of the sort.

with_module
boolean
Default: false

Also return the module of the configuration

community_uuid
string

UUID of the community

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0
}

Create a new module configuration

The following permissions are required:

  • SYMPHONY_WRITE_PLAYBOOKS (1d231a6b-9010-4fa1-a9cc-9fafeabb60a0): Create, edit, delete playbook and playbook settings. Manage playbook activation.
Authorizations:
accessToken
query Parameters
name
required
string

The name of the module configuration

value
object

The value of the configuration for the module configuration

module_uuid
required
string

The uuid from the module which owns the module configuration

community_uuid
string

UUID of the community

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "community_uuid": "e391588b-4c35-45eb-a5af-211fba0cde08",
  • "module_uuid": "26df6d76-e745-4655-aeb6-dba7832efb9f",
  • "name": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "created_by_type": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "updated_by": "string",
  • "updated_by_type": "string",
  • "deleted": true,
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_by": "string",
  • "deleted_by_type": "string",
  • "value": { },
  • "secrets": null
}

Create a new ModuleConfigurationValidation

The following permissions are required:

  • SYMPHONY_WRITE_PLAYBOOKS (1d231a6b-9010-4fa1-a9cc-9fafeabb60a0): Create, edit, delete playbook and playbook settings. Manage playbook activation.
Authorizations:
accessToken
query Parameters
value
required
object

The configuration to validate

module_uuid
required
string

The module the configuration to validate belongs to

module_configuration_uuid
string

The existing module configuration if any

Responses

Response samples

Content type
application/json
{
  • "task_uuid": "string"
}

Update a specific ModuleConfigurationValidation

Authorizations:
accessToken
path Parameters
uuid
required
string
query Parameters
status
required
string
Enum: "running" "finished"

Status of the Action Run

results
object

Action Run's Results

outputs
object

Action Run's Outputs (playbook branches)

error
string

Error raised during execution

logs
string

Action Run's logs

secrets
object

Action run secrets to update

need_secrets
boolean

Ask for secrets in the response

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "node_type": "string",
  • "node_id": 0,
  • "parent_node_run_id": 0,
  • "iteration": 0,
  • "status": "string",
  • "error": "string",
  • "started_at": "2019-08-24T14:15:22Z",
  • "pending_at": "2019-08-24T14:15:22Z",
  • "running_at": "2019-08-24T14:15:22Z",
  • "finished_at": "2019-08-24T14:15:22Z",
  • "arguments": { },
  • "outputs": { },
  • "results": { },
  • "logs": "string",
  • "module_configuration": {
    }
}

Get a specific module configuration

The following permissions are required:

  • SYMPHONY_READ_PLAYBOOKS (e75117b9-bb99-4248-8e1d-77c0914b15bd): View playbook listing and details
Authorizations:
accessToken
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "community_uuid": "e391588b-4c35-45eb-a5af-211fba0cde08",
  • "module_uuid": "26df6d76-e745-4655-aeb6-dba7832efb9f",
  • "name": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "created_by_type": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "updated_by": "string",
  • "updated_by_type": "string",
  • "deleted": true,
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_by": "string",
  • "deleted_by_type": "string",
  • "value": { },
  • "secrets": null
}

Update a specific module configuration

The following permissions are required:

  • SYMPHONY_WRITE_PLAYBOOKS (1d231a6b-9010-4fa1-a9cc-9fafeabb60a0): Create, edit, delete playbook and playbook settings. Manage playbook activation.
Authorizations:
accessToken
path Parameters
uuid
required
string
query Parameters
name
string

Name of the module configuration

value
object

The module's configuration

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "community_uuid": "e391588b-4c35-45eb-a5af-211fba0cde08",
  • "module_uuid": "26df6d76-e745-4655-aeb6-dba7832efb9f",
  • "name": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "created_by_type": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "updated_by": "string",
  • "updated_by_type": "string",
  • "deleted": true,
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_by": "string",
  • "deleted_by_type": "string",
  • "value": { },
  • "secrets": null
}

Delete a specific module configuration

The following permissions are required:

  • SYMPHONY_WRITE_PLAYBOOKS (1d231a6b-9010-4fa1-a9cc-9fafeabb60a0): Create, edit, delete playbook and playbook settings. Manage playbook activation.
Authorizations:
accessToken
path Parameters
uuid
required
string

Responses

Get a specific module configuration

The following permissions are required:

  • SYMPHONY_READ_PLAYBOOKS (e75117b9-bb99-4248-8e1d-77c0914b15bd): View playbook listing and details
Authorizations:
accessToken
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "actions": 0,
  • "triggers": 0,
  • "playbooks": 0,
  • "connectors": 0
}

Node Runs

Access Node Runs

Get details about a specific Node Run

The following permissions are required:

  • SYMPHONY_READ_PLAYBOOK_RUNS (9648daab-0c06-4624-b610-0b69a06d95df): View playbook runs, node runs and associated logs.
Authorizations:
accessToken
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "node_type": "string",
  • "node_id": 0,
  • "parent_node_run_id": 0,
  • "iteration": 0,
  • "status": "string",
  • "error": "string",
  • "started_at": "2019-08-24T14:15:22Z",
  • "pending_at": "2019-08-24T14:15:22Z",
  • "running_at": "2019-08-24T14:15:22Z",
  • "finished_at": "2019-08-24T14:15:22Z",
  • "arguments": { },
  • "outputs": { },
  • "results": { },
  • "logs": "string"
}

Statistics

Counters of resources in Symphony

List statistics of playbook runs per playbook uuid

The following permissions are required:

  • SYMPHONY_READ_PLAYBOOK_RUNS_STATS (ae0bc327-8f27-419e-890f-3083c4c56f0b): View playbook runs statistics in playbook listing.
Authorizations:
accessToken
query Parameters
match[community_uuid]
string

Communities to match (separated by commas).

limit
integer [ 1 .. 100 ]
Default: 20

limit a number of items (allowed range is 1-100), default is 20.

offset
integer >= 0
Default: 0

a number of items to skip, default is 0.

match[playbook_uuid]
required
string non-empty

Match statistics by the playbook's uuid (separated by commas).

date[started_at]
string

Match playbook runs by their started and finished dates (separated by commas).

Responses

Response samples

Content type
application/json
{
  • "items": { },
  • "total": 0
}

Connectors

Connectors management endpoint

List existing Connectors

The following permissions are required:

  • SYMPHONY_READ_MODULES (b7413c71-cec8-49ec-9b9c-327ee328a383): View integration modules.
Authorizations:
accessToken
query Parameters
limit
integer [ 1 .. 100 ]
Default: 20

limit a number of items (allowed range is 1-100), default is 20.

offset
integer >= 0
Default: 0

a number of items to skip, default is 0.

match[name]
string

Match node or module name.

match[docker]
string

Match Nodes by their docker image name.

sort
string
Default: "name"
Enum: "name" "module_name"

Sort returned Nodes (accepted values: 'name', module_name')

direction
string
Default: "desc"
Enum: "asc" "desc"

Direction of the sort (accepted values: ('asc', 'desc'))

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0
}

Creates a Connector

The following permissions are required:

  • SYMPHONY_ADMIN_WRITE_MODULES (a5379397-3d5a-4cc6-b698-715de3ebd4ac): Create or update available automation modules in the platform.
Authorizations:
accessToken
query Parameters
name
string

The name of the node

description
string

The description of the node

docker
string

The docker's name

docker_parameters
string

The parameters for Docker

arguments
object

The node's arguments

uuid
string

The uuid assigned to the new node

module_uuid
required
string

The node's module uuid

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "description": "string",
  • "docker": "string",
  • "docker_parameters": "string",
  • "module_uuid": "string",
  • "community_uuid": "string",
  • "arguments": { }
}

Get a specific Connector

The following permissions are required:

  • SYMPHONY_READ_MODULES (b7413c71-cec8-49ec-9b9c-327ee328a383): View integration modules.
Authorizations:
accessToken
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "description": "string",
  • "docker": "string",
  • "docker_parameters": "string",
  • "module_uuid": "string",
  • "community_uuid": "string",
  • "arguments": { }
}

Update a specific connector

The following permissions are required:

  • SYMPHONY_ADMIN_WRITE_MODULES (a5379397-3d5a-4cc6-b698-715de3ebd4ac): Create or update available automation modules in the platform.
Authorizations:
accessToken
path Parameters
uuid
required
string
query Parameters
name
string

The name of the node

description
string

The description of the node

docker
string

The docker's name

docker_parameters
string

The parameters for Docker

arguments
object

The node's arguments

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "description": "string",
  • "docker": "string",
  • "docker_parameters": "string",
  • "module_uuid": "string",
  • "community_uuid": "string",
  • "arguments": { }
}

Connector Configurations

Manage Connector Configurations

List existing Connector Configurations

The following permissions are required:

  • SIC_READ_INTAKES (2f0da527-2cf1-4a00-8f4c-033bfb43ddeb): View intakes listing and details.
Authorizations:
accessToken
query Parameters
match[community_uuid]
string

Communities to match (separated by commas).

limit
integer [ 1 .. 100 ]
Default: 20

limit a number of items (allowed range is 1-100), default is 20.

offset
integer >= 0
Default: 0

a number of items to skip, default is 0.

match[uuid]
string

Filter connector configuration by their uuid

date[created_at]
string

Match node configurations by their last updater (separated by commas).

date[updated_at]
string

Filter node configurations by their update date (see rfc3339).

sort
string
Default: "display_status"
Enum: "display_status" "updated_at" "created_at" "connector_id" "name"

Sort connector configurations by one of their attributes

direction
string
Default: "desc"
Enum: "asc" "desc"

Direction of the sort.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0
}

Create a connector configuration

It will be started automatically once created

The following permissions are required:

  • SIC_WRITE_INTAKES (efde546e-06db-4355-b2e5-84de1f66511b): Create, edit, delete intakes.
Authorizations:
accessToken
query Parameters
name
required
string

The name of the node configuration

value
object

The value of the configuration for the node configuration

module_configuration_uuid
string

The uuid from the module configuration

community_uuid
string

UUID of the community

connector_uuid
required
string

The uuid from the connector which owns the connector configuration

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "community_uuid": "e391588b-4c35-45eb-a5af-211fba0cde08",
  • "module_configuration_uuid": "d0b95458-227e-4b75-a872-2ecbe5c5ac28",
  • "name": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "created_by_type": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "updated_by": "string",
  • "updated_by_type": "string",
  • "deleted": true,
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_by": "string",
  • "deleted_by_type": "string",
  • "value": { },
  • "connector_uuid": "6aada80a-d1c0-4a33-8cfa-1aaa169f9723",
  • "display_status": null
}

Get a specific connector configuration given its UUID

The following permissions are required:

  • SIC_READ_INTAKES (2f0da527-2cf1-4a00-8f4c-033bfb43ddeb): View intakes listing and details.
Authorizations:
accessToken
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "community_uuid": "e391588b-4c35-45eb-a5af-211fba0cde08",
  • "module_configuration_uuid": "d0b95458-227e-4b75-a872-2ecbe5c5ac28",
  • "name": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "created_by_type": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "updated_by": "string",
  • "updated_by_type": "string",
  • "deleted": true,
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_by": "string",
  • "deleted_by_type": "string",
  • "value": { },
  • "connector_uuid": "6aada80a-d1c0-4a33-8cfa-1aaa169f9723",
  • "display_status": null
}

Edit a specific connector configuration

The following permissions are required:

  • SIC_WRITE_INTAKES (efde546e-06db-4355-b2e5-84de1f66511b): Create, edit, delete intakes.
Authorizations:
accessToken
path Parameters
uuid
required
string
query Parameters
name
string

Name of the node configuration

value
object

The node's configuration

module_configuration_uuid
string

The uuid from the module configuration

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "community_uuid": "e391588b-4c35-45eb-a5af-211fba0cde08",
  • "module_configuration_uuid": "d0b95458-227e-4b75-a872-2ecbe5c5ac28",
  • "name": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "created_by_type": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "updated_by": "string",
  • "updated_by_type": "string",
  • "deleted": true,
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_by": "string",
  • "deleted_by_type": "string",
  • "value": { },
  • "connector_uuid": "6aada80a-d1c0-4a33-8cfa-1aaa169f9723",
  • "display_status": null
}

Delete a specific connector configuration

The following permissions are required:

  • SIC_WRITE_INTAKES (efde546e-06db-4355-b2e5-84de1f66511b): Create, edit, delete intakes.
Authorizations:
accessToken
path Parameters
uuid
required
string

Responses

get_connector_logs

The following permissions are required:

  • SIC_READ_INTAKES (2f0da527-2cf1-4a00-8f4c-033bfb43ddeb): View intakes listing and details.
Authorizations:
accessToken
path Parameters
uuid
required
string
query Parameters
limit
integer
Default: 20
offset
integer
Default: 0
match[log_level]
string

Match logs by their log level

match[message]
string

Match logs the content of the message

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "errors": 0
}

Add the logs of a connector to the database

Authorizations:
accessToken
path Parameters
uuid
required
string
query Parameters
Array of objects

Responses

Get a specific connector configuration secrets given its UUID

Authorizations:
accessToken
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "value": { }
}

Start a specific connector configuration secrets given its UUID

The following permissions are required:

  • SIC_WRITE_INTAKES (efde546e-06db-4355-b2e5-84de1f66511b): Create, edit, delete intakes.
Authorizations:
accessToken
path Parameters
uuid
required
string

Responses

Update the status for the connector configuration

The following permissions are required:

  • SIC_WRITE_INTAKES (efde546e-06db-4355-b2e5-84de1f66511b): Create, edit, delete intakes.
Authorizations:
accessToken
path Parameters
uuid
required
string
query Parameters
status
required
string
Enum: "running" "stopped" "starting" "stopping" "error"

The status of the node configuration

reason
string

The reason of the status for the node configuration

Responses

Stop a specific connector configuration secrets given its UUID

The following permissions are required:

  • SIC_WRITE_INTAKES (efde546e-06db-4355-b2e5-84de1f66511b): Create, edit, delete intakes.
Authorizations:
accessToken
path Parameters
uuid
required
string

Responses

Changes

Review planned migrations

List changes that will be applied for the migration 202406-1

The following permissions are required:

  • SYMPHONY_READ_PLAYBOOKS (e75117b9-bb99-4248-8e1d-77c0914b15bd): View playbook listing and details
Authorizations:
accessToken

Responses

Response samples

Content type
application/json
{
  • "changes": {
    },
  • "manual_migration_may_be_needed": {
    }
}

SSH Keys

Manage SSH keys used for integrations

Generate a new SSH key pair

The following permissions are required:

  • SYMPHONY_WRITE_CUSTOM_MODULES (f98b60dc-49e9-4587-8732-4ab2a1fa5723): Create, update or delete a custom integration module
Authorizations:
accessToken

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "public_key": "string"
}