Cronjobs

Scheduled job management endpoints

get

GET /api/v1/cronjob/check-name-availability

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
get
/api/v1/cronjob/check-name-availability
get

GET /api/v1/cronjob/all

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
get
/api/v1/cronjob/all
get

GET /api/v1/cronjob/single/{id}

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Path parameters
idstringRequired

Path parameter: id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
get
/api/v1/cronjob/single/{id}
put

PUT /api/v1/cronjob/single/{id}

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Path parameters
idstringRequired

Path parameter: id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Body
organization_idanyOptionalExample: any
Responses
200

OK

application/json
Responseobject
put
/api/v1/cronjob/single/{id}
delete

DELETE /api/v1/cronjob/single/{id}

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Path parameters
idstringRequired

Path parameter: id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
delete
/api/v1/cronjob/single/{id}
get

GET /api/v1/cronjob/{id}/executions

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Path parameters
idstringRequired

Path parameter: id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
get
/api/v1/cronjob/{id}/executions
get

GET /api/v1/cronjob/execution/{execution_uuid}/logs

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Path parameters
execution_uuidstringRequired

Path parameter: execution_uuid

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
get
/api/v1/cronjob/execution/{execution_uuid}/logs
get

GET /api/v1/cronjob/execution/{execution_uuid}/status

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Path parameters
execution_uuidstringRequired

Path parameter: execution_uuid

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
get
/api/v1/cronjob/execution/{execution_uuid}/status
get

GET /api/v1/cronjob/status/{deployment_uuid}

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Path parameters
deployment_uuidstringRequired

Path parameter: deployment_uuid

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
get
/api/v1/cronjob/status/{deployment_uuid}
get

GET /api/v1/cronjob/status-simple/{id}

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Path parameters
idstringRequired

Path parameter: id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
get
/api/v1/cronjob/status-simple/{id}
post

POST /api/v1/cronjob/create

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Body
organization_idanyOptionalExample: any
Responses
200

OK

application/json
Responseobject
post
/api/v1/cronjob/create
put

PUT /api/v1/cronjob/update/{id}

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Path parameters
idstringRequired

Path parameter: id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Body
organization_idanyOptionalExample: any
Responses
200

OK

application/json
Responseobject
put
/api/v1/cronjob/update/{id}
post

POST /api/v1/cronjob/{id}/trigger

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Path parameters
idstringRequired

Path parameter: id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Body
organization_idanyOptionalExample: any
Responses
200

OK

application/json
Responseobject
post
/api/v1/cronjob/{id}/trigger
post

POST /api/v1/cronjob/{id}/pause

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Path parameters
idstringRequired

Path parameter: id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Body
organization_idanyOptionalExample: any
Responses
200

OK

application/json
Responseobject
post
/api/v1/cronjob/{id}/pause
post

POST /api/v1/cronjob/{id}/continue

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Path parameters
idstringRequired

Path parameter: id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Body
organization_idanyOptionalExample: any
Responses
200

OK

application/json
Responseobject
post
/api/v1/cronjob/{id}/continue
delete

DELETE /api/v1/cronjob/{id}

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Path parameters
idstringRequired

Path parameter: id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
delete
/api/v1/cronjob/{id}

Last updated