Search executions

POST 
/resources/v3alpha/actions/executions/_search

Search 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.

Request

Query Parameters

instance.id string
instance.domain string
query.offset uint64
query.limit int64

Maximum amount of events returned. If not configured otherwise, the default is 100, the maximum is 1000. If the limit exceeds the maximum, ZITADEL throws an error.

query.desc boolean

default is ascending, because together with the creation date sorting column, this returns the most deterministic pagination results.

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.

application/json

Body

required

Define the criteria to query for.

• Array [

inConditionsFilter

object

conditions

object[]

Defines the conditions to query for.

Array [

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.

]

executionTypeFilter

object

executionType string

Possible values: [EXECUTION_TYPE_UNSPECIFIED, EXECUTION_TYPE_REQUEST, EXECUTION_TYPE_RESPONSE, EXECUTION_TYPE_EVENT, EXECUTION_TYPE_FUNCTION]

Default value: EXECUTION_TYPE_UNSPECIFIED

Defines the type to query for.

targetFilter

object

targetId string

the id of the targets to include

includeFilter

object

include

object

the id of the include

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.

• ]

application/grpc

Body

required

Define the criteria to query for.

• Array [

inConditionsFilter

object

conditions

object[]

Defines the conditions to query for.

Array [

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.

]

executionTypeFilter

object

executionType string

Possible values: [EXECUTION_TYPE_UNSPECIFIED, EXECUTION_TYPE_REQUEST, EXECUTION_TYPE_RESPONSE, EXECUTION_TYPE_EVENT, EXECUTION_TYPE_FUNCTION]

Default value: EXECUTION_TYPE_UNSPECIFIED

Defines the type to query for.

targetFilter

object

targetId string

the id of the targets to include

includeFilter

object

include

object

the id of the include

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.

• ]

application/grpc-web+proto

Body

required

Define the criteria to query for.

• Array [

inConditionsFilter

object

conditions

object[]

Defines the conditions to query for.

Array [

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.

]

executionTypeFilter

object

executionType string

Possible values: [EXECUTION_TYPE_UNSPECIFIED, EXECUTION_TYPE_REQUEST, EXECUTION_TYPE_RESPONSE, EXECUTION_TYPE_EVENT, EXECUTION_TYPE_FUNCTION]

Default value: EXECUTION_TYPE_UNSPECIFIED

Defines the type to query for.

targetFilter

object

targetId string

the id of the targets to include

includeFilter

object

include

object

the id of the include

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.

• ]

Responses

200

A list of all non noop executions matching the query

application/json

Schema

Schema

details

object

appliedLimit uint64

totalResult uint64

timestamp date-time

the last time the projection got updated

result

object[]

Array [

details

object

id string

created date-time

the timestamp of the first event applied to the object.

changed date-time

the timestamp of the last event applied to the object.

owner

object

the parent object representing the returned objects context.

type string

Possible values: [OWNER_TYPE_UNSPECIFIED, OWNER_TYPE_SYSTEM, OWNER_TYPE_INSTANCE, OWNER_TYPE_ORG]

Default value: OWNER_TYPE_UNSPECIFIED

id string

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.

execution

object

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.

]

]

Example (from schema)

{
  "details": {
    "appliedLimit": 100,
    "totalResult": "2",
    "timestamp": "2024-09-19T14:29:23.010Z"
  },
  "result": [
    {
      "details": {
        "id": "69629012906488334",
        "created": "2024-09-19T14:29:23.010Z",
        "changed": "2024-09-19T14:29:23.010Z",
        "owner": "69629023906488334"
      },
      "condition": {
        "request": {
          "method": "/zitadel.session.v2.SessionService/ListSessions",
          "service": "zitadel.session.v2.SessionService",
          "all": true
        },
        "response": {
          "method": "/zitadel.session.v2.SessionService/ListSessions",
          "service": "zitadel.session.v2.SessionService",
          "all": true
        },
        "function": {
          "name": "string"
        },
        "event": {
          "event": "user.human.added",
          "group": "user.human",
          "all": true
        }
      },
      "execution": {
        "targets": [
          {
            "target": "string",
            "include": {
              "request": {
                "method": "/zitadel.session.v2.SessionService/ListSessions",
                "service": "zitadel.session.v2.SessionService",
                "all": true
              },
              "response": {
                "method": "/zitadel.session.v2.SessionService/ListSessions",
                "service": "zitadel.session.v2.SessionService",
                "all": true
              },
              "function": {
                "name": "string"
              },
              "event": {
                "event": "user.human.added",
                "group": "user.human",
                "all": true
              }
            }
          }
        ]
      }
    }
  ]
}

