PAGES

← Codacy

Codacy — API

Codacy APIv3.1.0 Read the vendor's spec ↗

  • 293 endpoints
  • 10 deprecated
  • 14 versions archived since Aug 2, 2026
  • Last checked Nov 2, 2026

Codacy API v3 reference.

Get started

first call
$ curl "https://api.codacy.com/api/v3/user" \
  -H "api-token: $API_KEY"

Set $API_KEY first, then paste.

Base URL
https://api.codacy.com/api/v3
Authenticate
API key in the api-token header Learn how to generate an account API token
1 other scheme
  • API key in the project-token header

What it covers

18 more areas

Endpoints

293 of 293

Open an endpoint for a runnable command, its inputs and what it returns.

Analysis 49

  • GET /analysis/organizations/{provider}/{remoteOrganizationName}/pull-requests List organization pull requests from repositories that the user has access to

    Loading…

  • GET /analysis/organizations/{provider}/{remoteOrganizationName}/repositories List organization repositories with analysis information for the authenticated user

    Loading…

  • GET /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName} Get a repository with analysis information for the authenticated user

    Loading…

  • GET /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/analysis-progress Get the analysis progress of a repository

    Loading…

  • GET /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/autoconfig/runs Get latest autoconfig run summary

    Loading…

  • GET /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/autoconfig/status Get autoconfig run status

    Loading…

  • GET /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/category-overviews List analysis category overviews for a repository that the user has access to

    Loading…

  • GET /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/commit-statistics List commit analysis statistics for the last n days that have analysis data

    Loading…

  • GET /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/commits Return analysis results for the commits in a branch

    Loading…

  • GET /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/commits/{commitUuid} Get analysis results for a commit

    Loading…

  • GET /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/commits/{commitUuid}/clones List duplicate code blocks found in a commit

    Loading…

  • GET /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/commits/{commitUuid}/deltaStatistics Get analysis statistics of a commit

    Loading…

  • GET /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/commits/{commitUuid}/files List files of a commit with analysis results

    Loading…

  • GET /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/commits/{commitUuid}/logs Get analysis logs for a commit

    Loading…

  • GET /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/commits/{srcCommitUuid}/deltaIssues List the issues introduced or fixed by a commit

    Loading…

  • GET /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/issues/hasSuggestions Check if the repository has quick fix suggestions for a branch

    Loading…

  • GET /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/issues/patch Get quickfixes for issues in patch format

    Loading…

  • GET /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/issues/{issueId} Get information about an open issue in a repository

    Loading…

  • GET /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/pull-requests List pull requests from a repository that the user has access to

    Loading…

  • GET /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/pull-requests/{pullRequestNumber} Get pull request from a repository

    Loading…

  • GET /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/pull-requests/{pullRequestNumber}/clones List duplicate code blocks found in a pull request

    Loading…

  • GET /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/pull-requests/{pullRequestNumber}/commits Return analysis results for the commits in a pull request

    Loading…

  • GET /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/pull-requests/{pullRequestNumber}/coverage/status List all coverage reports uploaded for the common ancestor commit and head commit of a pull request branch

    Loading…

  • GET /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/pull-requests/{pullRequestNumber}/files List files of a pull request with analysis results

    Loading…

  • GET /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/pull-requests/{pullRequestNumber}/issues List issues found in a pull request

    Loading…

  • GET /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/pull-requests/{pullRequestNumber}/issues/patch Get quickfixes for pull request issues in patch format

    Loading…

  • GET /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/pull-requests/{pullRequestNumber}/logs Get analysis logs for a pull request

    Loading…

  • GET /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/quality-settings Get quality settings for the specific repository deprecated

    Loading…

  • GET /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/tools Get analysis tools settings of a repository

    Loading…

  • GET /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/tools/conflicts Get tools with conflicts in a repository

    Loading…

  • GET /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/tools/{toolUuid}/conflicts Patterns with Coding Standards conflicts for tool.

    Loading…

  • GET /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/tools/{toolUuid}/patterns Patterns configuration for (repository, tool).

    Loading…

  • GET /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/tools/{toolUuid}/patterns/overview Patterns overview for tool.

    Loading…

  • GET /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/tools/{toolUuid}/patterns/{patternId} Patterns configuration for (repository, tool, pattern).

    Loading…

  • GET /commits/{commitId} Get information about a commit

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/commit/{commitId} Get information about a commit deprecated

    Loading…

  • PATCH /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/issues/{issueId} Ignore or unignore an issue

    Loading…

  • PATCH /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/issues/{issueId}/false-positive/ignore Ignore the false positive result in an issue

    Loading…

  • PATCH /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/tools/{toolUuid} Configure an analysis tool by enabling and disabling its patterns for a repository.

    Loading…

  • PATCH /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/tools/{toolUuid}/patterns Bulk updates the code patterns of a tool in a repository.

    Loading…

  • POST /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/autoconfig Add repository autoconfiguration run

    Loading…

  • POST /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/ignoredIssues/search List ignored issues in a repository

    Loading…

  • POST /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/issues/bulk-ignore Bulk ignore issues in a repository

    Loading…

  • POST /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/issues/overview Get an overview of the issues in a repository

    Loading…

  • POST /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/issues/search List issues in a repository

    Loading…

  • POST /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/pull-requests/{pullRequestNumber}/ai-reviewer/trigger Triggers an AI review for a pull request

    Loading…

  • POST /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/pull-requests/{pullRequestNumber}/bypass Bypass analysis status in a pull request

    Loading…

  • POST /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/recover Recover a stuck repository

    Loading…

  • POST /search/analysis/organizations/{provider}/{remoteOrganizationName}/repositories Search organization repositories with analysis information for the authenticated user

    Loading…

