GET /repos/{owner}/{repo}/actions/concurrency_groups/{concurrency_group_name}
Gets a specific concurrency group for a repository, including all instances in the group's queue. Returns 404 if the group is inactive or does not exist.
Optionally, pass ahead_of_run or ahead_of_job to filter the results to only the items
ahead of the specified workflow run or job in the queue, plus the specified item itself
(returned as the last element). This is useful for determining what is blocking a particular
run or job. Returns 422 if the specified run or job is not in this concurrency group.
When using ahead_of_run, this matches workflow-level concurrency and any reusable-workflow
leases held on behalf of that run. Job-level leases within the run are not considered to
block the run as a whole. Use ahead_of_job to match job-level concurrency and reusable-workflow
leases on the job's ancestor paths.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Servers
- https://api.github.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
repo |
String | Yes |
The name of the repository without the |
concurrency_group_name |
String | Yes |
The name of the concurrency group. |
owner |
String | Yes |
The account owner of the repository. The name is not case sensitive. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
ahead_of_job |
Integer | No |
Filter to items ahead of this job ID in the queue, plus the job itself.
Matches job-level concurrency and reusable-workflow leases on the job's
ancestor paths. Mutually exclusive with |
ahead_of_run |
Integer | No |
Filter to items ahead of this workflow run ID in the queue, plus the run itself.
Matches workflow-level concurrency and reusable-workflow leases held on behalf of
the run. Mutually exclusive with |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.