Skip to main content

public_keys

Overview

Namepublic_keys
TypeResource
Idgithub.actions.public_keys

Fields

NameDatatypeDescription
idinteger
titlestring
urlstring
created_atstring
keystringThe Base64 encoded public key.
key_idstringThe identifier for the key.

Methods

NameAccessible byRequired ParamsDescription
get_environment_public_keySELECTenvironment_name, repository_idGet the public key for an environment, which you need to encrypt environment
secrets. You need to encrypt a secret before you can create or update secrets.

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 secrets repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
get_org_public_keySELECTorgGets your public key, which you need to encrypt secrets. You need to
encrypt a secret before you can create or update secrets.

You must authenticate using an access token with the admin:org scope to use this endpoint.
If the repository is private, you must use an access token with the repo scope.
GitHub Apps must have the secrets organization permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
get_repo_public_keySELECTowner, repoGets your public key, which you need to encrypt secrets. You need to
encrypt a secret before you can create or update secrets.

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 secrets repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read secrets.