Skip to content

Turn a workflow on or off without changing its file.

PATCH/repos/{owner}/{name}/actions/workflows/{workflow}

Needs the Maintain role or higher.

Name Type Required Description
owner string Yes The workspace that owns the repository.
name string Yes The repository’s name.
workflow string Yes The workflow’s id or file name.

Send a JSON object. Names are snake_case, as in responses; the camelCase spelling is accepted too.

Name Type Required Description
enabled boolean Yes
curl -X PATCH https://api.g1t.sh/repos/flagon-io/hello/actions/workflows/nightly.yml \
-H "Authorization: Bearer $G1T_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"enabled": false
}'

A successful request answers 200 with:

{
"id": "wfl_01kpw2c5d8e1f4g7h0j3k6m9nq",
"path": ".g1t/workflows/nightly.yml",
"name": "Nightly",
"events": [
"schedule"
],
"state": "disabled",
"error": null,
"notes": [],
"dispatch": null,
"last_run": null
}

A failed request answers with one of these statuses and a body like {"error": {"code": "not_found", "message": "Repository not found."}}. See errors.

Status Code When
401 unauthenticated A token is required, or the one sent is not valid.
403 forbidden The token is valid but not allowed to do this, such as a member-only change or an agent token outside its repository.
404 not_found It does not exist, or you cannot see it.
409 conflict The request conflicts with the current state.
422 invalid The input is not valid. message says which field and why.