# Codacy Repository API

**Canonical:** https://apis.io/apis/codacy/codacy-repository-api/  
**Provider:** Codacy — https://apis.io/providers/codacy/  
**Base URL:** https://api.codacy.com/api/v3  
**Documentation:** https://docs.codacy.com/codacy-api/using-the-codacy-api/

Codacy Repository API is one of 30 APIs that [Codacy](https://apis.io/providers/codacy/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Repository. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

The repository API from Codacy — 40 operation(s) for repository.

## Operations (48)

| Method | Path | Summary |
|---|---|---|
| POST | `/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/follow` | Follow a repository that was already added to Codacy |
| DELETE | `/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/follow` | Unfollow a repository |
| GET | `/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/quality/repository` | Get quality settings for the specific repository |
| PUT | `/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/quality/repository` | Update quality goals settings for the specific repository |
| POST | `/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/ssh-user-key` | Regenerate the user SSH key that Codacy uses to clone the repository |
| POST | `/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/ssh-repository-key` | Regenerate the SSH key that Codacy uses to clone the repository |
| GET | `/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/stored-ssh-key` | Get the public SSH key for the repository |
| POST | `/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/sync` | Synchronize repository name and visibility with Git provider |
| GET | `/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/analysis` | Get the status of the repository setting **Run analysis on your build server** |
| PATCH | `/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/analysis` | Update the status of the repository setting **Run analysis on your build… |
| GET | `/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/quality/commits` | Get quality settings for the commits of a repository |
| PUT | `/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/quality/commits` | Update quality settings for the commits of a repository |
| POST | `/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/quality/commits/reset` | Reset quality settings for the commits of a repository to Codacy’s default… |
| POST | `/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/quality/pull-requests/reset` | Reset quality settings for the pull requests of a repository to Codacy’s… |
| POST | `/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/quality/repository/reset` | Reset quality settings for the repository to Codacy’s default values |
| GET | `/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/quality/pull-requests` | Get quality settings for the pull requests of a repository |
| PUT | `/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/quality/pull-requests` | Update quality settings for the pull requests of a repository |
| GET | `/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/integrations/providerSettings` | Get Git provider integration settings for a repository |
| PATCH | `/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/integrations/providerSettings` | Update Git provider integration settings for a repository |
| GET | `/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/integrations/postCommitHook` | Create a post-commit hook for a repository |
| POST | `/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/integrations/refreshProvider` | Refresh the Git provider integration for a repository (GitLab and Bitbucket… |
| POST | `/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/reanalyzeCommit` | Reanalyze a specific commit in a repository |
| GET | `/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}` | Fetch the specified repository |
| DELETE | `/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}` | Delete the specified repository |
| GET | `/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/branches` | List repository branches |
| PATCH | `/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/branches/{branchName}` | Update the settings for a repository branch |
| POST | `/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/branches/{branchName}/setDefault` | Set branch as default |
| GET | `/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/branches/{branchName}/required-checks` | Get branch required status checks |
| POST | `/organizations/gh/{remoteOrganizationName}/repositories/{repositoryName}/badge` | Create a pull request adding the Codacy analysis badge to the repository |
| POST | `/repositories` | Add a repository to Codacy |
| GET | `/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/files` | List files in a repository |
| GET | `/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/directories` | List folders in a repository |
| GET | `/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/ignored-files` | List ignored files in a repository |
| GET | `/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/files/{fileId}` | Get analysis information and coverage metrics for a file in a repository |
| GET | `/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/files/{fileId}/duplication` | Get the list of duplicated code blocks for a file in a repository |
| GET | `/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/files/{fileId}/issues` | Get the issue list for a file in a repository |
| GET | `/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/tokens` | List the repository API tokens |
| POST | `/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/tokens` | Create a new repository API token |
| POST | `/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/tokens/delete` | Delete multiple repository API tokens by id |
| DELETE | `/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/tokens/{tokenId}` | Delete a repository API token by ID |
| GET | `/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/coverage/status` | List the most recent coverage reports and their status |
| GET | `/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/commits/{commitUuid}/coverage/reports` | List coverage reports for a commit |
| GET | `/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/commits/{commitUuid}/coverage/reports/{reportUuid}` | Get a coverage report with its contents |
| GET | `/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/files/{fileId}/coverage` | Get coverage information for a file in the head commit of a repository branch |
| PATCH | `/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/file` | Ignore or unignore a file |
| GET | `/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/pull-requests/{pullRequestNumber}/diff` | Get the human-readable Git diff of a pull request |
| GET | `/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/commits/{commitUuid}/diff` | Get the human-readable Git diff of a commit |
| GET | `/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/base/{baseCommitUuid}/head/{headCommitUuid}/diff` | Get the human-readable Git diff between a head commit and a base commit |

## Machine-readable artifacts (7)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/codacy/refs/heads/main/openapi/codacy-repository-api-openapi.yml
- **Documentation** — https://docs.codacy.com/codacy-api/using-the-codacy-api/
- **APIReference** — https://api.codacy.com/api/api-docs
- **Documentation** — https://docs.codacy.com/codacy-api/examples/adding-repositories-to-codacy-programmatically/
- **Documentation** — https://docs.codacy.com/codacy-api/examples/obtaining-current-issues-in-repositories/
- **Documentation** — https://docs.codacy.com/coverage-reporter/
- **Documentation** — https://docs.codacy.com/organizations/security-monitor/

## Other Codacy APIs (12)

- [Codacy Account API](https://apis.io/apis/codacy/codacy-account-api/)
- [Codacy Coverage API](https://apis.io/apis/codacy/codacy-coverage-api/)
- [Codacy Security API](https://apis.io/apis/codacy/codacy-security-api/)
- [Codacy Admin API](https://apis.io/apis/codacy/codacy-admin-api/)
- [Codacy Aiinventory API](https://apis.io/apis/codacy/codacy-aiinventory-api/)
- [Codacy Analysis API](https://apis.io/apis/codacy/codacy-analysis-api/)
- [Codacy App API](https://apis.io/apis/codacy/codacy-app-api/)
- [Codacy Billing API](https://apis.io/apis/codacy/codacy-billing-api/)
- [Codacy coding standards API](https://apis.io/apis/codacy/codacy-coding-standards-api/)
- [Codacy Configuration API](https://apis.io/apis/codacy/codacy-configuration-api/)
- [Codacy Dast API](https://apis.io/apis/codacy/codacy-dast-api/)
- [Codacy Enterprise API](https://apis.io/apis/codacy/codacy-enterprise-api/)

## Tags

Repository

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/codacy/codacy-repository-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/codacy/.
