Read Codecov coverage reports, commits, pulls, flags and components.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Compare coverage between two commits (base vs. head) or for a pull request. Provide EITHER both `base` and `head`, OR `pullid`. Codecov REST: GET /{service}/{owner_username}/repos/{repo_name}/compare/.
Repository name, e.g. 'codecov-api' (required).
Owner username — the organization or user login on the git service, e.g. 'codecov' (required).
Base commit SHA (use together with `head`).
Head commit SHA (use together with `base`).
Pull request id to compare (use instead of base/head).
Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'.
Compare coverage between two commits (base vs. head) or for a pull request. Provide EITHER both `base` and `head`, OR `pullid`. Codecov REST: GET /{service}/{owner_username}/repos/{repo_name}/compare/.
| Argument | Type | Description |
|---|---|---|
| base | string | Base commit SHA (use together with `head`). |
| head | string | Head commit SHA (use together with `base`). |
| repo* | string | Repository name, e.g. 'codecov-api' (required). |
| owner* | string | Owner username — the organization or user login on the git service, e.g. 'codecov' (required). |
| pullid | string | Pull request id to compare (use instead of base/head). |
| service | string | Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"owner",
"repo"
],
"properties": {
"base": {
"type": "string",
"description": "Base commit SHA (use together with `head`)."
},
"head": {
"type": "string",
"description": "Head commit SHA (use together with `base`)."
},
"repo": {
"type": "string",
"minLength": 1,
"description": "Repository name, e.g. 'codecov-api' (required)."
},
"owner": {
"type": "string",
"minLength": 1,
"description": "Owner username — the organization or user login on the git service, e.g. 'codecov' (required)."
},
"pullid": {
"type": "string",
"description": "Pull request id to compare (use instead of base/head)."
},
"service": {
"enum": [
"github",
"gitlab",
"bitbucket",
"github_enterprise",
"gitlab_enterprise",
"bitbucket_server"
],
"type": "string",
"default": "github",
"description": "Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'."
}
}
}List the files whose coverage changed between two commits (base vs. head) or for a pull request. Provide EITHER both `base` and `head`, OR `pullid`. Codecov REST: GET /{service}/{owner_username}/repos/{repo_name}/compare/impacted_files.
| Argument | Type | Description |
|---|---|---|
| base | string | Base commit SHA (use together with `head`). |
| head | string | Head commit SHA (use together with `base`). |
| repo* | string | Repository name, e.g. 'codecov-api' (required). |
| owner* | string | Owner username — the organization or user login on the git service, e.g. 'codecov' (required). |
| pullid | string | Pull request id to compare (use instead of base/head). |
| service | string | Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"owner",
"repo"
],
"properties": {
"base": {
"type": "string",
"description": "Base commit SHA (use together with `head`)."
},
"head": {
"type": "string",
"description": "Head commit SHA (use together with `base`)."
},
"repo": {
"type": "string",
"minLength": 1,
"description": "Repository name, e.g. 'codecov-api' (required)."
},
"owner": {
"type": "string",
"minLength": 1,
"description": "Owner username — the organization or user login on the git service, e.g. 'codecov' (required)."
},
"pullid": {
"type": "string",
"description": "Pull request id to compare (use instead of base/head)."
},
"service": {
"enum": [
"github",
"gitlab",
"bitbucket",
"github_enterprise",
"gitlab_enterprise",
"bitbucket_server"
],
"type": "string",
"default": "github",
"description": "Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'."
}
}
}Get a single branch's detail, including its head commit's coverage totals. Codecov REST: GET /{service}/{owner_username}/repos/{repo_name}/branches/{name}/.
| Argument | Type | Description |
|---|---|---|
| repo* | string | Repository name, e.g. 'codecov-api' (required). |
| owner* | string | Owner username — the organization or user login on the git service, e.g. 'codecov' (required). |
| branch* | string | Branch name, e.g. 'main' (required). |
| service | string | Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"owner",
"repo",
"branch"
],
"properties": {
"repo": {
"type": "string",
"minLength": 1,
"description": "Repository name, e.g. 'codecov-api' (required)."
},
"owner": {
"type": "string",
"minLength": 1,
"description": "Owner username — the organization or user login on the git service, e.g. 'codecov' (required)."
},
"branch": {
"type": "string",
"minLength": 1,
"description": "Branch name, e.g. 'main' (required)."
},
"service": {
"enum": [
"github",
"gitlab",
"bitbucket",
"github_enterprise",
"gitlab_enterprise",
"bitbucket_server"
],
"type": "string",
"default": "github",
"description": "Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'."
}
}
}Get a single commit's detail, including its coverage totals and report. Codecov REST: GET /{service}/{owner_username}/repos/{repo_name}/commits/{commitid}/.
| Argument | Type | Description |
|---|---|---|
| repo* | string | Repository name, e.g. 'codecov-api' (required). |
| owner* | string | Owner username — the organization or user login on the git service, e.g. 'codecov' (required). |
| service | string | Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'. |
| commitid* | string | Commit SHA (required). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"owner",
"repo",
"commitid"
],
"properties": {
"repo": {
"type": "string",
"minLength": 1,
"description": "Repository name, e.g. 'codecov-api' (required)."
},
"owner": {
"type": "string",
"minLength": 1,
"description": "Owner username — the organization or user login on the git service, e.g. 'codecov' (required)."
},
"service": {
"enum": [
"github",
"gitlab",
"bitbucket",
"github_enterprise",
"gitlab_enterprise",
"bitbucket_server"
],
"type": "string",
"default": "github",
"description": "Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'."
},
"commitid": {
"type": "string",
"minLength": 1,
"description": "Commit SHA (required)."
}
}
}Full coverage report for a commit (defaults to default branch head) — totals plus per-file line coverage. Codecov REST: GET /{service}/{owner_username}/repos/{repo_name}/report/.
| Argument | Type | Description |
|---|---|---|
| sha | string | Commit SHA to report on (defaults to the default branch head). |
| flag | string | Restrict the report to a coverage flag. |
| path | string | Restrict the report to a file or directory path prefix. |
| repo* | string | Repository name, e.g. 'codecov-api' (required). |
| owner* | string | Owner username — the organization or user login on the git service, e.g. 'codecov' (required). |
| branch | string | Branch whose head to report on. |
| service | string | Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'. |
| componentId | string | Restrict the report to a component (maps to `component_id`). |
Coverage totals for a commit (defaults to default branch head), plus per-file totals. Codecov REST: GET /{service}/{owner_username}/repos/{repo_name}/totals/.
| Argument | Type | Description |
|---|---|---|
| sha | string | Commit SHA to report on (defaults to the default branch head). |
| flag | string | Restrict totals to a coverage flag. |
| path | string | Restrict totals to a file or directory path prefix. |
| repo* | string | Repository name, e.g. 'codecov-api' (required). |
| owner* | string | Owner username — the organization or user login on the git service, e.g. 'codecov' (required). |
| branch | string | Branch whose head to report on. |
| service | string | Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'. |
| componentId | string | Restrict totals to a component (maps to `component_id`). |
Coverage measurements over time for a repository, bucketed by interval. Codecov REST: GET /{service}/{owner_username}/repos/{repo_name}/coverage/.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number for paginated results (1-based). |
| repo* | string | Repository name, e.g. 'codecov-api' (required). |
| owner* | string | Owner username — the organization or user login on the git service, e.g. 'codecov' (required). |
| branch | string | Branch to measure (defaults to the default branch). |
| endDate | string | End of the range, yyyy-mm-dd (maps to `end_date`). |
| service | string | Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'. |
| interval | string | Aggregation interval for the trend — '1d', '7d' or '30d'. |
| pageSize | integer | Number of results per page (maps to `page_size`). |
Line-by-line coverage for a single file. Codecov REST: GET /{service}/{owner_username}/repos/{repo_name}/file_report/{path}/.
| Argument | Type | Description |
|---|---|---|
| sha | string | Commit SHA to report on (defaults to the default branch head). |
| path* | string | File path within the repo, e.g. 'src/app.ts' (required; slashes are URL-encoded). |
| repo* | string | Repository name, e.g. 'codecov-api' (required). |
| owner* | string | Owner username — the organization or user login on the git service, e.g. 'codecov' (required). |
| branch | string | Branch whose head to report on. |
| service | string | Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"owner",
"repo",
"path"
],
"properties": {
"sha": {
"type": "string",
"description": "Commit SHA to report on (defaults to the default branch head)."
},
"path": {
"type": "string",
"minLength": 1,
"description": "File path within the repo, e.g. 'src/app.ts' (required; slashes are URL-encoded)."
},
"repo": {
"type": "string",
"minLength": 1,
"description": "Repository name, e.g. 'codecov-api' (required)."
},
"owner": {
"type": "string",
"minLength": 1,
"description": "Owner username — the organization or user login on the git service, e.g. 'codecov' (required)."
},
"branch": {
"type": "string",
"description": "Branch whose head to report on."
},
"service": {
"enum": [
"github",
"gitlab",
"bitbucket",
"github_enterprise",
"gitlab_enterprise",
"bitbucket_server"
],
"type": "string",
"default": "github",
"description": "Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'."
}
}
}Coverage measurements over time for a single flag, bucketed by interval. Codecov REST: GET /{service}/{owner_username}/repos/{repo_name}/flags/{flag_name}/coverage/.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number for paginated results (1-based). |
| repo* | string | Repository name, e.g. 'codecov-api' (required). |
| owner* | string | Owner username — the organization or user login on the git service, e.g. 'codecov' (required). |
| branch | string | Branch to measure (defaults to the default branch). |
| endDate | string | End of the range, yyyy-mm-dd (maps to `end_date`). |
| service | string | Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'. |
| interval | string | Aggregation interval for the trend — '1d', '7d' or '30d'. |
| pageSize | integer | Number of results per page (maps to `page_size`). |
Get a single owner (org/user) detail. Codecov REST: GET /{service}/{owner_username}/.
| Argument | Type | Description |
|---|---|---|
| owner* | string | Owner username — the organization or user login on the git service, e.g. 'codecov' (required). |
| service | string | Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"owner"
],
"properties": {
"owner": {
"type": "string",
"minLength": 1,
"description": "Owner username — the organization or user login on the git service, e.g. 'codecov' (required)."
},
"service": {
"enum": [
"github",
"gitlab",
"bitbucket",
"github_enterprise",
"gitlab_enterprise",
"bitbucket_server"
],
"type": "string",
"default": "github",
"description": "Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'."
}
}
}Get a single pull request's detail, including its base/head coverage. Codecov REST: GET /{service}/{owner_username}/repos/{repo_name}/pulls/{pullid}/.
| Argument | Type | Description |
|---|---|---|
| repo* | string | Repository name, e.g. 'codecov-api' (required). |
| owner* | string | Owner username — the organization or user login on the git service, e.g. 'codecov' (required). |
| pullid* | string | Pull request number/id (required). |
| service | string | Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"owner",
"repo",
"pullid"
],
"properties": {
"repo": {
"type": "string",
"minLength": 1,
"description": "Repository name, e.g. 'codecov-api' (required)."
},
"owner": {
"type": "string",
"minLength": 1,
"description": "Owner username — the organization or user login on the git service, e.g. 'codecov' (required)."
},
"pullid": {
"type": "string",
"minLength": 1,
"description": "Pull request number/id (required)."
},
"service": {
"enum": [
"github",
"gitlab",
"bitbucket",
"github_enterprise",
"gitlab_enterprise",
"bitbucket_server"
],
"type": "string",
"default": "github",
"description": "Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'."
}
}
}Get a single repository's detail. Codecov REST: GET /{service}/{owner_username}/repos/{repo_name}/.
| Argument | Type | Description |
|---|---|---|
| repo* | string | Repository name, e.g. 'codecov-api' (required). |
| owner* | string | Owner username — the organization or user login on the git service, e.g. 'codecov' (required). |
| service | string | Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"owner",
"repo"
],
"properties": {
"repo": {
"type": "string",
"minLength": 1,
"description": "Repository name, e.g. 'codecov-api' (required)."
},
"owner": {
"type": "string",
"minLength": 1,
"description": "Owner username — the organization or user login on the git service, e.g. 'codecov' (required)."
},
"service": {
"enum": [
"github",
"gitlab",
"bitbucket",
"github_enterprise",
"gitlab_enterprise",
"bitbucket_server"
],
"type": "string",
"default": "github",
"description": "Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'."
}
}
}Get a repository's Codecov configuration. Codecov REST: GET /{service}/{owner_username}/repos/{repo_name}/config/.
| Argument | Type | Description |
|---|---|---|
| repo* | string | Repository name, e.g. 'codecov-api' (required). |
| owner* | string | Owner username — the organization or user login on the git service, e.g. 'codecov' (required). |
| service | string | Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"owner",
"repo"
],
"properties": {
"repo": {
"type": "string",
"minLength": 1,
"description": "Repository name, e.g. 'codecov-api' (required)."
},
"owner": {
"type": "string",
"minLength": 1,
"description": "Owner username — the organization or user login on the git service, e.g. 'codecov' (required)."
},
"service": {
"enum": [
"github",
"gitlab",
"bitbucket",
"github_enterprise",
"gitlab_enterprise",
"bitbucket_server"
],
"type": "string",
"default": "github",
"description": "Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'."
}
}
}Coverage report as a file/directory tree for a commit (defaults to default branch head). Codecov REST: GET /{service}/{owner_username}/repos/{repo_name}/report/tree.
| Argument | Type | Description |
|---|---|---|
| sha | string | Commit SHA to report on (defaults to the default branch head). |
| flag | string | Restrict the tree to a coverage flag. |
| path | string | Restrict the tree to a directory path prefix. |
| repo* | string | Repository name, e.g. 'codecov-api' (required). |
| depth | integer | Maximum tree depth to return. |
| owner* | string | Owner username — the organization or user login on the git service, e.g. 'codecov' (required). |
| branch | string | Branch whose head to report on. |
| service | string | Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'. |
List a repository's branches, optionally filtered by author and ordering. Codecov REST: GET /{service}/{owner_username}/repos/{repo_name}/branches/.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number for paginated results (1-based). |
| repo* | string | Repository name, e.g. 'codecov-api' (required). |
| owner* | string | Owner username — the organization or user login on the git service, e.g. 'codecov' (required). |
| author | string | Filter branches by author username. |
| service | string | Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'. |
| ordering | string | Ordering field, e.g. 'updatestamp' or '-updatestamp'. |
| pageSize | integer | Number of results per page (maps to `page_size`). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"owner",
"repo"
],
"properties": {
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Page number for paginated results (1-based)."
},
"repo": {
"type": "string",
"minLength": 1,
"description": "Repository name, e.g. 'codecov-api' (required)."
},
"owner": {
"type": "string",
"minLength": 1,
"description": "Owner username — the organization or user login on the git service, e.g. 'codecov' (required)."
},
"author": {
"type": "string",
"description": "Filter branches by author username."
},
"service": {
"enum": [
"github",
"gitlab",
"bitbucket",
"github_enterprise",
"gitlab_enterprise",
"bitbucket_server"
],
"type": "string",
"default": "github",
"description": "Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'."
},
"ordering": {
"type": "string",
"description": "Ordering field, e.g. 'updatestamp' or '-updatestamp'."
},
"pageSize": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Number of results per page (maps to `page_size`)."
}
}
}List the coverage report uploads recorded for a commit. Codecov REST: GET /{service}/{owner_username}/repos/{repo_name}/commits/{commitid}/uploads/.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number for paginated results (1-based). |
| repo* | string | Repository name, e.g. 'codecov-api' (required). |
| owner* | string | Owner username — the organization or user login on the git service, e.g. 'codecov' (required). |
| service | string | Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'. |
| commitid* | string | Commit SHA (required). |
| pageSize | integer | Number of results per page (maps to `page_size`). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"owner",
"repo",
"commitid"
],
"properties": {
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Page number for paginated results (1-based)."
},
"repo": {
"type": "string",
"minLength": 1,
"description": "Repository name, e.g. 'codecov-api' (required)."
},
"owner": {
"type": "string",
"minLength": 1,
"description": "Owner username — the organization or user login on the git service, e.g. 'codecov' (required)."
},
"service": {
"enum": [
"github",
"gitlab",
"bitbucket",
"github_enterprise",
"gitlab_enterprise",
"bitbucket_server"
],
"type": "string",
"default": "github",
"description": "Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'."
},
"commitid": {
"type": "string",
"minLength": 1,
"description": "Commit SHA (required)."
},
"pageSize": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Number of results per page (maps to `page_size`)."
}
}
}List a repository's commits, optionally filtered by branch. Codecov REST: GET /{service}/{owner_username}/repos/{repo_name}/commits/.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number for paginated results (1-based). |
| repo* | string | Repository name, e.g. 'codecov-api' (required). |
| owner* | string | Owner username — the organization or user login on the git service, e.g. 'codecov' (required). |
| branch | string | Filter commits to a branch, e.g. 'main'. |
| service | string | Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'. |
| pageSize | integer | Number of results per page (maps to `page_size`). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"owner",
"repo"
],
"properties": {
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Page number for paginated results (1-based)."
},
"repo": {
"type": "string",
"minLength": 1,
"description": "Repository name, e.g. 'codecov-api' (required)."
},
"owner": {
"type": "string",
"minLength": 1,
"description": "Owner username — the organization or user login on the git service, e.g. 'codecov' (required)."
},
"branch": {
"type": "string",
"description": "Filter commits to a branch, e.g. 'main'."
},
"service": {
"enum": [
"github",
"gitlab",
"bitbucket",
"github_enterprise",
"gitlab_enterprise",
"bitbucket_server"
],
"type": "string",
"default": "github",
"description": "Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'."
},
"pageSize": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Number of results per page (maps to `page_size`)."
}
}
}List a repository's components with their coverage. Codecov REST: GET /{service}/{owner_username}/repos/{repo_name}/components/.
| Argument | Type | Description |
|---|---|---|
| sha | string | Commit SHA to report components on. |
| repo* | string | Repository name, e.g. 'codecov-api' (required). |
| owner* | string | Owner username — the organization or user login on the git service, e.g. 'codecov' (required). |
| branch | string | Branch to report components on (defaults to the default branch). |
| service | string | Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"owner",
"repo"
],
"properties": {
"sha": {
"type": "string",
"description": "Commit SHA to report components on."
},
"repo": {
"type": "string",
"minLength": 1,
"description": "Repository name, e.g. 'codecov-api' (required)."
},
"owner": {
"type": "string",
"minLength": 1,
"description": "Owner username — the organization or user login on the git service, e.g. 'codecov' (required)."
},
"branch": {
"type": "string",
"description": "Branch to report components on (defaults to the default branch)."
},
"service": {
"enum": [
"github",
"gitlab",
"bitbucket",
"github_enterprise",
"gitlab_enterprise",
"bitbucket_server"
],
"type": "string",
"default": "github",
"description": "Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'."
}
}
}List a repository's coverage flags. Codecov REST: GET /{service}/{owner_username}/repos/{repo_name}/flags/.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number for paginated results (1-based). |
| repo* | string | Repository name, e.g. 'codecov-api' (required). |
| owner* | string | Owner username — the organization or user login on the git service, e.g. 'codecov' (required). |
| service | string | Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'. |
| pageSize | integer | Number of results per page (maps to `page_size`). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"owner",
"repo"
],
"properties": {
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Page number for paginated results (1-based)."
},
"repo": {
"type": "string",
"minLength": 1,
"description": "Repository name, e.g. 'codecov-api' (required)."
},
"owner": {
"type": "string",
"minLength": 1,
"description": "Owner username — the organization or user login on the git service, e.g. 'codecov' (required)."
},
"service": {
"enum": [
"github",
"gitlab",
"bitbucket",
"github_enterprise",
"gitlab_enterprise",
"bitbucket_server"
],
"type": "string",
"default": "github",
"description": "Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'."
},
"pageSize": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Number of results per page (maps to `page_size`)."
}
}
}List a repository's pull requests, optionally filtered by state and start date. Codecov REST: GET /{service}/{owner_username}/repos/{repo_name}/pulls/.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number for paginated results (1-based). |
| repo* | string | Repository name, e.g. 'codecov-api' (required). |
| owner* | string | Owner username — the organization or user login on the git service, e.g. 'codecov' (required). |
| state | string | Filter by pull state, e.g. 'open', 'closed' or 'merged'. |
| service | string | Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'. |
| ordering | string | Ordering field, e.g. 'pullid' or '-pullid'. |
| pageSize | integer | Number of results per page (maps to `page_size`). |
| startDate | string | Only include pulls updated on/after this date, yyyy-mm-dd (maps to `start_date`). |
List repositories for an owner, optionally filtered by active state, names or search. Codecov REST: GET /{service}/{owner_username}/repos/.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number for paginated results (1-based). |
| names | array | Filter to specific repository names (each is sent as a repeated `names` query param). |
| owner* | string | Owner username — the organization or user login on the git service, e.g. 'codecov' (required). |
| active | boolean | Filter to repos that are active (receiving coverage) or not. |
| search | string | Free-text search over repository name. |
| service | string | Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'. |
| pageSize | integer | Number of results per page (maps to `page_size`). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"owner"
],
"properties": {
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Page number for paginated results (1-based)."
},
"names": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter to specific repository names (each is sent as a repeated `names` query param)."
},
"owner": {
"type": "string",
"minLength": 1,
"description": "Owner username — the organization or user login on the git service, e.g. 'codecov' (required)."
},
"active": {
"type": "boolean",
"description": "Filter to repos that are active (receiving coverage) or not."
},
"search": {
"type": "string",
"description": "Free-text search over repository name."
},
"service": {
"enum": [
"github",
"gitlab",
"bitbucket",
"github_enterprise",
"gitlab_enterprise",
"bitbucket_server"
],
"type": "string",
"default": "github",
"description": "Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'."
},
"pageSize": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Number of results per page (maps to `page_size`)."
}
}
}List owners (organizations/users) the token can see on a git service. Codecov REST: GET /{service}/.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number for paginated results (1-based). |
| service | string | Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'. |
| pageSize | integer | Number of results per page (maps to `page_size`). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Page number for paginated results (1-based)."
},
"service": {
"enum": [
"github",
"gitlab",
"bitbucket",
"github_enterprise",
"gitlab_enterprise",
"bitbucket_server"
],
"type": "string",
"default": "github",
"description": "Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'."
},
"pageSize": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Number of results per page (maps to `page_size`)."
}
}
}List a repository's test-analytics results, optionally filtered by branch, commit, outcome and duration. Codecov REST: GET /{service}/{owner_username}/repos/{repo_name}/test-results/.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number for paginated results (1-based). |
| repo* | string | Repository name, e.g. 'codecov-api' (required). |
| owner* | string | Owner username — the organization or user login on the git service, e.g. 'codecov' (required). |
| branch | string | Filter to a branch, e.g. 'main'. |
| outcome | string | Filter by test outcome — 'pass', 'failure', 'error' or 'skip'. |
| service | string | Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'. |
| commitId | string | Filter to a commit SHA (maps to `commit_id`). |
| pageSize | integer | Number of results per page (maps to `page_size`). |
List users belonging to an owner (org), optionally filtered by activation/admin/search. Codecov REST: GET /{service}/{owner_username}/users/.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number for paginated results (1-based). |
| owner* | string | Owner username — the organization or user login on the git service, e.g. 'codecov' (required). |
| search | string | Free-text search over user name / username. |
| isAdmin | boolean | Filter by admin status (maps to `is_admin`). |
| service | string | Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'. |
| pageSize | integer | Number of results per page (maps to `page_size`). |
| activated | boolean | Filter by whether the user's seat is activated. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"owner"
],
"properties": {
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Page number for paginated results (1-based)."
},
"owner": {
"type": "string",
"minLength": 1,
"description": "Owner username — the organization or user login on the git service, e.g. 'codecov' (required)."
},
"search": {
"type": "string",
"description": "Free-text search over user name / username."
},
"isAdmin": {
"type": "boolean",
"description": "Filter by admin status (maps to `is_admin`)."
},
"service": {
"enum": [
"github",
"gitlab",
"bitbucket",
"github_enterprise",
"gitlab_enterprise",
"bitbucket_server"
],
"type": "string",
"default": "github",
"description": "Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'."
},
"pageSize": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Number of results per page (maps to `page_size`)."
},
"activated": {
"type": "boolean",
"description": "Filter by whether the user's seat is activated."
}
}
}{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"owner",
"repo"
],
"properties": {
"sha": {
"type": "string",
"description": "Commit SHA to report on (defaults to the default branch head)."
},
"flag": {
"type": "string",
"description": "Restrict the report to a coverage flag."
},
"path": {
"type": "string",
"description": "Restrict the report to a file or directory path prefix."
},
"repo": {
"type": "string",
"minLength": 1,
"description": "Repository name, e.g. 'codecov-api' (required)."
},
"owner": {
"type": "string",
"minLength": 1,
"description": "Owner username — the organization or user login on the git service, e.g. 'codecov' (required)."
},
"branch": {
"type": "string",
"description": "Branch whose head to report on."
},
"service": {
"enum": [
"github",
"gitlab",
"bitbucket",
"github_enterprise",
"gitlab_enterprise",
"bitbucket_server"
],
"type": "string",
"default": "github",
"description": "Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'."
},
"componentId": {
"type": "string",
"description": "Restrict the report to a component (maps to `component_id`)."
}
}
}{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"owner",
"repo"
],
"properties": {
"sha": {
"type": "string",
"description": "Commit SHA to report on (defaults to the default branch head)."
},
"flag": {
"type": "string",
"description": "Restrict totals to a coverage flag."
},
"path": {
"type": "string",
"description": "Restrict totals to a file or directory path prefix."
},
"repo": {
"type": "string",
"minLength": 1,
"description": "Repository name, e.g. 'codecov-api' (required)."
},
"owner": {
"type": "string",
"minLength": 1,
"description": "Owner username — the organization or user login on the git service, e.g. 'codecov' (required)."
},
"branch": {
"type": "string",
"description": "Branch whose head to report on."
},
"service": {
"enum": [
"github",
"gitlab",
"bitbucket",
"github_enterprise",
"gitlab_enterprise",
"bitbucket_server"
],
"type": "string",
"default": "github",
"description": "Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'."
},
"componentId": {
"type": "string",
"description": "Restrict totals to a component (maps to `component_id`)."
}
}
}| startDate | string | Start of the range, yyyy-mm-dd (maps to `start_date`). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"owner",
"repo"
],
"properties": {
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Page number for paginated results (1-based)."
},
"repo": {
"type": "string",
"minLength": 1,
"description": "Repository name, e.g. 'codecov-api' (required)."
},
"owner": {
"type": "string",
"minLength": 1,
"description": "Owner username — the organization or user login on the git service, e.g. 'codecov' (required)."
},
"branch": {
"type": "string",
"description": "Branch to measure (defaults to the default branch)."
},
"endDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "End of the range, yyyy-mm-dd (maps to `end_date`)."
},
"service": {
"enum": [
"github",
"gitlab",
"bitbucket",
"github_enterprise",
"gitlab_enterprise",
"bitbucket_server"
],
"type": "string",
"default": "github",
"description": "Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'."
},
"interval": {
"enum": [
"1d",
"7d",
"30d"
],
"type": "string",
"description": "Aggregation interval for the trend — '1d', '7d' or '30d'."
},
"pageSize": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Number of results per page (maps to `page_size`)."
},
"startDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Start of the range, yyyy-mm-dd (maps to `start_date`)."
}
}
}| flag_name* | string | Coverage flag name (required). |
| startDate | string | Start of the range, yyyy-mm-dd (maps to `start_date`). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"owner",
"repo",
"flag_name"
],
"properties": {
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Page number for paginated results (1-based)."
},
"repo": {
"type": "string",
"minLength": 1,
"description": "Repository name, e.g. 'codecov-api' (required)."
},
"owner": {
"type": "string",
"minLength": 1,
"description": "Owner username — the organization or user login on the git service, e.g. 'codecov' (required)."
},
"branch": {
"type": "string",
"description": "Branch to measure (defaults to the default branch)."
},
"endDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "End of the range, yyyy-mm-dd (maps to `end_date`)."
},
"service": {
"enum": [
"github",
"gitlab",
"bitbucket",
"github_enterprise",
"gitlab_enterprise",
"bitbucket_server"
],
"type": "string",
"default": "github",
"description": "Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'."
},
"interval": {
"enum": [
"1d",
"7d",
"30d"
],
"type": "string",
"description": "Aggregation interval for the trend — '1d', '7d' or '30d'."
},
"pageSize": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Number of results per page (maps to `page_size`)."
},
"flag_name": {
"type": "string",
"minLength": 1,
"description": "Coverage flag name (required)."
},
"startDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Start of the range, yyyy-mm-dd (maps to `start_date`)."
}
}
}| componentId |
| string |
| Restrict the tree to a component (maps to `component_id`). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"owner",
"repo"
],
"properties": {
"sha": {
"type": "string",
"description": "Commit SHA to report on (defaults to the default branch head)."
},
"flag": {
"type": "string",
"description": "Restrict the tree to a coverage flag."
},
"path": {
"type": "string",
"description": "Restrict the tree to a directory path prefix."
},
"repo": {
"type": "string",
"minLength": 1,
"description": "Repository name, e.g. 'codecov-api' (required)."
},
"depth": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Maximum tree depth to return."
},
"owner": {
"type": "string",
"minLength": 1,
"description": "Owner username — the organization or user login on the git service, e.g. 'codecov' (required)."
},
"branch": {
"type": "string",
"description": "Branch whose head to report on."
},
"service": {
"enum": [
"github",
"gitlab",
"bitbucket",
"github_enterprise",
"gitlab_enterprise",
"bitbucket_server"
],
"type": "string",
"default": "github",
"description": "Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'."
},
"componentId": {
"type": "string",
"description": "Restrict the tree to a component (maps to `component_id`)."
}
}
}{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"owner",
"repo"
],
"properties": {
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Page number for paginated results (1-based)."
},
"repo": {
"type": "string",
"minLength": 1,
"description": "Repository name, e.g. 'codecov-api' (required)."
},
"owner": {
"type": "string",
"minLength": 1,
"description": "Owner username — the organization or user login on the git service, e.g. 'codecov' (required)."
},
"state": {
"type": "string",
"description": "Filter by pull state, e.g. 'open', 'closed' or 'merged'."
},
"service": {
"enum": [
"github",
"gitlab",
"bitbucket",
"github_enterprise",
"gitlab_enterprise",
"bitbucket_server"
],
"type": "string",
"default": "github",
"description": "Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'."
},
"ordering": {
"type": "string",
"description": "Ordering field, e.g. 'pullid' or '-pullid'."
},
"pageSize": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Number of results per page (maps to `page_size`)."
},
"startDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Only include pulls updated on/after this date, yyyy-mm-dd (maps to `start_date`)."
}
}
}| durationMax | number | Maximum test duration in seconds (maps to `duration_max`). |
| durationMin | number | Minimum test duration in seconds (maps to `duration_min`). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"owner",
"repo"
],
"properties": {
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Page number for paginated results (1-based)."
},
"repo": {
"type": "string",
"minLength": 1,
"description": "Repository name, e.g. 'codecov-api' (required)."
},
"owner": {
"type": "string",
"minLength": 1,
"description": "Owner username — the organization or user login on the git service, e.g. 'codecov' (required)."
},
"branch": {
"type": "string",
"description": "Filter to a branch, e.g. 'main'."
},
"outcome": {
"enum": [
"pass",
"failure",
"error",
"skip"
],
"type": "string",
"description": "Filter by test outcome — 'pass', 'failure', 'error' or 'skip'."
},
"service": {
"enum": [
"github",
"gitlab",
"bitbucket",
"github_enterprise",
"gitlab_enterprise",
"bitbucket_server"
],
"type": "string",
"default": "github",
"description": "Git service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'."
},
"commitId": {
"type": "string",
"description": "Filter to a commit SHA (maps to `commit_id`)."
},
"pageSize": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Number of results per page (maps to `page_size`)."
},
"durationMax": {
"type": "number",
"description": "Maximum test duration in seconds (maps to `duration_max`)."
},
"durationMin": {
"type": "number",
"description": "Minimum test duration in seconds (maps to `duration_min`)."
}
}
}