Sign in

v50

latestOpenAPI 3.0.3MITraw.githubusercontent.com2024-03-2585861610.1 MB
actions

Get a workflow

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.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

get/repos/{owner}/{repo}/actions/workflows/{workflow_id}

Path parameters

ownerstring required

The account owner of the repository. The name is not case sensitive.

repostring required

The name of the repository without the .git extension. The name is not case sensitive.

integer required
OR
string required

The ID of the workflow. You can also pass the workflow file name as a string.

Response

Response

idinteger required
node_idstring required
namestring required
pathstring required
state'active' | 'deleted' | 'disabled_fork' | 'disabled_inactivity' | 'disabled_manually' required
created_atstring date-time required
updated_atstring date-time required
urlstring required
html_urlstring required
badge_urlstring required
deleted_atstring date-time

Example response

{
  "id": 5,
  "node_id": "MDg6V29ya2Zsb3cxMg==",
  "name": "CI",
  "path": "ruby.yaml",
  "state": "active",
  "created_at": "2019-12-06T14:20:20.000Z",
  "updated_at": "2019-12-06T14:20:20.000Z",
  "url": "https://api.github.com/repos/actions/setup-ruby/workflows/5",
  "html_url": "https://github.com/actions/setup-ruby/blob/master/.github/workflows/ruby.yaml",
  "badge_url": "https://github.com/actions/setup-ruby/workflows/CI/badge.svg",
  "deleted_at": "2019-12-06T14:20:20.000Z"
}