Skip to content
forgit api docs

Get workflow usage

GET
/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing

[!WARNING]
This endpoint is in the process of closing down. Refer to “Actions Get workflow usage and Get workflow run usage endpoints closing down” for more information.

Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows 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”.

You can replace workflow_id with the workflow file name. For example, you could use main.yaml.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

API method documentation

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
owner
required
string

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

repo
required
string

The name of the repository without the .git extension. The name is not case sensitive.

workflow_id
required
One of:
integer

The ID of the workflow. You can also pass the workflow file name as a string.

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Response

Media type application/json
Workflow Usage

Workflow Usage

object
billable
required
object
UBUNTU
object
total_ms
integer
MACOS
object
total_ms
integer
WINDOWS
object
total_ms
integer
Examples
Example default 
{
  "billable": {
    "UBUNTU": {
      "total_ms": 180000
    },
    "MACOS": {
      "total_ms": 240000
    },
    "WINDOWS": {
      "total_ms": 300000
    }
  }
}