Skip to content

secrets

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

OrgsActionsSecrets

The orgs.actions.secrets namespace.

delete

delete(org: str, secretname: str) -> None

Delete a secret in an organization.

Parameters:

Name Type Description Default
org str

name of organization

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: deleteOrgSecret

list

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

List actions secrets of an organization.

Parameters:

Name Type Description Default
org str

name of the organization

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: orgListActionsSecrets

update

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

Create or Update a secret value in an organization.

Parameters:

Name Type Description Default
org str

name of organization

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: updateOrgSecret

AsyncOrgsActionsSecrets

The orgs.actions.secrets namespace.

delete

delete(org: str, secretname: str) -> None

Delete a secret in an organization.

Parameters:

Name Type Description Default
org str

name of organization

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: deleteOrgSecret

list

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

List actions secrets of an organization.

Parameters:

Name Type Description Default
org str

name of the organization

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: orgListActionsSecrets

update

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

Create or Update a secret value in an organization.

Parameters:

Name Type Description Default
org str

name of organization

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: updateOrgSecret