Configuration and files

Environments and their secrets, task schedules, and the input and output files of executions (through presigned URLs — no tool carries bytes).

Families on this page

Family	Tools	read	write	destructive
`environments` — Environments	5	2	2	1
`secrets` — Secrets	5	2	2	1
`schedules` — Schedules	5	2	2	1
`files` — Files	5	3	2	0

Tool	Kind	Scope	Permission	Endpoint	What it does
`kadu_environments_list`	read	`kadu/environments` + `read`	`agent.environments.list`	`GET /v1/environments`	Lists the environments a task can run in (each one maps to a branch of the repository and its secrets).
`kadu_environments_get`	read	`kadu/environments` + `read`	`agent.environments.read`	`GET /v1/environments/{id}`	Gets an environment.
`kadu_environments_create`	write	`kadu/environments` + `write`	`agent.environments.create`	`POST /v1/environments`	Creates an environment.
`kadu_environments_update`	write	`kadu/environments` + `write`	`agent.environments.update`	`PATCH /v1/environments/{id}`	Updates an environment.
`kadu_environments_delete`	destructive	`kadu/environments` + `delete`	`agent.environments.delete`	`DELETE /v1/environments/{id}`	Deletes an environment.

Tool	Kind	Scope	Permission	Endpoint	What it does
`kadu_secrets_list`	read	`kadu/secrets` + `read`	`agent.secrets.list`	`GET /v1/secrets`	Lists the secrets of the environments.
`kadu_secrets_get`	read	`kadu/secrets` + `read`	`agent.secrets.read`	`GET /v1/secrets/{id}`	Gets a secret (without its value).
`kadu_secrets_create`	write	`kadu/secrets` + `write`	`agent.secrets.create`	`POST /v1/secrets`	Creates a secret the agent receives as an environment variable.
`kadu_secrets_update`	write	`kadu/secrets` + `write`	`agent.secrets.update`	`PATCH /v1/secrets/{id}`	Updates a secret.
`kadu_secrets_delete`	destructive	`kadu/secrets` + `delete`	`agent.secrets.delete`	`DELETE /v1/secrets/{id}`	Deletes a secret.

Tool	Kind	Scope	Permission	Endpoint	What it does
`kadu_schedules_list`	read	`kadu/schedules` + `read`	`agent.schedules.list`	`GET /v1/schedules`	Lists the schedules that run tasks on a cron.
`kadu_schedules_get`	read	`kadu/schedules` + `read`	`agent.schedules.read`	`GET /v1/schedules/{id}`	Gets a schedule.
`kadu_schedules_create`	write	`kadu/schedules` + `write`	`agent.schedules.create`	`POST /v1/schedules`	Schedules a task to run on a cron in an environment.
`kadu_schedules_update`	write	`kadu/schedules` + `write`	`agent.schedules.update`	`PATCH /v1/schedules/{id}`	Changes, pauses or resumes a schedule.
`kadu_schedules_delete`	destructive	`kadu/schedules` + `delete`	`agent.schedules.delete`	`DELETE /v1/schedules/{id}`	Cancels a schedule.

Tool	Kind	Scope	Permission	Endpoint	What it does
`kadu_files_list`	read	`kadu/files` + `read`	`agent.files.list`	`GET /v1/files`	Lists the input and output files of tasks and executions.
`kadu_files_get`	read	`kadu/files` + `read`	`agent.files.read`	`GET /v1/files/{id}`	Gets a file record.
`kadu_files_create`	write	`kadu/files` + `write`	`agent.files.create`	`POST /v1/files`	Starts the upload of an input file for a task: answers with a presigned upload URL.
`kadu_files_confirm`	write	`kadu/files` + `write`	`agent.files.create`	`POST /v1/files/{id}/confirm`	Confirms an upload started by `kadu_files_create` (pending → uploaded).
`kadu_files_download`	read	`kadu/files` + `read`	`agent.files.read`	`GET /v1/files/{id}/download`	Gets a short-lived presigned URL to download a file.

The fields of each resource are in the API reference.

A tool you cannot run is not listed by tools/list at all. If one from this page is missing, see Authentication.