STstackstorm

GET /api/v1/actions/views/overview

Changed on

Returns a list of all the actions with runner parameters included.

Request

  • The document declares no server URL.
  • Auth
    • API key in header X-Auth-Token
    • or API key in header St2-Api-Key
    • or API key in query parameter x-auth-token
    • or API key in query parameter st2-api-key
    • or API key in header auth-token

Query parameters

exclude_attributesstring[]

List of attributes to exclude

include_attributesstring[]

List of attributes to include

limitinteger

Number of actions to get

offsetinteger

Number of actions to offset

idstring

Action id filter

namestring

Action name filter

packstring

Action pack name filter

Response

List of actions

idstring

The unique identifier for the action.

refstring

System computed user friendly reference for the action. Provided value will be overridden by computed value.

uidstring
namestring required

The name of the action.

descriptionstring

The description of the action.

enabledboolean

Enable or disable the action from invocation.

runner_typestring required

The type of runner that executes the action.

entry_pointstring

The entry point for the action.

packstring

The content pack this action belongs to.

parametersActionParametersSubSchema

Input parameters for the action.

tagsobject[]

User associated metadata assigned to this object.

Changes

  • 3195fd6c5c34Revision changes
    • info

      api operation id st2api.controllers.v1.actionviews:overview_controller.get_all removed and replaced with st2api.controllers.v1.action_views:overview_controller.get_all