Skip to main content

secrets

Overview

Namesecrets
TypeResource
Idgithub.actions.secrets

Fields

NameDatatypeDescription
namestringThe name of the secret.
updated_atstring
created_atstring

Methods

NameAccessible byRequired ParamsDescription
get_environment_secretSELECTenvironment_name, repository_id, secret_nameGets a single environment secret without revealing its encrypted value.

You must authenticate using an access token with the repo scope to use this endpoint.
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_repo_secretSELECTowner, repo, secret_nameGets a single repository secret without revealing its encrypted value.

You must authenticate using an access token with the repo scope to use this endpoint.
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.
list_environment_secretsSELECTenvironment_name, repository_idLists all secrets available in an environment without revealing their
encrypted values.

You must authenticate using an access token with the repo scope to use this endpoint.
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.
list_repo_secretsSELECTowner, repoLists all secrets available in a repository without revealing their encrypted
values.

You must authenticate using an access token with the repo scope to use this endpoint.
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.
delete_environment_secretDELETEenvironment_name, repository_id, secret_nameDeletes a secret in an environment using the secret name.

You must authenticate using an access token with the repo scope to use this endpoint.
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.
delete_repo_secretDELETEowner, repo, secret_nameDeletes a secret in a repository using the secret name.

You must authenticate using an access token with the repo scope to use this endpoint.
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.
create_or_update_environment_secretEXECenvironment_name, repository_id, secret_name, data__encrypted_value, data__key_idCreates or updates an environment secret with an encrypted value. Encrypt your secret using
LibSodium. For more information, see "Encrypting secrets for the REST API."

You must authenticate using an access token with the repo scope to use this endpoint.
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.
create_or_update_repo_secretEXECowner, repo, secret_nameCreates or updates a repository secret with an encrypted value. Encrypt your secret using
LibSodium. For more information, see "Encrypting secrets for the REST API."

You must authenticate using an access token with the repo scope to use this endpoint.
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.