variables

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

SyncAsync

OrgsActionsVariables

The orgs.actions.variables namespace.

create

create(org: str, variablename: str, *, value: str) -> None

Create a new variable in organization.

Parameters:

Name	Type	Description	Default
`org`	`str`	name of the organization	required
`variablename`	`str`	name of the variable	required
`value`	`str`	Value of the variable to create. 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`	APIError is error format response.
`NotFoundError`	APINotFound is a not found error response.

Operation ID: createOrgVariable

delete

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

Delete organization's variable by name.

Parameters:

Name	Type	Description	Default
`org`	`str`	name of the organization	required
`variablename`	`str`	name of the variable	required

Returns:

Type	Description
`None`	No content.

Raises:

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

Operation ID: deleteOrgVariable

get

get(org: str, variablename: str) -> ActionVariable

Get organization's variable by name.

Parameters:

Name	Type	Description	Default
`org`	`str`	name of the organization	required
`variablename`	`str`	name of the variable	required

Returns:

Type	Description
`ActionVariable`	ActionVariable.

Raises:

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

Operation ID: getOrgVariable

list

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

List variables 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[ActionVariable]`	VariableList.

Raises:

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

Operation ID: getOrgVariablesList

update

update(org: str, variablename: str, *, name: str | None = None, value: str) -> None

Update variable in organization.

Parameters:

Name	Type	Description	Default
`org`	`str`	name of the organization	required
`variablename`	`str`	name of the variable	required
`name`	`str \| None`	New name for the variable. If the field is empty, the variable name won't be updated. Forgejo will convert it to uppercase.	`None`
`value`	`str`	Value of the variable to update. 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`	APIError is error format response.
`NotFoundError`	APINotFound is a not found error response.

Operation ID: updateOrgVariable

AsyncOrgsActionsVariables

The orgs.actions.variables namespace.

create

create(org: str, variablename: str, *, value: str) -> None

Create a new variable in organization.

Parameters:

Name	Type	Description	Default
`org`	`str`	name of the organization	required
`variablename`	`str`	name of the variable	required
`value`	`str`	Value of the variable to create. 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`	APIError is error format response.
`NotFoundError`	APINotFound is a not found error response.

Operation ID: createOrgVariable

delete

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

Delete organization's variable by name.

Parameters:

Name	Type	Description	Default
`org`	`str`	name of the organization	required
`variablename`	`str`	name of the variable	required

Returns:

Type	Description
`None`	No content.

Raises:

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

Operation ID: deleteOrgVariable

get

get(org: str, variablename: str) -> ActionVariable

Get organization's variable by name.

Parameters:

Name	Type	Description	Default
`org`	`str`	name of the organization	required
`variablename`	`str`	name of the variable	required

Returns:

Type	Description
`ActionVariable`	ActionVariable.

Raises:

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

Operation ID: getOrgVariable

list

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

List variables 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[ActionVariable]`	VariableList.

Raises:

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

Operation ID: getOrgVariablesList

update

update(org: str, variablename: str, *, name: str | None = None, value: str) -> None

Update variable in organization.

Parameters:

Name	Type	Description	Default
`org`	`str`	name of the organization	required
`variablename`	`str`	name of the variable	required
`name`	`str \| None`	New name for the variable. If the field is empty, the variable name won't be updated. Forgejo will convert it to uppercase.	`None`
`value`	`str`	Value of the variable to update. 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`	APIError is error format response.
`NotFoundError`	APINotFound is a not found error response.

Operation ID: updateOrgVariable