Get required workflow usage

GET

/repos/{org}/{repo}/actions/required_workflows/{required_workflow_id_for_repo}/timing

Gets the number of billable minutes used by a specific required workflow during the current billing cycle.

Billable minutes only apply to required workflows running in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "Managing billing for GitHub Actions."

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.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.github.com/repos///actions/required_workflows//timing'

Response Example

200 - Example 1

{
    "billable": {
        "MACOS": {
            "total_ms": 0
        },
        "UBUNTU": {
            "total_ms": 0
        },
        "WINDOWS": {
            "total_ms": 0
        }
    }
}

Request

Path Params

org

string

required

The organization name. The name is not case sensitive.

repo

string

required

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

required_workflow_id_for_repo

integer

required

The ID of the required workflow that has run at least once in a repository.

Responses

🟢200Response

application/json

Body

Workflow Usage

billable

object

required

MACOS

object

optional

UBUNTU

object

optional

WINDOWS

object

optional

🟠404404

Modified at 2023-08-15 02:59:24

Get a required workflow entity for a repository

List artifacts for a repository