List Failed Events

Returns a list of events that could not be proceeded in the views/projections. Some events need several retries till they succeed. For example, if the SMTP-API wasn't able to send an email the first time.

Responses

• 200
• 403
• 404
• default

---

Events which were not processed by the views

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

result object[]
Array [
database string
viewName string
failedSequence uint64
failureCount uint64
errorMessage string
lastFailed date-time
The timestamp the failure last occurred
]

{
  "result": [
    {
      "database": "adminapi",
      "viewName": "iam_members",
      "failedSequence": "9823759",
      "failureCount": "5",
      "errorMessage": "ID=EXAMP-ID3ER Message=Example message",
      "lastFailed": "2024-04-09T11:59:32.421Z"
    }
  ]
}

Schema

Example (from schema)

---

Schema

result object[]
Array [
database string
viewName string
failedSequence uint64
failureCount uint64
errorMessage string
lastFailed date-time
The timestamp the failure last occurred
]

{
  "result": [
    {
      "database": "adminapi",
      "viewName": "iam_members",
      "failedSequence": "9823759",
      "failureCount": "5",
      "errorMessage": "ID=EXAMP-ID3ER Message=Example message",
      "lastFailed": "2024-04-09T11:59:32.421Z"
    }
  ]
}

Schema

Example (from schema)

---

Schema

result object[]
Array [
database string
viewName string
failedSequence uint64
failureCount uint64
errorMessage string
lastFailed date-time
The timestamp the failure last occurred
]

{
  "result": [
    {
      "database": "adminapi",
      "viewName": "iam_members",
      "failedSequence": "9823759",
      "failureCount": "5",
      "errorMessage": "ID=EXAMP-ID3ER Message=Example message",
      "lastFailed": "2024-04-09T11:59:32.422Z"
    }
  ]
}

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

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

Returned when the resource does not exist.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

An unexpected error response.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

POST /failedevents/_search

Authorization

name: OAuth2type: oauth2scopes: openid,urn:zitadel:iam:org:project:id:zitadel:audflows: {
  "authorizationCode": {
    "authorizationUrl": "$CUSTOM-DOMAIN/oauth/v2/authorize",
    "tokenUrl": "$CUSTOM-DOMAIN/oauth/v2/token",
    "scopes": {
      "openid": "openid",
      "urn:zitadel:iam:org:project:id:zitadel:aud": "urn:zitadel:iam:org:project:id:zitadel:aud"
    }
  }
}

Request

Base URL

https://$CUSTOM-DOMAIN/admin/v1

Bearer Token

Accept

application/jsonapplication/grpcapplication/grpc-web+proto

curl / cURL

curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/failedevents/_search' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

python / requests

curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/failedevents/_search' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

go / native

curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/failedevents/_search' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

nodejs / axios

curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/failedevents/_search' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

ruby / Net::HTTP

curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/failedevents/_search' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

csharp / RestSharp

curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/failedevents/_search' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

php / cURL

curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/failedevents/_search' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

java / OkHttp

curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/failedevents/_search' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

powershell / RestMethod

curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/failedevents/_search' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'