Repository 48

  • DELETE /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName} Delete the specified repository

    Loading…

  • DELETE /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/follow Unfollow a repository

    Loading…

  • DELETE /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/tokens/{tokenId} Delete a repository API token by ID

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName} Fetch the specified repository

    Loading…

  • 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

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/branches List repository branches

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/branches/{branchName}/required-checks Get branch required status checks

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/commits/{commitUuid}/coverage/reports List coverage reports for a commit

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/commits/{commitUuid}/coverage/reports/{reportUuid} Get a coverage report with its contents

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/commits/{commitUuid}/diff Get the human-readable Git diff of a commit

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/coverage/status List the most recent coverage reports and their status

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/directories List folders in a repository

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/files List files in a repository

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/files/{fileId} Get analysis information and coverage metrics for a file in a repository

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/files/{fileId}/coverage Get coverage information for a file in the head commit of a repository branch.

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/files/{fileId}/duplication Get the list of duplicated code blocks for a file in a repository

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/files/{fileId}/issues Get the issue list for a file in a repository

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/ignored-files List ignored files in a repository

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/integrations/postCommitHook Create a post-commit hook for a repository

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/integrations/providerSettings Get Git provider integration settings for a repository

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/pull-requests/{pullRequestNumber}/diff Get the human-readable Git diff of a pull request

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/analysis Get the status of the repository setting Run analysis on your build server

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/quality/commits Get quality settings for the commits of a repository

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/quality/pull-requests Get quality settings for the pull requests of a repository

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/quality/repository Get quality settings for the specific repository

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/stored-ssh-key Get the public SSH key for the repository

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/tokens List the repository API tokens

    Loading…

  • PATCH /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/branches/{branchName} Update the settings for a repository branch

    Loading…

  • PATCH /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/file Ignore or unignore a file

    Loading…

  • PATCH /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/integrations/providerSettings Update Git provider integration settings for a repository

    Loading…

  • PATCH /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/analysis Update the status of the repository setting Run analysis on your build server

    Loading…

  • POST /organizations/gh/{remoteOrganizationName}/repositories/{repositoryName}/badge Create a pull request adding the Codacy analysis badge to the repository

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/branches/{branchName}/setDefault Set branch as default

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/follow Follow a repository that was already added to Codacy

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/integrations/refreshProvider Refresh the Git provider integration for a repository (GitLab and Bitbucket only)

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/reanalyzeCommit Reanalyze a specific commit in a repository

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/quality/commits/reset Reset quality settings for the commits of a repository to Codacy’s default values

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/quality/pull-requests/reset Reset quality settings for the pull requests of a repository to Codacy’s default values

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/quality/repository/reset Reset quality settings for the repository to Codacy’s default values

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/ssh-repository-key Regenerate the SSH key that Codacy uses to clone the repository

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/ssh-user-key Regenerate the user SSH key that Codacy uses to clone the repository

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/sync Synchronize repository name and visibility with Git provider

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/tokens Create a new repository API token

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/tokens/delete Delete multiple repository API tokens by id

    Loading…

  • POST /repositories Add a repository to Codacy

    Loading…

  • PUT /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/quality/commits Update quality settings for the commits of a repository

    Loading…

  • PUT /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/quality/pull-requests Update quality settings for the pull requests of a repository

    Loading…

  • PUT /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/quality/repository Update quality goals settings for the specific repository

    Loading…

