STstackstorm

GET /api/v1/actions/{ref_or_id}

Get one action.

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

Path parameters

ref_or_idstring required

Entity reference or id

Response

Action requested

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

No recorded changes to this operation across all 73 revisions of this API.