Actions

Get Actions

get

Get all Actions in a configuration

Path parameters
configstringRequired
Responses
200

Actions retrieved successfully

application/json
get
/api/v4.0/conf/{config}/actions

Modify Actions

put

Update an existing set of Actions for a configuration

Path parameters
configstringRequired
Bodyobject · Action[]
descriptionstringOptional
idstringRequired
namestring · min: 1Required
paramsany ofOptionalDefault: {}
or
objectOptional
tagsstring[]Optional

List of tags to apply

Default: []
typeall ofRequired

Need to be one of predefined strings

string · enumOptionalPossible values:
Responses
200

Actions updated successfully

application/json
put
/api/v4.0/conf/{config}/actions

Create Actions

post

Create complete set of Actions for a configuration

Path parameters
configstringRequired
Bodyobject · Action[]
descriptionstringOptional
idstringRequired
namestring · min: 1Required
paramsany ofOptionalDefault: {}
or
objectOptional
tagsstring[]Optional

List of tags to apply

Default: []
typeall ofRequired

Need to be one of predefined strings

string · enumOptionalPossible values:
Responses
post
/api/v4.0/conf/{config}/actions

Delete Actions

delete

Delete all Actions in a configuration

Path parameters
configstringRequired
Responses
200

Actions deleted successfully

application/json
delete
/api/v4.0/conf/{config}/actions

Get single Action

get

Get an individual Action from the specified configuration

Path parameters
configstringRequired
entry_idstringRequired
Responses
200

Action retrieved successfully

application/json
get
/api/v4.0/conf/{config}/actions/{entry_id}

Modify a single Action

put

Update an individual Action within a configuration

Path parameters
configstringRequired
entry_idstringRequired
Body
descriptionstringOptional
idstringRequired
namestring · min: 1Required
paramsany ofOptionalDefault: {}
or
objectOptional
tagsstring[]Optional

List of tags to apply

Default: []
typeall ofRequired

Need to be one of predefined strings

string · enumOptionalPossible values:
Responses
200

Action updated successfully

application/json
put
/api/v4.0/conf/{config}/actions/{entry_id}

Create single Action

post

Create an individual Action within a configuration

Path parameters
configstringRequired
entry_idstringRequired
Body
descriptionstringOptional
idstringRequired
namestring · min: 1Required
paramsany ofOptionalDefault: {}
or
objectOptional
tagsstring[]Optional

List of tags to apply

Default: []
typeall ofRequired

Need to be one of predefined strings

string · enumOptionalPossible values:
Responses
200

Action created successfully

application/json
post
/api/v4.0/conf/{config}/actions/{entry_id}

Delete single Action

delete

Delete an individual Action from the specified configuration

Path parameters
configstringRequired
entry_idstringRequired
Responses
200

Action deleted successfully

application/json
delete
/api/v4.0/conf/{config}/actions/{entry_id}

Get Actions version list

get

Get list of versions of Actions in a configuration

Path parameters
configstringRequired
Responses
200

Actions version list retrieved successfully

application/json
get
/api/v4.0/conf/{config}/actions/versions

Get version of Actions

get

Get a specific version of an Action

Path parameters
configstringRequired
versionstringRequired
Responses
200

Action version retrieved successfully

application/json
get
/api/v4.0/conf/{config}/actions/versions/{version}

Revert Actions to the specified version

put

Set a previous Actions version to be the current one

Path parameters
configstringRequired
versionstringRequired
Responses
200

Actions reversion was successful

application/json
put
/api/v4.0/conf/{config}/actions/versions/{version}/revert

Last updated

Was this helpful?