Skip to main content

artifacts

Overview

Nameartifacts
TypeResource
Idgithub.actions.artifacts

Fields

NameDatatypeDescription
idinteger
namestringThe name of the artifact.
created_atstring
updated_atstring
expiredbooleanWhether or not the artifact has expired.
node_idstring
archive_download_urlstring
workflow_runobject
size_in_bytesintegerThe size in bytes of the artifact.
urlstring
expires_atstring

Methods

NameAccessible byRequired ParamsDescription
get_artifactSELECTartifact_id, owner, repoGets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
list_artifacts_for_repoSELECTowner, repoLists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
list_workflow_run_artifactsSELECTowner, repo, run_idLists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
delete_artifactDELETEartifact_id, owner, repoDeletes an artifact for a workflow run. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.
download_artifactEXECarchive_format, artifact_id, owner, repoGets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for Location: in
the response header to find the URL for the download. The :archive_format must be zip.

You must authenticate using an access token with the repo scope to use this endpoint.
GitHub Apps must have the actions:read permission to use this endpoint.