REST API endpoints for issue dependencies
Use the REST API to view, add, and remove issue dependencies.
List dependencies an issue is blocked by
You can use the REST API to list the dependencies an issue is blocked by.
This endpoint supports the following custom media types. For more information, see Media types.
application/vnd.github.raw+json: Returns the raw Markdown body. Response will includebody. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the Markdown body. Response will includebody_text.application/vnd.github.html+json: Returns HTML rendered from the body's Markdown. Response will includebody_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will includebody,body_text, andbody_html.
Fine-grained access tokens for "List dependencies an issue is blocked by"
This endpoint works with the following fine-grained token types:
- GitHub App user access tokens
- GitHub App installation access tokens
- Fine-grained personal access tokens
The fine-grained token must have the following permission set:
- "Issues" repository permissions (read)
This endpoint can be used without authentication or the aforementioned permissions if only public resources are requested.
Parameters for "List dependencies an issue is blocked by"
| Name, Type, Description |
|---|
accept string Setting to |
| Name, Type, Description |
|---|
owner string RequiredThe account owner of the repository. The name is not case sensitive. |
repo string RequiredThe name of the repository without the |
issue_number integer RequiredThe number that identifies the issue. |
| Name, Type, Description |
|---|
per_page integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Default: |
page integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Default: |
HTTP response status codes for "List dependencies an issue is blocked by"
| Status code | Description |
|---|---|
200 | OK |
301 | Moved permanently |
404 | Resource not found |
410 | Gone |