Organization 32

  • DELETE /organizations/{provider}/{remoteOrganizationName} Delete organization

    Loading…

  • DELETE /organizations/{provider}/{remoteOrganizationName}/integrations/jira Delete the Jira integration of the organization and associated resources

    Loading…

  • DELETE /organizations/{provider}/{remoteOrganizationName}/integrations/slack Delete the Slack integration of the organization and associated resources

    Loading…

  • DELETE /organizations/{provider}/{remoteOrganizationName}/join Decline requests to join an organization

    Loading…

  • DELETE /organizations/{provider}/{remoteOrganizationName}/join/{accountIdentifier} Delete a request to join an organization

    Loading…

  • GET /onboarding/organizations/{provider}/{remoteOrganizationName}/progress Retrieve the onboarding progress of an organization

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName} Get organization

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/audit Retrieve the audit logs for the organization

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/billing Get detailed information about organization billing

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/billing/card Get card information about organization billing

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/billing/estimation Get a billing estimation

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/integrations/jira Get the Jira integration of the organization

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/integrations/providerSettings Get Git provider settings

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/integrations/slack Get the Slack integration of the organization

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/join List requests to join an organization

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/people/leave/check Check if the user can leave the organization

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/repositories List organization repositories for the authenticated user

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/settings/submodules/check Check if the submodules option is enabled for the organization

    Loading…

  • PATCH /organizations/{provider}/{remoteOrganizationName}/analysisConfigurationMinimumPermission Configure what your organization members can do across the Codacy platform

    Loading…

  • PATCH /organizations/{provider}/{remoteOrganizationName}/integrations/providerSettings Create or update Git provider settings

    Loading…

  • POST /organizations Add an organization to Codacy

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/billing Update the information about organization billing

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/billing/card Add a card to the organization

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/billing/change-plan Change the plan of an organization

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/billing/sync Sync the information about organization billing deprecated

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/integrations/providerSettings/apply Apply default settings to all repositories

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/join Join an organization

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/joinMode Update the join mode of an organization

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/settings/sync Synchronize Codacy organization name with the Git provider

    Loading…

  • POST /user/billing/sync Sync the information about user's organization billing

    Loading…

  • PUT /organizations/{provider}/{remoteOrganizationName}/integrations/jira Create or update the Jira integration of the organization

    Loading…

  • PUT /organizations/{provider}/{remoteOrganizationName}/integrations/slack Create or update the Slack integration of the organization

    Loading…

