Skip to main content
POST
CSharp (SDK)

Autorizaciones

Authorization
string
header
requerido

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

Encabezados

X-On-Behalf-Of
string

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

Cuerpo

application/json
name
string
requerido
Required string length: 1 - 255
suite_id
string
requerido
Minimum string length: 1
run
object
requerido
description
string
Maximum string length: 10000
suite_version
integer

Fija una versión de suite. Omite resolver la versión activa en cada incendio.

Rango requerido: 1 <= x <= 2147483647
cron
string

Expresión cron de 5 campos. Proporcione exactamente uno de cron o interval_seconds.

Required string length: 1 - 255
interval_seconds
integer

Intervalo fijo entre incendios, en segundos. Proporcione exactamente uno de cron o interval_seconds.

Rango requerido: 60 <= x <= 31536000
timezone
string
predeterminado:UTC

Zona horaria IANA aplicada a expresiones cron, por ejemplo US/Pacific.

Required string length: 1 - 64
overlap_policy
enum<string>
predeterminado:skip
Opciones disponibles:
skip,
buffer_one,
allow_all
enabled
boolean
predeterminado:true

Cuando es falso, el horario se crea en pausa.

webhook_url
string<uri>

El punto final HTTPS notificó las transiciones del estado de ejecución.

Maximum string length: 2048
webhook_secret
string

Secreto utilizado para firmar las cargas útiles de webhook con HMAC-SHA256.

Required string length: 16 - 256
metadata
object

Respuesta

200 - application/json

Está bien

id
string
requerido
object
any
requerido
name
string
requerido
description
string | null
requerido
suite_id
string
requerido
suite_version
integer | null
requerido
Rango requerido: -9007199254740991 <= x <= 9007199254740991
cron
string | null
requerido
interval_seconds
integer | null
requerido
Rango requerido: -9007199254740991 <= x <= 9007199254740991
timezone
string
requerido
overlap_policy
enum<string>
requerido
Opciones disponibles:
skip,
buffer_one,
allow_all
enabled
boolean
requerido
webhook_url
string | null
requerido
webhook_configured
boolean
requerido

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

run
object
requerido
metadata
object
requerido
last_run_id
string | null
requerido
last_run_at
integer | null
requerido
Rango requerido: -9007199254740991 <= x <= 9007199254740991
last_run_status
string | null
requerido
next_run_at
integer | null
requerido

Next scheduled fire time from Temporal, when resolvable.

Rango requerido: -9007199254740991 <= x <= 9007199254740991
created_at
integer
requerido
Rango requerido: -9007199254740991 <= x <= 9007199254740991
updated_at
integer
requerido
Rango requerido: -9007199254740991 <= x <= 9007199254740991