Search
K
GitHub v3 REST API

Actions Secret

object

Set secrets for GitHub Actions.

namestringrequired

The name of the secret.

Example:SECRET_TOKEN

created_atstring(date-time)required
updated_atstring(date-time)required
Example

Workflow

object

A GitHub Actions workflow

idintegerrequired

Example:5

node_idstringrequired

Example:MDg6V29ya2Zsb3cxMg==

namestringrequired

Example:CI

pathstringrequired

Example:ruby.yaml

statestringrequired

Allowed values:activedeleteddisabled_forkdisabled_inactivitydisabled_manually

Example:active

created_atstring(date-time)required

Example:2019-12-06T14:20:20.000Z

updated_atstring(date-time)required

Example:2019-12-06T14:20:20.000Z

urlstringrequired

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

html_urlstringrequired

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

badge_urlstringrequired

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

deleted_atstring(date-time)

Example:2019-12-06T14:20:20.000Z

Example

Protected Branch Required Status Check

object

Protected Branch Required Status Check

urlstring
enforcement_levelstring
contextsarray[string]required
contexts_urlstring
strictboolean
Example

Protected Branch Admin Enforced

object

Protected Branch Admin Enforced

urlstring(uri)required

Example:https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins

enabledbooleanrequired

Example:true

Example

Protected Branch Pull Request Review

object

Protected Branch Pull Request Review

urlstring(uri)

Example:https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions

dismissal_restrictionsobject
Show Child Parameters
dismiss_stale_reviewsbooleanrequired

Example:true

require_code_owner_reviewsbooleanrequired

Example:true

required_approving_review_countinteger

>= 1<= 6

Example:2

Example