For the complete documentation index, see llms.txt. This page is also available as Markdown.

Task_schedules

Lists all task schedules.

get

API Key Scope: task_schedules / index

Authorizations
AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Responses
200

List of task schedules.

application/json
countintegerRead-onlyOptionalExample: 1
task_schedulesTaskSchedule[]Read-onlyOptional
get/task_schedules
GET /api/v2/task_schedules HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
{
  "count": 1,
  "task_schedules": []
}

Displays the task schedule.

get

API Key Scope: task_schedules / show

Authorizations
AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Path parameters
task_idstringRequired

ID or name of task. Task names are not unique, it's recommended to use ID.

Responses
200

A specific task schedule.

application/json
anyOptional
get/tasks/{task_id}/task_schedule
GET /api/v2/tasks/{task_id}/task_schedule HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

No content

Creates a new task schedule. Only one should be created.

post

API Key Scope: task_schedules / create

Authorizations
AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Path parameters
task_idstringRequired

ID or name of task. Task names are not unique, it's recommended to use ID.

Body
anyOptional
Responses
201

A specific task schedule.

application/json
anyOptional
post/tasks/{task_id}/task_schedule
POST /api/v2/tasks/{task_id}/task_schedule HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*

No content

Updates the existing task schedule.

put

API Key Scope: task_schedules / update

Authorizations
AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Path parameters
task_idstringRequired

ID or name of task. Task names are not unique, it's recommended to use ID.

Body
anyOptional
Responses
200

A specific task schedule.

application/json
anyOptional
put/tasks/{task_id}/task_schedule
PUT /api/v2/tasks/{task_id}/task_schedule HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*

No content

Destroys the task schedule.

delete

API Key Scope: task_schedules / destroy

Authorizations
AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Path parameters
task_idstringRequired

ID or name of task. Task names are not unique, it's recommended to use ID.

Responses
204

Task schedule destroyed.

No content

delete/tasks/{task_id}/task_schedule
DELETE /api/v2/tasks/{task_id}/task_schedule HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

No content

Last updated

Was this helpful?