Security 22

  • DELETE /organizations/{provider}/{remoteOrganizationName}/security/managers/{userId} Revoke the Security Manager role from an organization member

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/security/categories List security subcategories that have security issues

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/security/dashboard Get metrics for the security and risk management dashboard deprecated

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/security/dast/reports List uploaded DAST scan reports and their state

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/security/items List security and risk management items for an organization deprecated

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/security/items/{srmItemId} Get a single security and risk management finding

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/security/managers List organization admins and security managers

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/security/repositories List organization repositories that have security issues

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/security/sla Get the SLA configuration for an organization

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/security/dashboard Get metrics for the security and risk management dashboard

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/security/dashboard/categories/search List security categories with findings

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/security/dashboard/history/search Get the evolution of security findings over time

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/security/dashboard/remediation/history/search Get the weekly remediation of security findings over the last 90 days

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/security/dashboard/remediation/search Get the remediation of security findings per severity

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/security/dashboard/repositories/search List repositories with security findings

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/security/items/search List security and risk management items for an organization

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/security/items/{srmItemId}/ignore Ignore a single item with an optional comment

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/security/items/{srmItemId}/unignore Unignore a single item (only previously ignored items can be unignored)

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/security/managers Assign the Security Manager role to an organization member

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/security/tools/dast/{toolName}/reports Upload dynamic application security testing (DAST) scan report generated by the specified tool in the specified format.

    Loading…

  • POST /security/dependencies/ossf/scorecard Get the OSSF Scorecard for a repository

    Loading…

  • PUT /organizations/{provider}/{remoteOrganizationName}/security/sla Update the SLA configuration for an organization

    Loading…

Account 17

  • DELETE /user Delete the authenticated user

    Loading…

  • DELETE /user/integrations/{provider} Delete an integration for the authenticated user

    Loading…

  • DELETE /user/tokens/{tokenId} Delete an account API token for the authenticated user by ID

    Loading…

  • GET /organizations/{provider}/installation/{installationId} Get organization by provider installation id

    Loading…

  • GET /user Get the authenticated user

    Loading…

  • GET /user/emails List emails for the authenticated user

    Loading…

  • GET /user/emails/settings Retrieve email notification settings

    Loading…

  • GET /user/integrations List integrations for the authenticated user

    Loading…

  • GET /user/organizations List organizations for the authenticated user

    Loading…

  • GET /user/organizations/{provider} List organizations for the authenticated user

    Loading…

  • GET /user/organizations/{provider}/{remoteOrganizationName} Get organization for the authenticated user

    Loading…

  • GET /user/tokens List the account API tokens of the authenticated user

    Loading…

  • PATCH /user Update the authenticated user

    Loading…

  • PATCH /user/emails/settings Update email notification preferences

    Loading…

  • POST /user/emails/remove Remove an email from user account

    Loading…

  • POST /user/emails/set-default Set an email as default

    Loading…

  • POST /user/tokens Create a new account API token for the authenticated user

    Loading…

Coding Standards 17

  • DELETE /organizations/{provider}/{remoteOrganizationName}/coding-standards/{codingStandardId} Delete a coding standard

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/ai-risk-checklist Get AI Risk Checklist for an organization

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/coding-standards List the coding standards for an organization, including draft coding standards

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/coding-standards/{codingStandardId} Get a coding standard

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/coding-standards/{codingStandardId}/repositories List the repositories that are using a coding standard

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/coding-standards/{codingStandardId}/tools List tools in a coding standard

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/coding-standards/{codingStandardId}/tools/{toolUuid}/patterns List the code patterns configured for a tool in a coding standard

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/coding-standards/{codingStandardId}/tools/{toolUuid}/patterns/overview Get patterns overview for a coding standard tool

    Loading…

  • PATCH /organizations/{provider}/{remoteOrganizationName}/coding-standards/{codingStandardId}/repositories Apply a coding standard to a list of repositories

    Loading…

  • PATCH /organizations/{provider}/{remoteOrganizationName}/coding-standards/{codingStandardId}/tools/{toolUuid} Configure a tool in a draft coding standard

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/coding-standards Create a draft coding standard for an organization

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/coding-standards/{codingStandardId}/duplicate Duplicate a coding standard

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/coding-standards/{codingStandardId}/promote Promote a draft coding standard to an effective coding standard

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/coding-standards/{codingStandardId}/setDefault Set the default coding standard for an organization

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/coding-standards/{codingStandardId}/tools/{toolUuid}/patterns/update Bulk update the code patterns of a tool in a coding standard

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/compliance-standards Create a compliance standard for an organization

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/presets-standards Create a coding standard for an organization choosing from a series of presets.

    Loading…

