# Treasure Workflow Treasure Workflow Version: 1.0 ## Servers aws ``` https://api-workflow.treasuredata.com ``` aws-tokyo ``` https://api-workflow.treasuredata.co.jp ``` eu01 ``` https://api-workflow.eu01.treasuredata.com ``` ap02 ``` https://api-workflow.ap02.treasuredata.com ``` ap03 ``` https://api-workflow.ap03.treasuredata.com ``` ## Security ### ApiKeyAuth Type: http Scheme: TD1 ## Download OpenAPI description [Treasure Workflow](https://docs.treasuredata.com/_bundle/apis/workflow.yaml) ## Attempt ### List attempts with filters - [GET /api/attempts](https://docs.treasuredata.com/apis/workflow/attempt/getattempts_1.md) ### Start a workflow execution as a new session or a new attempt of an existing session - [PUT /api/attempts](https://docs.treasuredata.com/apis/workflow/attempt/startattempt_1.md): "resume" is used to rerun an attempt. It is used in the case an attempt failed then users want to resume it from the middle.It has two modes "failed" or "from" to set the way to resume.In "failed" mode, the attempt specified by "attemptId" is resumed from the failed tasks.In "from" mode, the attempt is resumed from the task which is set in "from" field. ### Get an attempt - [GET /api/attempts/{id}](https://docs.treasuredata.com/apis/workflow/attempt/getattempt_1.md) ### Set a cancel-requested flag on a running attempt - [POST /api/attempts/{id}/kill](https://docs.treasuredata.com/apis/workflow/attempt/killattempt_1.md) ### List attempts of a session of a given attempt - [GET /api/attempts/{id}/retries](https://docs.treasuredata.com/apis/workflow/attempt/getattemptretries_1.md) ### List tasks of an attempt - [GET /api/attempts/{id}/tasks](https://docs.treasuredata.com/apis/workflow/attempt/gettasks_1.md) ## Log ### List log files of an attempt with filters - [GET /api/logs/{attempt_id}/files](https://docs.treasuredata.com/apis/workflow/log/getfilehandles.md) ### Download a log file - [GET /api/logs/{attempt_id}/files/{file_name}](https://docs.treasuredata.com/apis/workflow/log/getfile.md) ## Project ### List projects with filters - [GET /api/projects](https://docs.treasuredata.com/apis/workflow/project/getprojects.md) ### Upload a project archive as a new project or a new revision of an existing project - [PUT /api/projects](https://docs.treasuredata.com/apis/workflow/project/putproject_1.md) ### Delete a project - [DELETE /api/projects/{id}](https://docs.treasuredata.com/apis/workflow/project/deleteproject.md) ### Get a project - [GET /api/projects/{id}](https://docs.treasuredata.com/apis/workflow/project/getproject_1.md) ### Download a project archive file - [GET /api/projects/{id}/archive](https://docs.treasuredata.com/apis/workflow/project/getarchive.md) ### List revisions of a project - [GET /api/projects/{id}/revisions](https://docs.treasuredata.com/apis/workflow/project/getrevisions.md) ### List schedules of a project with filters - [GET /api/projects/{id}/schedules](https://docs.treasuredata.com/apis/workflow/project/getschedules.md) ### List secret keys of a project - [GET /api/projects/{id}/secrets](https://docs.treasuredata.com/apis/workflow/project/getprojectsecrets.md) ### Delete a secret from a project - [DELETE /api/projects/{id}/secrets/{key}](https://docs.treasuredata.com/apis/workflow/project/deleteprojectsecret.md) ### Set a secret to a project - [PUT /api/projects/{id}/secrets/{key}](https://docs.treasuredata.com/apis/workflow/project/putprojectsecret.md) ### List sessions of a project with filters - [GET /api/projects/{id}/sessions](https://docs.treasuredata.com/apis/workflow/project/getsessions.md) ### List workflows of a project with filters - [GET /api/projects/{id}/workflows](https://docs.treasuredata.com/apis/workflow/project/getworkflows.md) ### getWorkflowByName - [GET /api/projects/{id}/workflows/{name}](https://docs.treasuredata.com/apis/workflow/project/getworkflowbyname.md) ## Schedule ### List schedules - [GET /api/schedules](https://docs.treasuredata.com/apis/workflow/schedule/getschedules_2.md) ### Get a schedule - [GET /api/schedules/{id}](https://docs.treasuredata.com/apis/workflow/schedule/getschedules_1.md) ### Re-schedule past sessions by count or duration - [POST /api/schedules/{id}/backfill](https://docs.treasuredata.com/apis/workflow/schedule/backfillschedule.md) ### Disable scheduling of new sessions - [POST /api/schedules/{id}/disable](https://docs.treasuredata.com/apis/workflow/schedule/disableschedule.md) ### Re-enable disabled scheduling - [POST /api/schedules/{id}/enable](https://docs.treasuredata.com/apis/workflow/schedule/enableschedule.md) ### Skip future sessions by count or time - [POST /api/schedules/{id}/skip](https://docs.treasuredata.com/apis/workflow/schedule/skipschedule.md) ## Session ### List sessions - [GET /api/sessions](https://docs.treasuredata.com/apis/workflow/session/getsessions_1.md) ### Get a session - [GET /api/sessions/{id}](https://docs.treasuredata.com/apis/workflow/session/getsession.md) ### List attempts of a session - [GET /api/sessions/{id}/attempts](https://docs.treasuredata.com/apis/workflow/session/getsessionattempts.md) ## Workflow ### List workflows - [GET /api/workflows](https://docs.treasuredata.com/apis/workflow/workflow/getworkflowdefinitions.md) ### Get a workflow - [GET /api/workflows/{id}](https://docs.treasuredata.com/apis/workflow/workflow/getworkflowdefinition.md) ### Get truncated local time based on the time zone of a workflow - [GET /api/workflows/{id}/truncated_session_time](https://docs.treasuredata.com/apis/workflow/workflow/getworkflowdefinition_2.md)