Skip to main content

List Executions

POST 
/v2beta/actions/executions/_search

List all matching executions. By default all executions of the instance are returned that have at least one execution target. Make sure to include a limit and sorting for pagination.

Required permission:

  • action.execution.read

Required feature flag:

  • actions

Request​

Query Parameters

    pagination.offset uint64

    Starting point for retrieval, in combination of offset used to query a set list of objects.

    pagination.limit int64

    limit is the maximum amount of objects returned. The default is set to 100 with a maximum of 1000 in the runtime configuration. If the limit exceeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken.

    pagination.asc boolean

    Asc is the sorting order. If true the list is sorted ascending, if false the list is sorted descending. The default is descending.

    sortingColumn string

    Possible values: [EXECUTION_FIELD_NAME_UNSPECIFIED, EXECUTION_FIELD_NAME_ID, EXECUTION_FIELD_NAME_CREATED_DATE, EXECUTION_FIELD_NAME_CHANGED_DATE]

    Default value: EXECUTION_FIELD_NAME_UNSPECIFIED

    The field the result is sorted by. The default is the creation date. Beware that if you change this, your result pagination might be inconsistent.

Responses​

A list of all non noop executions matching the query

Schema

    pagination

    object

    totalResult uint64

    Absolute number of objects matching the query, regardless of applied limit.

    appliedLimit uint64

    Applied limit from query, defines maximum amount of objects per request, to compare if all objects are returned.

    result

    object[]

  • Array [

    • condition

    object

    request

    object

    Condition-type to execute if a request on the defined API point happens.

    method string

    Possible values: non-empty and <= 1000 characters

    GRPC-method as condition.

    service string

    Possible values: non-empty and <= 1000 characters

    GRPC-service as condition.

    all boolean

    All calls to any available services and methods as condition.

    response

    object

    Condition-type to execute on response if a request on the defined API point happens.

    method string

    Possible values: non-empty and <= 1000 characters

    GRPC-method as condition.

    service string

    Possible values: non-empty and <= 1000 characters

    GRPC-service as condition.

    all boolean

    All calls to any available services and methods as condition.

    function

    object

    Condition-type to execute if function is used, replaces actions v1.

    name string

    event

    object

    Condition-type to execute if an event is created in the system.

    event string

    Possible values: non-empty and <= 1000 characters

    Event name as condition.

    group string

    Possible values: non-empty and <= 1000 characters

    Event group as condition, all events under this group.

    all boolean

    all events as condition.

    creationDate date-time

    The timestamp of the execution creation.

    changeDate date-time

    The timestamp of the last change to the execution.

    targets

    object[]

    Ordered list of targets/includes called during the execution.

  • Array [

    • target string

    Unique identifier of existing target to call.

    include

    object

    Unique identifier of existing execution to include targets of.

    request

    object

    Condition-type to execute if a request on the defined API point happens.

    method string

    Possible values: non-empty and <= 1000 characters

    GRPC-method as condition.

    service string

    Possible values: non-empty and <= 1000 characters

    GRPC-service as condition.

    all boolean

    All calls to any available services and methods as condition.

    response

    object

    Condition-type to execute on response if a request on the defined API point happens.

    method string

    Possible values: non-empty and <= 1000 characters

    GRPC-method as condition.

    service string

    Possible values: non-empty and <= 1000 characters

    GRPC-service as condition.

    all boolean

    All calls to any available services and methods as condition.

    function

    object

    Condition-type to execute if function is used, replaces actions v1.

    name string

    event

    object

    Condition-type to execute if an event is created in the system.

    event string

    Possible values: non-empty and <= 1000 characters

    Event name as condition.

    group string

    Possible values: non-empty and <= 1000 characters

    Event group as condition, all events under this group.

    all boolean

    all events as condition.

  • ]

  • ]

Loading...