Skip to main content
POST

Autorizaciones

Authorization
string
header
requerido

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parámetros de ruta

organization_id
string
requerido

El identificador único de la organización

Maximum string length: 24
Pattern: ^[0-9a-f]{24}$
workspace_group_id
string
requerido

El identificador único del grupo de workspaces

Maximum string length: 24
Pattern: ^[0-9a-f]{24}$

Cuerpo

application/json
cron_expression
string
requerido

Expresión cron que define cuándo debe ejecutarse la programación. Formato: minuto hora día-del-mes mes día-de-la-semana. Ejemplos: '0 8 * * 1-5' (8 AM en días laborables), '0 0 * * 0' (medianoche del domingo), '30 14 * * ' (2:30 PM diariamente). Día-de-la-semana: 0=domingo, 1=lunes, ..., 6=sábado. Admite rangos (1-5), listas (1,3,5) y comodines (). Debe ser un formato de expresión cron válido con 5 campos separados por espacios.

Ejemplo:

"0 8 * * 1-5"

time_zone
string
requerido

Zona horaria para la ejecución de la programación. Admite identificadores IANA (p. ej., 'America/New_York') y Windows (p. ej., 'Pacific Standard Time').

Ejemplo:

"Eastern Standard Time"

type
enum<string>
requerido

Tipo de operación de energía a realizar. START: Enciende los Workspaces del grupo. STOP: Apaga los Workspaces del grupo. RESTART: Reinicia los Workspaces del grupo.

Opciones disponibles:
start,
stop,
restart
Ejemplo:

"start"

intermediate_device
string

Opcional. El identificador único del Workspace de dispositivo intermedio. Si se proporciona, indica que se debe usar un dispositivo intermedio para operaciones Wake on LAN. Solo aplicable a programaciones START. Se usa para acciones Wake on LAN en redes seguras. El Workspace debe existir y pertenecer a la organización.

Maximum string length: 24
Pattern: ^[0-9a-f]{24}$
Ejemplo:

"507f1f77bcf86cd799439050"

Respuesta

Programación creada correctamente. La respuesta contiene el recurso de programación creado.

id
string
requerido

El identificador único de la programación

Pattern: ^[0-9a-f]{24}$
Ejemplo:

"507f1f77bcf86cd799439060"

cron_expression
string
requerido

Expresión cron que define cuándo se ejecuta la programación. Formato: minuto hora día-del-mes mes día-de-la-semana.

Ejemplo:

"0 8 * * 1-5"

time_zone
string
requerido

Zona horaria para la ejecución de la programación. Admite identificadores IANA (p. ej., 'America/New_York') y Windows (p. ej., 'Pacific Standard Time').

Ejemplo:

"Eastern Standard Time"

type
enum<string>
requerido

Tipo de operación de energía: START (enciende), STOP (apaga), RESTART (reinicia Workspaces)

Opciones disponibles:
start,
stop,
restart
intermediate_device
string | null

El identificador único del workspace del dispositivo intermedio, si está configurado. Se usa para acciones de Wake on LAN en redes seguras.

Pattern: ^[0-9a-f]{24}$
Ejemplo:

"507f1f77bcf86cd799439050"

created_by
string | null

ID de usuario que creó la programación

Pattern: ^[0-9a-f]{24}$
Ejemplo:

"507f1f77bcf86cd799439070"