Metrics 13

  • GET /enterprises/{provider}/{enterpriseName}/metrics/ready Retrieve metrics that are ready for each organization in an enterprise

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/metrics/ready Retrieve metrics that are ready for an organization

    Loading…

  • POST /enterprises/{provider}/{enterpriseName}/metrics/{metricName}/latest Retrieve latest metric values for all organizations in an enterprise

    Loading…

  • POST /enterprises/{provider}/{enterpriseName}/metrics/{metricName}/latest-grouped Retrieve latest metric values grouped by dimension for all organizations in an enterprise

    Loading…

  • POST /enterprises/{provider}/{enterpriseName}/metrics/{metricName}/period Retrieve metric values for a specific period for all organizations in an enterprise

    Loading…

  • POST /enterprises/{provider}/{enterpriseName}/metrics/{metricName}/period-grouped Retrieve metric values grouped by dimension for a specific period for all organizations in an enterprise

    Loading…

  • POST /enterprises/{provider}/{enterpriseName}/metrics/{metricName}/timerange Retrieve metric values for a time range for all organizations in an enterprise

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/metrics/start Start collecting metrics for an organization

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/metrics/{metricName}/latest Retrieve the latest value of a metric

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/metrics/{metricName}/latest-grouped Retrieve the latest metric values grouped by dimension

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/metrics/{metricName}/period Retrieve metric value for a specific period

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/metrics/{metricName}/period-grouped Retrieve metric values for a specific period grouped by dimension

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/metrics/{metricName}/timerange Retrieve metric values for a time range

    Loading…

Gate Policies 9

  • DELETE /organizations/{provider}/{remoteOrganizationName}/gate-policies/{gatePolicyId} Delete a gate policy

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/gate-policies List the gate policies for an organization

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/gate-policies/{gatePolicyId} Get a gate policy

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/gate-policies/{gatePolicyId}/repositories List all repositories following a gate policy

    Loading…

  • PATCH /organizations/{provider}/{remoteOrganizationName}/gate-policies/{gatePolicyId} Update a gate policy

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/gate-policies Create a gate policy

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/gate-policies/setCodacyDefault Set the built-in Codacy gate policy as the default for an organization

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/gate-policies/{gatePolicyId}/setDefault Set the gate policy as the default for an organization

    Loading…

  • PUT /organizations/{provider}/{remoteOrganizationName}/gate-policies/{gatePolicyId}/repositories Apply a gate policy to a list of repositories

    Loading…

Sbom 9

  • DELETE /organizations/{provider}/{remoteOrganizationName}/image-sboms/{imageName} Delete all SBOMs for a given image

    Loading…

  • DELETE /organizations/{provider}/{remoteOrganizationName}/image-sboms/{imageName}/tags/{tag} Delete SBOM for a given image/tag combination

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/images List Docker images for an organization

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/images/{imageName}/tags List Docker image tags for an organization

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/projects/{repositoryName}/sbom Get a presigned URL for the latest SBOM of the repository

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/image-sboms Upload an SBOM for a Docker image

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/sbom/dependencies/repositories/search Return a paginated list of repositories where a version of the specified SBOM dependency is used.

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/sbom/dependencies/search Return a list of SBOM dependencies, used across the organization.

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/sbom/repositories/search List repositories with SBOM dependency information

    Loading…

Admin 7

  • DELETE /admin/dormantAccounts (Codacy admins only) Delete Codacy users based on a CSV file exported by GitHub Enterprise

    Loading…

  • GET /admin (Codacy admins only) Search for an entity like Organization or Repository, supports ids and names

    Loading…

  • GET /admin/{adminEntityGroupSlug}/{adminEntityIdentifier} (Codacy admins only) Returns the requested admin entity

    Loading…

  • GET /admin/{adminEntityGroupSlug}/{adminEntityIdentifier}/{adminResourceSlug} (Codacy admins only) Returns the requested resources of a given admin entity

    Loading…

  • POST /admin/license (Codacy admins only) Generates a license for self-hosted instances of Codacy

    Loading…

  • POST /admin/security/penTest/reports Upload pen test reports for an organization (internal, Codacy admins only)

    Loading…

  • POST /admin/{adminEntityGroupSlug}/{adminEntityIdentifier}/actions/{adminActionSlug} (Codacy admins only) Executes an action on a given admin entity

    Loading…

