Skip to content

artifacts

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

ReposActionsArtifacts

The repos.actions.artifacts namespace.

delete 

delete(owner: str, repo: str, artifact_id: int) -> None

Mark an artifact for deletion.

Marks the artifact for deletion. Storage space will be reclaimed asynchronously by a background job.

Parameters:

Name Type Description Default
owner str

owner of the repo

 required
repo str

name of the repo

 required
artifact_id int

ID of the artifact

 required

Returns:

Type Description
None

No content.

Raises:

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

Operation ID: DeleteActionArtifact

download 

download(owner: str, repo: str, artifact_id: int) -> bytes

Download an artifact.

Parameters:

Name Type Description Default
owner str

owner of the repo

 required
repo str

name of the repo

 required
artifact_id int

ID of the artifact

 required

Returns:

Type Description
bytes

the artifact archive.

Raises:

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

Operation ID: DownloadActionArtifact

get 

get(owner: str, repo: str, artifact_id: int) -> ActionArtifact

Get an artifact by ID.

Parameters:

Name Type Description Default
owner str

owner of the repo

 required
repo str

name of the repo

 required
artifact_id int

ID of the artifact

 required

Returns:

Type Description
ActionArtifact

ActionArtifact.

Raises:

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

Operation ID: GetActionArtifact

list 

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

List a repository's artifacts.

Parameters:

Name Type Description Default
owner str

owner of the repo

 required
repo str

name of the repo

 required
name str | None

filter by artifact name

 None
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[ActionArtifact]

ActionArtifactList.

Raises:

Type Description
BadRequestError
  1. APIError is error format response.
ForbiddenError
  1. APIForbiddenError is a forbidden error response.

Operation ID: ListActionArtifacts

AsyncReposActionsArtifacts

The repos.actions.artifacts namespace.

delete 

delete(owner: str, repo: str, artifact_id: int) -> None

Mark an artifact for deletion.

Marks the artifact for deletion. Storage space will be reclaimed asynchronously by a background job.

Parameters:

Name Type Description Default
owner str

owner of the repo

 required
repo str

name of the repo

 required
artifact_id int

ID of the artifact

 required

Returns:

Type Description
None

No content.

Raises:

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

Operation ID: DeleteActionArtifact

download 

download(owner: str, repo: str, artifact_id: int) -> bytes

Download an artifact.

Parameters:

Name Type Description Default
owner str

owner of the repo

 required
repo str

name of the repo

 required
artifact_id int

ID of the artifact

 required

Returns:

Type Description
bytes

the artifact archive.

Raises:

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

Operation ID: DownloadActionArtifact

get 

get(owner: str, repo: str, artifact_id: int) -> ActionArtifact

Get an artifact by ID.

Parameters:

Name Type Description Default
owner str

owner of the repo

 required
repo str

name of the repo

 required
artifact_id int

ID of the artifact

 required

Returns:

Type Description
ActionArtifact

ActionArtifact.

Raises:

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

Operation ID: GetActionArtifact

list 

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

List a repository's artifacts.

Parameters:

Name Type Description Default
owner str

owner of the repo

 required
repo str

name of the repo

 required
name str | None

filter by artifact name

 None
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[ActionArtifact]

ActionArtifactList.

Raises:

Type Description
BadRequestError
  1. APIError is error format response.
ForbiddenError
  1. APIForbiddenError is a forbidden error response.

Operation ID: ListActionArtifacts