search
Couchdrop HomepageKnowledge BaseLogin

Create/Update

Create or update a schedule workflow

hashtag
Create a schedule workflow

POST https://api.couchdrop.io/manage/workflow/schedules

hashtag
Headers

Name
Type
Description

token

String

API Access Token

hashtag
Request Body

Name
Type
Description

String

If id is provided the existing workflow with this id will be updated.

enabled

Boolean

Enable or disable the workflow

name

String

Workflow name in the system

conditions

JSON Array String

Conditions that need to be met for this workflow to action upon.

E.g.

[{ "condition_type": "and", "filename_pattern": "*.bz2", "id": "98fe1b8c-8516-4dbc-be1f-0bdce1cc131b", "negate": false, "type": "filename_matches" } ]

actions

JSON Aray String

Action that will run on the files/folders that match the conditions.

E.g.

[ { "actions": [ { "email_address": "[email protected]", "id": "51856312-fa6c-469e-86da-0a3028611069", "type": "email" } ], "decompress_to": "/myfolder/decompressed/", "decompress_type": "bz2", "id": "1ce2e380-a4bc-4d05-a8e5-c47e76461419", "type": "decompress" } ]

source_path

String

Path for which this workflow should run.

E.g. /myfolder/compressed/

schedule_config

JSON String

Schedule configuration when the workflow should run in JSON format.

E.g.

{"interval":"daily","time":"15:14"}

notification_email_address

String

email address for notification emails

notification_email_success

Boolean

Send email on successful workflow execution

notification_email_failure

Boolean

Send email on failed workflow execution

{
    // Response
}
PreviousScheduled AutomationsNextGet all schedule workflows

Last updated