Get a workflow - GitHub API

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.

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

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Path 参数

owner

string

必需

repo

string

必需

workflow_id

string

必需

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

返回响应

🟢200Response

application/json

Body

A GitHub Actions workflow

badge_url

string

必需

示例值:

https://github.com/actions/setup-ruby/workflows/CI/badge.svg

created_at

string <date-time>

必需

示例值:

2019-12-06T14:20:20.000Z

deleted_at

string <date-time>

可选

示例值:

2019-12-06T14:20:20.000Z

html_url

string

必需

示例值:

https://github.com/actions/setup-ruby/blob/master/.github/workflows/ruby.yaml

integer

必需

示例值:

name

string

必需

示例值:

node_id

string

必需

示例值:

MDg6V29ya2Zsb3cxMg==

path

string

必需

示例值:

ruby.yaml

state

enum<string>

必需

枚举值:

activedeleteddisabled_forkdisabled_inactivitydisabled_manually

示例值:

active

updated_at

string <date-time>

必需

示例值:

2019-12-06T14:20:20.000Z

url

string

必需

示例值:

https://api.github.com/repos/actions/setup-ruby/workflows/5