Skip to main content
PATCH
CSharp (SDK)

Autorizações

Authorization
string
header
obrigatório

Gateway auth: send Authorization: Bearer <mka1-api-key>. For multi-user server-side integrations, you can also send X-On-Behalf-Of: <external-user-id>.

Cabeçalhos

X-On-Behalf-Of
string

Optional external end-user identifier forwarded by the API gateway.

Parâmetros de caminho

schedule_id
string
obrigatório

Corpo

application/json
name
string
Required string length: 1 - 255
description
string | null
Maximum string length: 10000
suite_version
integer | null
Intervalo obrigatório: 1 <= x <= 2147483647
cron
string | null
Required string length: 1 - 255
interval_seconds
integer | null
Intervalo obrigatório: 60 <= x <= 31536000
timezone
string
Required string length: 1 - 64
overlap_policy
enum<string>
Opções disponíveis:
skip,
buffer_one,
allow_all
enabled
boolean
webhook_url
string<uri> | null

Ponto de extremidade HTTPS notificado sobre transições de status de execução.

Maximum string length: 2048
webhook_secret
string | null

Segredo usado para assinar cargas úteis de webhook com HMAC-SHA256.

Required string length: 16 - 256
run
object
metadata
object

Resposta

200 - application/json

OK

id
string
obrigatório
object
any
obrigatório
name
string
obrigatório
description
string | null
obrigatório
suite_id
string
obrigatório
suite_version
integer | null
obrigatório
Intervalo obrigatório: -9007199254740991 <= x <= 9007199254740991
cron
string | null
obrigatório
interval_seconds
integer | null
obrigatório
Intervalo obrigatório: -9007199254740991 <= x <= 9007199254740991
timezone
string
obrigatório
overlap_policy
enum<string>
obrigatório
Opções disponíveis:
skip,
buffer_one,
allow_all
enabled
boolean
obrigatório
webhook_url
string | null
obrigatório
webhook_configured
boolean
obrigatório

True when a signing secret is stored. The secret itself is never returned.

run
object
obrigatório
metadata
object
obrigatório
last_run_id
string | null
obrigatório
last_run_at
integer | null
obrigatório
Intervalo obrigatório: -9007199254740991 <= x <= 9007199254740991
last_run_status
string | null
obrigatório
next_run_at
integer | null
obrigatório

Next scheduled fire time from Temporal, when resolvable.

Intervalo obrigatório: -9007199254740991 <= x <= 9007199254740991
created_at
integer
obrigatório
Intervalo obrigatório: -9007199254740991 <= x <= 9007199254740991
updated_at
integer
obrigatório
Intervalo obrigatório: -9007199254740991 <= x <= 9007199254740991