STstackstorm

GET /api/v1/triggerinstances

Changed on

Returns a list of all trigger instances.

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 trigger instances to get

offsetinteger

Number of trigger instances to offset

sortstring

Comma-separated list of fields to sort by

idstring[]

Entity id filter

namestring[]

Entity name filter

triggerstring

Trigger filter

timestamp_ltstring

Start timestamp less than filter

timestamp_gtstring

Start timestamp greater than filter

trigger_typestring

Trigger type filter

Response

List of trigger instances

TriggerInstance[] required

Changes

  • c0497a4b2f4cRevision changes
    • info

      added the new optional query request parameter exclude_attributes

    • info

      added the new optional query request parameter include_attributes

  • 151a4b93037bRevision changes
    • info

      added the new optional query request parameter trigger_type