Aiinventory 7

  • POST /organizations/{provider}/{remoteOrganizationName}/ai-inventory/categories/search List AI inventory categories grouped by category group

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/ai-inventory/locations/summaries/search List AI inventory location summaries for an organization

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/ai-inventory/markers/summaries/search List AI inventory marker summaries for an organization

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/ai-inventory/providers/summaries/search List AI inventory provider summaries for an organization

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/ai-inventory/providers/summary Get AI inventory summary for a specific provider

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/ai-inventory/repositories/search List repositories that have AI inventory items

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/ai-inventory/repositories/summaries/search List AI inventory repository summaries for an organization

    Loading…

Enterprise 7

  • DELETE /user/enterprise/integrations/{provider} Delete an Enterprise account token

    Loading…

  • GET /enterprises/{provider} List user enterprises

    Loading…

  • GET /enterprises/{provider}/{enterpriseName} Get an enterprise

    Loading…

  • GET /enterprises/{provider}/{enterpriseName}/organizations Get the organizations of an enterprise

    Loading…

  • GET /enterprises/{provider}/{enterpriseName}/seats Get enterprise seats

    Loading…

  • GET /user/enterprise/integrations List user configured enterprise provider account tokens on Codacy's platform

    Loading…

  • POST /user/enterprise/integrations Add an Enterprise account token

    Loading…

Jira 7

  • DELETE /organizations/{provider}/{remoteOrganizationName}/integrations/jira/tickets/{jiraTicketIdentifier} Unlink a Jira ticket from a repository

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/integrations/jira/projects Get available Jira projects for the organization

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/integrations/jira/projects/{jiraProjectId}/issueTypes Get available issue types for a Jira project

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/integrations/jira/projects/{jiraProjectId}/issueTypes/{jiraIssueTypeId}/fields Get available fields by issue type for a Jira project

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/integrations/jira/tickets Get Jira tickets for a Codacy element

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/integrations/jira/tickets Create a Jira ticket

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/integrations/jira/tickets Create a Jira ticket deprecated

    Loading…

People 6

  • GET /organizations/{provider}/{remoteOrganizationName}/people List people of an organization

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/people/suggestions List people suggestions for an organization

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/peopleCsv Generate a CSV file listing the people of an organization

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/people/suggestions List people suggestions for a repository

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/people Add people to organization

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/people/remove Remove people from an organization

    Loading…

Segments 6

  • GET /organizations/{provider}/{remoteOrganizationName}/segments/keys Get the segment keys for the organization

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/segments/keys/ids Get the segment keys with IDs for the organization

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/segments/sync Get the status of the segments synchronization

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/segments/values/{segmentKey} Get segment values for a segment key deprecated

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/segments/{segmentKey}/values Get the segment values for the organization by segment key

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/segments/sync Synchronize the segments of the organization with the Git provider

    Loading…

Tools 6

  • GET /duplicationTools Retrieve the list of duplication tools

    Loading…

  • GET /metricsTools Retrieve the list of metrics tools

    Loading…

  • GET /tools Retrieve the list of tools

    Loading…

  • GET /tools/{toolUuid}/patterns Retrieve the list of tool patterns

    Loading…

  • GET /tools/{toolUuid}/patterns/{patternId} Retrieve a tool pattern

    Loading…

  • POST /tools/{toolUuid}/patterns/{patternId}/organizations/{provider}/{remoteOrganizationName}/feedback Add feedback relating to the tool pattern

    Loading…

