workflows

Overview

Name	workflows
Type	Resource
Id	github.actions.workflows

Fields

Name	Datatype
id	integer
name	string
html_url	string
node_id	string
path	string
url	string
updated_at	string
state	string
badge_url	string
deleted_at	string
created_at	string

Methods

Name	Accessible by	Required Params	Description
get_workflow	SELECT	owner, repo, workflow_id	Gets a specific workflow. You can replace workflow_id with the workflow file name. For example, you could use main.yaml. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
list_repo_workflows	SELECT	owner, repo	Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
create_workflow_dispatch	INSERT	owner, repo, workflow_id, data__ref	You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace workflow_id with the workflow file name. For example, you could use main.yaml. You must configure your GitHub Actions workflow to run when the workflow_dispatch webhook event occurs. The inputs are configured in the workflow file. For more information about how to configure the workflow_dispatch event in the workflow file, see "Events that trigger workflows." You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint. For more information, see "Creating a personal access token for the command line."
disable_workflow	EXEC	owner, repo, workflow_id	Disables a workflow and sets the state of the workflow to disabled_manually. You can replace workflow_id with the workflow file name. For example, you could use main.yaml. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.
enable_workflow	EXEC	owner, repo, workflow_id	Enables a workflow and sets the state of the workflow to active. You can replace workflow_id with the workflow file name. For example, you could use main.yaml. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.