GitHub v3 REST API

Actions Secret for an Organization

object

Secrets for GitHub Actions for an organization.

namestringrequired

The name of the secret.

Example:SECRET_TOKEN

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

Visibility of a secret

Allowed values:allprivateselected

selected_repositories_urlstring(uri)

Example:https://api.github.com/organizations/org/secrets/my_secret/repositories

Example

ActionsPublicKey

object

The public key used for setting Actions Secrets.

key_idstringrequired

The identifier for the key.

Example:1234567

keystringrequired

The Base64 encoded public key.

Example:hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=

idinteger

Example:2

urlstring

Example:https://api.github.com/user/keys/2

titlestring

Example:ssh-rsa AAAAB3NzaC1yc2EAAA

created_atstring

Example:2011-01-26T19:01:12Z

Example

Empty Object

object

An object without any properties.

* Additional properties are NOT allowed.

Org Hook

object

Org Hook

idintegerrequired

Example:1

urlstring(uri)required

Example:https://api.github.com/orgs/octocat/hooks/1

ping_urlstring(uri)required

Example:https://api.github.com/orgs/octocat/hooks/1/pings

namestringrequired

Example:web

eventsarray[string]required

Example:push, pull_request

activebooleanrequired

Example:true

configobjectrequired
Show Child Parameters
updated_atstring(date-time)required

Example:2011-09-06T20:39:23Z

created_atstring(date-time)required

Example:2011-09-06T17:26:27Z

typestringrequired
Example

Org Membership

object

Org Membership

urlstring(uri)required

Example:https://api.github.com/orgs/octocat/memberships/defunkt

statestringrequired

The state of the member in the organization. The pending state indicates the user has not yet accepted an invitation.

Allowed values:activepending

Example:active

rolestringrequired

The user’s membership type in the organization.

Allowed values:adminmemberbilling_manager

Example:admin

organization_urlstring(uri)required

Example:https://api.github.com/orgs/octocat

organizationobjectrequired

Organization Simple

Show Child Parameters
userobjectrequired

Simple User

Show Child Parameters
permissionsobject
Show Child Parameters
Example