Coverage 5

  • GET /coverage/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/pull-requests/{pullRequestNumber} Get pull request coverage information from a repository

    Loading…

  • GET /coverage/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/pull-requests/{pullRequestNumber}/diff Get the human-readable Git diff of a pull request deprecated

    Loading…

  • GET /coverage/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/pull-requests/{pullRequestNumber}/files Get pull request files coverage information from a repository

    Loading…

  • GET /coverage/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/pull-requests/{pullRequestNumber}/reanalyze Triggers the reanalysis of the latest coverage report uploaded for the pull request

    Loading…

  • POST /coverage/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/commits/{commitUuid}/reanalyze Reanalyze the coverage for a commit

    Loading…

Dast 4

  • DELETE /organizations/{provider}/{remoteOrganizationName}/dast/targets/{dastTargetId} Delete a DAST target

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/dast/targets List configured DAST targets

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/dast/targets Create a DAST target

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/dast/targets/{dastTargetId}/analyze Enqueue a DAST analysis for the given target

    Loading…

Reports 4

  • GET /reports/enterprises/{provider}/{enterpriseName}/seats-csv Get enterprise seats as a CSV file

    Loading…

  • GET /reports/organizations/{provider}/{remoteOrganizationName}/security/items Generate a CSV file listing all security and risk management items for an organization.

    Loading…

  • POST /reports/organizations/{provider}/{remoteOrganizationName}/sbom/dependencies/search Search SBOM dependencies for the organization in CSV format

    Loading…

  • POST /reports/organizations/{provider}/{remoteOrganizationName}/security/items/search Generate a filtered CSV export of security and risk management items

    Loading…

File 3

  • GET /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/files/{filePath}/content Returns the content of the given file for a given commit reference.

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/file-extensions Get the list of supported file extensions associated with each language in a repository deprecated

    Loading…

  • PATCH /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/file-extensions Update the custom file extensions for a repository deprecated

    Loading…

Webhooks 3

  • DELETE /organizations/{provider}/{remoteOrganizationName}/integrations/webhooks/{webhookId} Delete a webhook endpoint of the organization

    Loading…

  • GET /organizations/{provider}/{remoteOrganizationName}/integrations/webhooks List webhook endpoints of the organization

    Loading…

  • POST /organizations/{provider}/{remoteOrganizationName}/integrations/webhooks Add a webhook endpoint to the organization

    Loading…

Billing 2

  • DELETE /billing/{provider}/{remoteOrganizationName}/subscription Delete billing subscription for organization

    Loading…

  • GET /plans List available plans in Codacy

    Loading…

Integrations 2

  • GET /login/integrations List configured login providers on Codacy's platform

    Loading…

  • GET /provider/integrations List provider integrations existing on Codacy's platform

    Loading…

Language Settings 2

  • GET /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/languages Get the list of all languages with their extensions and enabled status

    Loading…

  • PATCH /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/languages Configure language settings for this repo

    Loading…

App 1

  • GET /organizations/{provider}/{remoteOrganizationName}/gitProviderAppPermissions Get the status of Codacy Git provider app permissions for an organization

    Loading…

Configuration 1

  • GET /configuration/status Get configuration status

    Loading…

Health 1

  • GET /health Health check endpoint

    Loading…

Languages 1

  • GET /languages/tools Retrieve the list of languages supported by available tools

    Loading…

Session 1

  • POST /session/heartbeat Send a heartbeat to keep the session alive

    Loading…

Version 1

  • GET /version Return the version of the Codacy installation

    Loading…

Change log

    • +POST /organizations/{provider}/{remoteOrganizationName}/security/dashboard/remediation/history/search
    • +POST /organizations/{provider}/{remoteOrganizationName}/security/dashboard/remediation/search
    • ⚠POST /organizations/{provider}/{remoteOrganizationName}/billing/sync
    • +DELETE /organizations/{provider}/{remoteOrganizationName}/integrations/webhooks/{webhookId}
    • +GET /organizations/{provider}/{remoteOrganizationName}/integrations/webhooks
    • +POST /organizations/{provider}/{remoteOrganizationName}/integrations/webhooks
    • +POST /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/tokens/delete
browse all tools → score card for your toolchain →