application/grpc

Schema

Schema

details

object

appliedLimit uint64

totalResult uint64

timestamp date-time

the last time the projection got updated

result

object[]

Array [

details

object

id string

created date-time

the timestamp of the first event applied to the object.

changed date-time

the timestamp of the last event applied to the object.

owner

object

the parent object representing the returned objects context.

type string

Possible values: [OWNER_TYPE_UNSPECIFIED, OWNER_TYPE_SYSTEM, OWNER_TYPE_INSTANCE, OWNER_TYPE_ORG]

Default value: OWNER_TYPE_UNSPECIFIED

id string

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.

execution

object

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.

]

]

Example (from schema)

{
  "details": {
    "appliedLimit": 100,
    "totalResult": "2",
    "timestamp": "2024-09-19T14:29:23.013Z"
  },
  "result": [
    {
      "details": {
        "id": "69629012906488334",
        "created": "2024-09-19T14:29:23.013Z",
        "changed": "2024-09-19T14:29:23.013Z",
        "owner": "69629023906488334"
      },
      "condition": {
        "request": {
          "method": "/zitadel.session.v2.SessionService/ListSessions",
          "service": "zitadel.session.v2.SessionService",
          "all": true
        },
        "response": {
          "method": "/zitadel.session.v2.SessionService/ListSessions",
          "service": "zitadel.session.v2.SessionService",
          "all": true
        },
        "function": {
          "name": "string"
        },
        "event": {
          "event": "user.human.added",
          "group": "user.human",
          "all": true
        }
      },
      "execution": {
        "targets": [
          {
            "target": "string",
            "include": {
              "request": {
                "method": "/zitadel.session.v2.SessionService/ListSessions",
                "service": "zitadel.session.v2.SessionService",
                "all": true
              },
              "response": {
                "method": "/zitadel.session.v2.SessionService/ListSessions",
                "service": "zitadel.session.v2.SessionService",
                "all": true
              },
              "function": {
                "name": "string"
              },
              "event": {
                "event": "user.human.added",
                "group": "user.human",
                "all": true
              }
            }
          }
        ]
      }
    }
  ]
}

application/grpc-web+proto

Schema

Schema

details

object

appliedLimit uint64

totalResult uint64

timestamp date-time

the last time the projection got updated

result

object[]

Array [

details

object

id string

created date-time

the timestamp of the first event applied to the object.

changed date-time

the timestamp of the last event applied to the object.

owner

object

the parent object representing the returned objects context.

type string

Possible values: [OWNER_TYPE_UNSPECIFIED, OWNER_TYPE_SYSTEM, OWNER_TYPE_INSTANCE, OWNER_TYPE_ORG]

Default value: OWNER_TYPE_UNSPECIFIED

id string

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.

execution

object

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.

]

]

Example (from schema)

{
  "details": {
    "appliedLimit": 100,
    "totalResult": "2",
    "timestamp": "2024-09-19T14:29:23.017Z"
  },
  "result": [
    {
      "details": {
        "id": "69629012906488334",
        "created": "2024-09-19T14:29:23.017Z",
        "changed": "2024-09-19T14:29:23.017Z",
        "owner": "69629023906488334"
      },
      "condition": {
        "request": {
          "method": "/zitadel.session.v2.SessionService/ListSessions",
          "service": "zitadel.session.v2.SessionService",
          "all": true
        },
        "response": {
          "method": "/zitadel.session.v2.SessionService/ListSessions",
          "service": "zitadel.session.v2.SessionService",
          "all": true
        },
        "function": {
          "name": "string"
        },
        "event": {
          "event": "user.human.added",
          "group": "user.human",
          "all": true
        }
      },
      "execution": {
        "targets": [
          {
            "target": "string",
            "include": {
              "request": {
                "method": "/zitadel.session.v2.SessionService/ListSessions",
                "service": "zitadel.session.v2.SessionService",
                "all": true
              },
              "response": {
                "method": "/zitadel.session.v2.SessionService/ListSessions",
                "service": "zitadel.session.v2.SessionService",
                "all": true
              },
              "function": {
                "name": "string"
              },
              "event": {
                "event": "user.human.added",
                "group": "user.human",
                "all": true
              }
            }
          }
        ]
      }
    }
  ]
}

400

invalid list query

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

403

Returned when the user does not have permission to access the resource.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

404

Returned when the resource does not exist.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...