List workflow run artifacts - GitHub v3 REST API

Lists 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.

{ "artifacts": [ { "archive_download_url": "https://api.github.com/repos/github/hello-world/actions/artifacts/5/zip", "created_at": "2019-08-24T14:15:22Z", "expired": true, "expires_at": "2019-08-24T14:15:22Z", "id": 5, "name": "AdventureWorks.Framework", "node_id": "MDEwOkNoZWNrU3VpdGU1", "size_in_bytes": 12345, "updated_at": "2019-08-24T14:15:22Z", "url": "https://api.github.com/repos/github/hello-world/actions/artifacts/5", "workflow_run": { "head_branch": "main", "head_repository_id": 42, "head_sha": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d", "id": 10, "repository_id": 42 } } ], "total_count": 0 }

Request

Path Params

owner

string

required

The account owner of the repository. The name is not case sensitive.

repo

string

required

The name of the repository. The name is not case sensitive.

run_id

integer

required

The unique identifier of the workflow run.

Query Params

per_page

integer

optional

The number of results per page (max 100).

page

integer

optional

Page number of the results to fetch.

Responses

🟢200Response

application/json

Body

artifacts

array[object (Artifact) {11}]

required

archive_download_url

string

required

Example:

https://api.github.com/repos/github/hello-world/actions/artifacts/5/zip

created_at

string <date-time> | null

required

expired

boolean

required

Whether or not the artifact has expired.

expires_at

string <date-time> | null

required

integer

required

Example:

name

string

required

The name of the artifact.

Example:

AdventureWorks.Framework

node_id

string

required

Example:

MDEwOkNoZWNrU3VpdGU1

size_in_bytes

integer

required

The size in bytes of the artifact.

Example:

12345

updated_at

string <date-time> | null

required

url

string

required

Example:

https://api.github.com/repos/github/hello-world/actions/artifacts/5

workflow_run

object | null

optional

total_count

integer

required