Skip to content

secrets

Accessed as client.repos.actions.secrets; the async client mirrors it.

ReposActionsSecrets

The repos.actions.secrets namespace.

delete

delete(owner: str, repo: str, secretname: str) -> None

Delete a secret in a repository.

Parameters:

Name Type Description Default
owner str

owner of the repository

required
repo str

name of the repository

required
secretname str

name of the secret

required

Returns:

Type Description
None

No content.

Raises:

Type Description
BadRequestError
  1. APIError is error format response.
NotFoundError
  1. APINotFound is a not found error response.

Operation ID: deleteRepoSecret

list

list(owner: str, repo: str, *, page: int | None = None, limit: int | None = None) -> Paginated[Secret]

List an repo's actions secrets.

Parameters:

Name Type Description Default
owner str

owner of the repository

required
repo str

name of the repository

required
page int | None

1-based page to start iteration at.

None
limit int | None

Page size; the instance caps it server-side.

None

Returns:

Type Description
Paginated[Secret]

SecretList.

Raises:

Type Description
NotFoundError
  1. APINotFound is a not found error response.

Operation ID: repoListActionsSecrets

update

update(owner: str, repo: str, secretname: str, *, data: str) -> None

Create or Update a secret value in a repository.

Parameters:

Name Type Description Default
owner str

owner of the repository

required
repo str

name of the repository

required
secretname str

name of the secret

required
data str

Data of the secret. Special characters will be retained. Line endings will be normalized to LF to match the behaviour of browsers. Encode the data with Base64 if line endings should be retained.

required

Returns:

Type Description
None

No content.

Raises:

Type Description
BadRequestError
  1. APIError is error format response.
NotFoundError
  1. APINotFound is a not found error response.

Operation ID: updateRepoSecret

AsyncReposActionsSecrets

The repos.actions.secrets namespace.

delete

delete(owner: str, repo: str, secretname: str) -> None

Delete a secret in a repository.

Parameters:

Name Type Description Default
owner str

owner of the repository

required
repo str

name of the repository

required
secretname str

name of the secret

required

Returns:

Type Description
None

No content.

Raises:

Type Description
BadRequestError
  1. APIError is error format response.
NotFoundError
  1. APINotFound is a not found error response.

Operation ID: deleteRepoSecret

list

list(owner: str, repo: str, *, page: int | None = None, limit: int | None = None) -> AsyncPaginated[Secret]

List an repo's actions secrets.

Parameters:

Name Type Description Default
owner str

owner of the repository

required
repo str

name of the repository

required
page int | None

1-based page to start iteration at.

None
limit int | None

Page size; the instance caps it server-side.

None

Returns:

Type Description
AsyncPaginated[Secret]

SecretList.

Raises:

Type Description
NotFoundError
  1. APINotFound is a not found error response.

Operation ID: repoListActionsSecrets

update

update(owner: str, repo: str, secretname: str, *, data: str) -> None

Create or Update a secret value in a repository.

Parameters:

Name Type Description Default
owner str

owner of the repository

required
repo str

name of the repository

required
secretname str

name of the secret

required
data str

Data of the secret. Special characters will be retained. Line endings will be normalized to LF to match the behaviour of browsers. Encode the data with Base64 if line endings should be retained.

required

Returns:

Type Description
None

No content.

Raises:

Type Description
BadRequestError
  1. APIError is error format response.
NotFoundError
  1. APINotFound is a not found error response.

Operation ID: updateRepoSecret