Skip to content
Changelog

Report a bug

Codacy integration: operations for AI agents

Codacy connects to Type.com as an integration. This page lists the 283 operations documented for Claude and Codex in Type.com: 173 read, 78 write, 32 destructive.

About Codacy

Codacy is an automated code review tool that helps developers monitor code quality, track technical debt, and enforce coding standards across multiple programming languages.

Categories: Developer Tools & IT

How to connect Codacy to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

283 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

283 operations listed.

Version

  • Read

    Return the version of the Codacy installation

    GET /version

Analysis

  • Read

    List organization repositories with analysis information for the authenticated user

    For Bitbucket, you must URL encode the cursor before using it in subsequent API calls, as the pagination comes directly from the Git provider.

  • Read

    Search organization repositories with analysis information for the authenticated user

    For Bitbucket, you must URL encode the cursor before using it in subsequent API calls, as the pagination comes directly from the Git provider.

  • Read

    Get a repository with analysis information for the authenticated user

    GET /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}

  • Read

    Get analysis tools settings of a repository

    Note: When applied to public repositories, this operation does not require authentication.

  • Read

    Get tools with conflicts in a repository

    GET /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/tools/conflicts

  • Read

    Patterns configuration for (repository, tool). Uses standard if applied, repository settings otherwise.

    Patterns configuration for (repository, tool). Uses standard if applied, repository settings otherwise.

  • Read

    Patterns configuration for (repository, tool, pattern). Uses standard if applied, repository settings otherwise.

    Patterns configuration for (repository, tool, pattern). Uses standard if applied, repository settings otherwise.

  • Read

    Patterns overview for tool. Uses standard if applied, repository settings otherwise.

    Patterns overview for tool. Uses standard if applied, repository settings otherwise.

  • Read

    Patterns with Coding Standards conflicts for tool.

    Patterns with Coding Standards conflicts for tool.

  • Read

    Get the analysis progress of a repository

    Note: When applied to public repositories, this operation does not require authentication.

  • Read

    Get latest autoconfig run summary

    GET /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/autoconfig/runs

  • Read

    Get autoconfig run status

    [Experimental] Fetch latest autoconfig run state managed (can be Requested, Running, Done or Failed)

  • Read

    List pull requests from a repository that the user has access to

    You can search this endpoint for either last-updated (default), merged Note: When applied to public repositories, this operation does not require authentication.

  • Read

    Get pull request from a repository

    Note: When applied to public repositories, this operation does not require authentication.

  • Read

    Return analysis results for the commits in a pull request

    GET /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/pull-requests/{pullRequestNumber}/commits

  • Read

    List all coverage reports uploaded for the common ancestor commit and head commit of a pull request branch

    GET /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/pull-requests/{pullRequestNumber}/coverage/status

  • Read

    List issues found in a pull request

    Use the status parameter to filter by new or fixed issues

  • Read

    List duplicate code blocks found in a pull request

    Use the status parameter to filter by new or removed duplicates. The id of each duplicate code block is deprecated and will be removed, as it can change over time.

  • Read

    List duplicate code blocks found in a commit

    Use the status parameter to filter by new or removed duplicates. The id of each duplicate code block is deprecated and will be removed, as it can change over time.

  • Read

    Get analysis logs for a pull request

    GET /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/pull-requests/{pullRequestNumber}/logs

  • Read

    Get analysis logs for a commit

    GET /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/commits/{commitUuid}/logs

  • Read

    List files of a commit with analysis results

    GET /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/commits/{commitUuid}/files

  • Read

    List files of a pull request with analysis results

    GET /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/pull-requests/{pullRequestNumber}/files

  • Read

    List organization pull requests from repositories that the user has access to

    You can sort by last-updated (default), merged

  • Read

    List commit analysis statistics for the last n days that have analysis data

    Returns the last n days with available data. This means that the returned days may not match the last n calendar days. Note: When applied to public repositories, this operation does not require authentication.

  • Read

    List analysis category overviews for a repository that the user has access to

    Note: When applied to public repositories, this operation does not require authentication.

  • Read

    List issues in a repository

    Returns information about the issues that Codacy found in a repository as available on the Issues page. Use SearchRepositoryIssuesBody to filter the returned issues.

  • Read

    Get an overview of the issues in a repository

    Returns information about the number of issues that Codacy found in a repository as available on the Issues page. Use SearchRepositoryIssuesBody to filter the returned issues.

  • Read

    Get information about an open issue in a repository

    GET /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/issues/{issueId}

  • Read

    List ignored issues in a repository

    Ignored issues are issues that Codacy found but were marked as ignored on the Codacy UI. Use SearchRepositoryIssuesBody to filter results.

  • Read

    Return analysis results for the commits in a branch

    GET /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/commits

  • Read

    Get analysis results for a commit

    GET /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/commits/{commitUuid}

  • Read

    Get analysis statistics of a commit

    Returns the quality metric deltas introduced by a commit. The values of the metrics are 0 or null if Codacy didn't analyze the commit yet. To obtain the full analysis statistics for the repository use the endpoint getRepositoryWithAnalysis.

  • Read

    List the issues introduced or fixed by a commit

    Returns a list of issues introduced or fixed given a source commit SHA. By default, Codacy will calculate the issues by creating a delta between the source commit and its parent commit. As an alternative, you can also provide a destination commit to calculate the deltas.

  • Read

    Get information about a commit

    GET /commits/{commitId}

  • Read

    Check if the repository has quick fix suggestions for a branch

    If branch is not provided, the default branch is used.

  • Read

    Get quickfixes for issues in patch format

    If branch is not provided, the default branch is used.

  • Read

    Get quickfixes for pull request issues in patch format

    If branch is not provided, the default branch is used.

  • Write

    Configure an analysis tool by enabling and disabling its patterns for a repository.

    Configure an analysis tool by enabling and disabling its patterns for a repository. This endpoint will apply the changes without verifying if the repository belongs to a coding standard.

  • Write

    Bulk updates the code patterns of a tool in a repository. Use filters to specify the code patterns to update, or omit t…

    Bulk updates the code patterns of a tool in a repository. Use filters to specify the code patterns to update, or omit the filters to update all code patterns.

  • Write

    Recover a stuck repository

    Triggers a recovery action when the repository is stuck on its first analysis. The exact action taken depends on the stuck state. Returns 422 Unprocessable Entity when the repository is not stuck.

  • Write

    Add repository autoconfiguration run

    [Experimental] Autoconfig enqueuing endpoint

  • Write

    Bypass analysis status in a pull request

    POST /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/pull-requests/{pullRequestNumber}/bypass

  • Write

    Triggers an AI review for a pull request

    POST /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/pull-requests/{pullRequestNumber}/ai-reviewer/trigger

  • Write

    Bulk ignore issues in a repository

    Receives a list of issue ids and ignores them in the specified repository. Limited to 100 issues at once

  • Write

    Ignore or unignore an issue

    PATCH /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/issues/{issueId}

  • Write

    Ignore the false positive result in an issue

    PATCH /analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/issues/{issueId}/false-positive/ignore

Coverage

  • Read

    Get pull request coverage information from a repository

    Note: When applied to public repositories, this operation does not require authentication.

  • Read

    Get pull request files coverage information from a repository

    Note: When applied to public repositories, this operation does not require authentication.

  • Read

    Triggers the reanalysis of the latest coverage report uploaded for the pull request

    GET /coverage/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/pull-requests/{pullRequestNumber}/reanalyze

  • Write

    Reanalyze the coverage for a commit

    Triggers the reanalysis of the latest coverage report uploaded for the commit. Has no effect if the commit does not have any coverage report.

Repository

  • Read

    Get quality settings for the specific repository

    GET /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/quality/repository

  • Read

    Get the public SSH key for the repository

    The returned key is the most recently generated and can be either a user or repository SSH key.

  • Read

    Get the status of the repository setting Run analysis on your build server

    Get the status of the repository setting Run analysis on your build server

  • Read

    Get quality settings for the commits of a repository

    diffCoverageThreshold is never returned because this threshold isn't currently supported for commits.

  • Read

    Get quality settings for the pull requests of a repository

    GET /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/quality/pull-requests

  • Read

    Get Git provider integration settings for a repository

    GET /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/integrations/providerSettings

  • Read

    Fetch the specified repository

    Note: When applied to public repositories, this operation does not require authentication.

  • Read

    List repository branches

    Note: When applied to public repositories, this operation does not require authentication.

  • Read

    Get branch required status checks

    Get branch required status checks

  • Read

    List files in a repository

    Returns the most recent analysis information for the files in a repository as available on the Files page. Files that are ignored on Codacy aren't returned. Note: When applied to public repositories, this operation does not require authentication.

  • Read

    List folders in a repository

    Returns the most recent analysis information for the folders directly inside a path of a repository, with metrics aggregated over every file in each folder's subtree.

  • Read

    List ignored files in a repository

    Returns the most recent ignored files information. Note: When the repository has a Codacy configuration file 'hasCodacyConfigurationFile', this list of files are read-only, as they were ignored during the most recent analysis based on the configuration file

  • Read

    Get analysis information and coverage metrics for a file in a repository

    GET /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/files/{fileId}

  • Read

    Get the list of duplicated code blocks for a file in a repository

    The id of each duplicate code block is deprecated and will be removed, as it can change over time.

  • Read

    Get the issue list for a file in a repository

    GET /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/files/{fileId}/issues

  • Read

    List the repository API tokens

    Each token reports its name, expiration and creation date. Tokens created before creation dates were recorded have no createdAt

  • Read

    List the most recent coverage reports and their status

    GET /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/coverage/status

  • Read

    List coverage reports for a commit

    GET /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/commits/{commitUuid}/coverage/reports

  • Read

    Get a coverage report with its contents

    GET /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/commits/{commitUuid}/coverage/reports/{reportUuid}

  • Read

    Get coverage information for a file in the head commit of a repository branch.

    GET /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/files/{fileId}/coverage

  • Read

    Get the human-readable Git diff of a pull request

    GET /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/pull-requests/{pullRequestNumber}/diff

  • Read

    Get the human-readable Git diff of a commit

    GET /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/commits/{commitUuid}/diff

  • Read

    Get the human-readable Git diff between a head commit and a base commit

    GET /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/base/{baseCommitUuid}/head/{headCommitUuid}/diff

  • Write

    Follow a repository that was already added to Codacy

    POST /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/follow

  • Write

    Regenerate the user SSH key that Codacy uses to clone the repository

    Codacy automatically adds the new public user SSH key to the user account on the Git provider. Using a user SSH key is recommended if your repository includes submodules.

  • Write

    Regenerate the SSH key that Codacy uses to clone the repository

    Codacy automatically adds the new public SSH key to the repository on the Git provider.

  • Write

    Synchronize repository name and visibility with Git provider

    POST /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/sync

  • Write

    Update the status of the repository setting Run analysis on your build server

    Update the status of the repository setting Run analysis on your build server

  • Write

    Reset quality settings for the commits of a repository to Codacy’s default values

    POST /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/quality/commits/reset

  • Write

    Reset quality settings for the pull requests of a repository to Codacy’s default values

    POST /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/quality/pull-requests/reset

  • Write

    Reset quality settings for the repository to Codacy’s default values

    POST /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/quality/repository/reset

  • Write

    Update Git provider integration settings for a repository

    PATCH /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/integrations/providerSettings

  • Write

    Create a post-commit hook for a repository

    Create a post-commit hook for a repository

    GET /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/integrations/postCommitHook

  • Write

    Refresh the Git provider integration for a repository (GitLab and Bitbucket only)

    Codacy will use the authenticated user to create comments on new pull requests

  • Write

    Reanalyze a specific commit in a repository

    POST /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/reanalyzeCommit

  • Write

    Update the settings for a repository branch

    Toggle analysis for a branch.

  • Write

    Set branch as default

    Sets the default branch for a repository. The new default branch must already be enabled on Codacy.

  • Write

    Create a pull request adding the Codacy analysis badge to the repository

    Creates a pull request adding the Codacy static code analysis badge to the README of the GitHub repository if the repository is public and doesn't already have a badge. Note: The pull request is created asynchronously and may fail even if this endpoint responds successfully.

  • Write

    Add a repository to Codacy

    Add a new repository to an existing organization on Codacy

  • Write

    Create a new repository API token

    Create a new repository API token

  • Write

    Ignore or unignore a file

    PATCH /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/file

  • Destructive

    Unfollow a repository

    DELETE /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/follow

  • Destructive

    Update quality goals settings for the specific repository

    PUT /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/quality/repository

  • Destructive

    Update quality settings for the commits of a repository

    PUT /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/quality/commits

  • Destructive

    Update quality settings for the pull requests of a repository

    PUT /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/quality/pull-requests

  • Destructive

    Delete the specified repository

    DELETE /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}

  • Destructive

    Delete multiple repository API tokens by id

    Deletes the repository API tokens with the given ids

  • Destructive

    Delete a repository API token by ID

    Delete a repository API token by ID

Language settings

  • Read

    Get the list of all languages with their extensions and enabled status

    GET /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/languages

  • Write

    Configure language settings for this repo

    PATCH /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/languages

Account

  • Read

    Get the authenticated user

    GET /user

  • Read

    List organizations for the authenticated user

    List organizations for the authenticated user

  • Read

    List organizations for the authenticated user

    List organizations for the authenticated user

  • Read

    Get organization for the authenticated user

    Get organization for the authenticated user

  • Read

    List emails for the authenticated user

    GET /user/emails

  • Read

    Retrieve email notification settings

    Returns the current email notification preferences, including per-commit notifications, pull request notifications, and activity.

  • Read

    List integrations for the authenticated user

    List integrations for the authenticated user

  • Read

    Get organization by provider installation id

    Note Currently supports only gh as the provider parameter.

  • Read

    List the account API tokens of the authenticated user

    List the account API tokens of the authenticated user

  • Write

    Update the authenticated user

    PATCH /user

  • Write

    Update email notification preferences

    Modifies the user's email notification settings. Settings can be updated individually without affecting other settings. This endpoint allows users to control which events trigger email notifications.

  • Write

    Set an email as default

    Designates the specified email as the default email for the authenticated user. This operation will automatically remove the default status from any previously default email. Only one email can be default at any time.

  • Write

    Create a new account API token for the authenticated user

    Create a new account API token for the authenticated user

  • Destructive

    Delete the authenticated user

    DELETE /user

  • Destructive

    Remove an email from user account

    Removes the specified email address from the authenticated user's account. The primary/default email cannot be removed. A user must always have at least one email address associated with their account.

  • Destructive

    Delete an integration for the authenticated user

    DELETE /user/integrations/{provider}

  • Destructive

    Delete an account API token for the authenticated user by ID

    Delete an account API token for the authenticated user by ID

Organization

  • Read

    Get organization

    GET /organizations/{provider}/{remoteOrganizationName}

  • Read

    Get detailed information about organization billing

    Get detailed information about organization billing

  • Read

    Get card information about organization billing

    Get card information about organization billing

  • Read

    Get a billing estimation

    GET /organizations/{provider}/{remoteOrganizationName}/billing/estimation

  • Read

    Get Git provider settings

    GET /organizations/{provider}/{remoteOrganizationName}/integrations/providerSettings

  • Read

    List organization repositories for the authenticated user

    For Bitbucket you must URL encode the cursor before using it in subsequent API calls, as the pagination comes directly from the Git provider. This endpoint may return more results than those specified in the limit parameter.

  • Read

    Retrieve the onboarding progress of an organization

    GET /onboarding/organizations/{provider}/{remoteOrganizationName}/progress

  • Read

    Check if the user can leave the organization

    Check if the user can leave the organization or returns the reasons why they can not.

  • Read

    List requests to join an organization

    Endpoint to list requests to join an organization by provider and organization name

  • Read

    Check if the submodules option is enabled for the organization

    GET /organizations/{provider}/{remoteOrganizationName}/settings/submodules/check

  • Read

    Get the Jira integration of the organization

    GET /organizations/{provider}/{remoteOrganizationName}/integrations/jira

  • Read

    Get the Slack integration of the organization

    GET /organizations/{provider}/{remoteOrganizationName}/integrations/slack

  • Read

    Retrieve the audit logs for the organization

    Only available on Business plan. Requires organization admin or organization manager role.

  • Write

    Update the information about organization billing

    Update the information about organization billing

  • Write

    Add a card to the organization

    Add a card to the organization relying on the token provided by Stripe /v1/tokens

  • Write

    Change the plan of an organization

    Available plan codes can be retrieved using listPaymentPlans

  • Write

    Apply default settings to all repositories

    POST /organizations/{provider}/{remoteOrganizationName}/integrations/providerSettings/apply

  • Write

    Create or update Git provider settings

    PATCH /organizations/{provider}/{remoteOrganizationName}/integrations/providerSettings

  • Write

    Configure what your organization members can do across the Codacy platform

    Define the lowest permission level that can configure patterns, configure which file extensions and branches are analyzed, and ignore issues and files

  • Write

    Update the join mode of an organization

    POST /organizations/{provider}/{remoteOrganizationName}/joinMode

  • Write

    Join an organization

    Endpoint to join an organization by provider and name

  • Write

    Add an organization to Codacy

    Add an organization from a Git provider to Codacy

  • Write

    Sync the information about user's organization billing

    POST /user/billing/sync

  • Write

    Synchronize Codacy organization name with the Git provider

    POST /organizations/{provider}/{remoteOrganizationName}/settings/sync

  • Destructive

    Delete organization

    Delete organization

  • Destructive

    Decline requests to join an organization

    Decline requests to join an organization by specifying the provider, organization name, and the user emails to be rejected.

  • Destructive

    Delete a request to join an organization

    Delete a request to join an organization by provider, name, and user ID

  • Destructive

    Create or update the Jira integration of the organization

    PUT /organizations/{provider}/{remoteOrganizationName}/integrations/jira

  • Destructive

    Delete the Jira integration of the organization and associated resources

    DELETE /organizations/{provider}/{remoteOrganizationName}/integrations/jira

  • Destructive

    Create or update the Slack integration of the organization

    PUT /organizations/{provider}/{remoteOrganizationName}/integrations/slack

  • Destructive

    Delete the Slack integration of the organization and associated resources

    DELETE /organizations/{provider}/{remoteOrganizationName}/integrations/slack

People

  • Read

    List people of an organization

    List people of an organization

  • Read

    Generate a CSV file listing the people of an organization

    Generate a CSV file containing the name, email, lastLogin, and lastAnalysis of each person of the organization

  • Read

    List people suggestions for an organization

    List people suggestions for an organization

  • Read

    List people suggestions for a repository

    List people suggestions for a repository

  • Write

    Add people to organization

    Add people to organization as members or committers (depending if they have a pending request already)

  • Destructive

    Remove people from an organization

    Remove people from an organization

App

  • Read

    Get the status of Codacy Git provider app permissions for an organization

    GET /organizations/{provider}/{remoteOrganizationName}/gitProviderAppPermissions

Enterprise

  • Read

    List user configured enterprise provider account tokens on Codacy's platform

    GET /user/enterprise/integrations

  • Read

    Get the organizations of an enterprise

    GET /enterprises/{provider}/{enterpriseName}/organizations

  • Read

    List user enterprises

    GET /enterprises/{provider}

  • Read

    Get an enterprise

    GET /enterprises/{provider}/{enterpriseName}

  • Read

    Get enterprise seats

    GET /enterprises/{provider}/{enterpriseName}/seats

  • Write

    Add an Enterprise account token

    This endpoint allows the authenticated user to add a GitHub Enterprise account token with read permissions. The token will be used to access enterprise-level resources on GitHub.

  • Destructive

    Delete an Enterprise account token

    This endpoint allows the authenticated user to delete a GitHub Enterprise account token. The token will no longer be used to access enterprise-level resources on GitHub.

Billing

  • Read

    List available plans in Codacy

    GET /plans

  • Destructive

    Delete billing subscription for organization

    Delete billing subscription for organization

Integrations

  • Read

    List configured login providers on Codacy's platform

    List configured login providers on Codacy's platform

  • Read

    List provider integrations existing on Codacy's platform

    List provider integrations existing on Codacy's platform

Configuration

  • Read

    Get configuration status

    Get configuration status

Health

  • Read

    Health check endpoint

    Health check endpoint

Admin

  • Read

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

    GET /admin

  • Read

    (Codacy admins only) Returns the requested admin entity

    GET /admin/{adminEntityGroupSlug}/{adminEntityIdentifier}

  • Read

    (Codacy admins only) Returns the requested resources of a given admin entity

    GET /admin/{adminEntityGroupSlug}/{adminEntityIdentifier}/{adminResourceSlug}

  • Write

    (Codacy admins only) Executes an action on a given admin entity

    POST /admin/{adminEntityGroupSlug}/{adminEntityIdentifier}/actions/{adminActionSlug}

  • Write

    (Codacy admins only) Generates a license for self-hosted instances of Codacy

    POST /admin/license

  • Write

    Upload pen test reports for an organization (internal, Codacy admins only)

    POST /admin/security/penTest/reports

  • Destructive

    (Codacy admins only) Delete Codacy users based on a CSV file exported by GitHub Enterprise

    DELETE /admin/dormantAccounts

Languages

  • Read

    Retrieve the list of languages supported by available tools

    GET /languages/tools

Tools

  • Read

    Retrieve the list of tools

    GET /tools

  • Read

    Retrieve the list of tool patterns

    GET /tools/{toolUuid}/patterns

  • Read

    Retrieve a tool pattern

    Get the definition of a specific pattern

  • Read

    Retrieve the list of duplication tools

    GET /duplicationTools

  • Read

    Retrieve the list of metrics tools

    GET /metricsTools

  • Write

    Add feedback relating to the tool pattern

    Add feedback relating to the tool pattern.

Metrics

  • Read

    Retrieve metrics that are ready for an organization

    Retrieve the list of metrics that have completed data collection for an organization.

  • Read

    Retrieve the latest value of a metric

    Retrieve the latest value for an aggregating metric (e.g., open issues). Note: It does not work for accumulating metrics, such as fixed issues

  • Read

    Retrieve the latest metric values grouped by dimension

    Retrieve an array of the latest values for an aggregating metric, based on the groupBy options. The groupBy can be organization, repository, or a valid dimension for the requested metric. Note: - It does not work for accumulating metrics, such as fixed issues

  • Read

    Retrieve metric value for a specific period

    Retrieve the value for a metric for a specific period, identified by its start date. Notes: - Aggregating metrics provide the average value. - Accumulating metrics provide the sum, representing the total historical change.

  • Read

    Retrieve metric values for a specific period grouped by dimension

    Retrieve an array of values for a metric for a specific period, identified by its start date, grouped according to the groupBy field. The groupBy can be organization, repository, or a valid dimension for the requested metric.

  • Read

    Retrieve metric values for a time range

    Retrieve a specific metric's values for a given time range. The response includes values grouped by period date and optionally by an additional groupBy parameter. The groupBy can be organization, repository, or a valid dimension for the requested metric.

  • Read

    Retrieve metrics that are ready for each organization in an enterprise

    Retrieve the list of metrics that have completed data collection for each organization in the enterprise.

  • Read

    Retrieve latest metric values for all organizations in an enterprise

    Retrieve the latest value for each organization in an enterprise for an aggregating metric (e.g., open issues). Note: It does not work for accumulating metrics, such as fixed issues

  • Read

    Retrieve latest metric values grouped by dimension for all organizations in an enterprise

    Retrieve an array of the latest values for an aggregating metric for each organization in an enterprise, based on the groupBy options. The groupBy can be organization or a valid dimension for the requested metric.

  • Read

    Retrieve metric values for a specific period for all organizations in an enterprise

    Retrieve the value for a metric for each organization in an enterprise, for a specific period, identified by its start date. Notes: - Aggregating metrics provide the average value. - Accumulating metrics provide the sum, representing the total historical change.

  • Read

    Retrieve metric values grouped by dimension for a specific period for all organizations in an enterprise

    Retrieve an array of values for a metric for each organization in an enterprise, for a specific period, identified by its start date, grouped according to the groupBy field. The groupBy can be organization or a valid dimension for the requested metric.

  • Read

    Retrieve metric values for a time range for all organizations in an enterprise

    Retrieve a specific metric's values for each organization in an enterprise, for a given time range. The response includes values grouped by period date and optionally by an additional groupBy parameter.

  • Write

    Start collecting metrics for an organization

    Start data collection for missing metrics. The organization must have metrics support enabled.

Coding standards

  • Read

    Get AI Risk Checklist for an organization

    GET /organizations/{provider}/{remoteOrganizationName}/ai-risk-checklist

  • Read

    List the coding standards for an organization, including draft coding standards

    GET /organizations/{provider}/{remoteOrganizationName}/coding-standards

  • Read

    Get a coding standard

    GET /organizations/{provider}/{remoteOrganizationName}/coding-standards/{codingStandardId}

  • Read

    List tools in a coding standard

    GET /organizations/{provider}/{remoteOrganizationName}/coding-standards/{codingStandardId}/tools

  • Read

    List the code patterns configured for a tool in a coding standard

    GET /organizations/{provider}/{remoteOrganizationName}/coding-standards/{codingStandardId}/tools/{toolUuid}/patterns

  • Read

    Get patterns overview for a coding standard tool

    GET /organizations/{provider}/{remoteOrganizationName}/coding-standards/{codingStandardId}/tools/{toolUuid}/patterns/overview

  • Read

    List the repositories that are using a coding standard

    GET /organizations/{provider}/{remoteOrganizationName}/coding-standards/{codingStandardId}/repositories

  • Write

    Create a draft coding standard for an organization

    To promote the draft coding standard to an effective coding standard, see promoteDraftCodingStandard.

  • Write

    Create a compliance standard for an organization

    POST /organizations/{provider}/{remoteOrganizationName}/compliance-standards

  • Write

    Create a coding standard for an organization choosing from a series of presets.

    POST /organizations/{provider}/{remoteOrganizationName}/presets-standards

  • Write

    Duplicate a coding standard

    POST /organizations/{provider}/{remoteOrganizationName}/coding-standards/{codingStandardId}/duplicate

  • Write

    Set the default coding standard for an organization

    POST /organizations/{provider}/{remoteOrganizationName}/coding-standards/{codingStandardId}/setDefault

  • Write

    Bulk update the code patterns of a tool in a coding standard

    Use filters to specify the code patterns to update, or omit the filters to update all code patterns.

  • Write

    Configure a tool in a draft coding standard

    Toggle a tool and configure its code patterns in a draft coding standard. Only the code patterns included in the body are updated, and if there are none only the enabled status of the tool is set.

  • Write

    Apply a coding standard to a list of repositories

    Link or unlink a coding standard to a list of repositories. If the coding standard is a draft, the changes will only be effective when promoting the draft coding standard.

  • Write

    Promote a draft coding standard to an effective coding standard

    If the draft coding standard is marked as default, it becomes the new default coding standard. The response includes the result of applying the coding standard to the repositories.

  • Destructive

    Delete a coding standard

    DELETE /organizations/{provider}/{remoteOrganizationName}/coding-standards/{codingStandardId}

Gate policies

  • Read

    Get a gate policy

    GET /organizations/{provider}/{remoteOrganizationName}/gate-policies/{gatePolicyId}

  • Read

    List the gate policies for an organization

    GET /organizations/{provider}/{remoteOrganizationName}/gate-policies

  • Read

    List all repositories following a gate policy

    GET /organizations/{provider}/{remoteOrganizationName}/gate-policies/{gatePolicyId}/repositories

  • Write

    Set the gate policy as the default for an organization

    POST /organizations/{provider}/{remoteOrganizationName}/gate-policies/{gatePolicyId}/setDefault

  • Write

    Set the built-in Codacy gate policy as the default for an organization

    POST /organizations/{provider}/{remoteOrganizationName}/gate-policies/setCodacyDefault

  • Write

    Update a gate policy

    PATCH /organizations/{provider}/{remoteOrganizationName}/gate-policies/{gatePolicyId}

  • Write

    Create a gate policy

    POST /organizations/{provider}/{remoteOrganizationName}/gate-policies

  • Destructive

    Delete a gate policy

    DELETE /organizations/{provider}/{remoteOrganizationName}/gate-policies/{gatePolicyId}

  • Destructive

    Apply a gate policy to a list of repositories

    Link or unlink a gate policy to a list of repositories.

File

  • Read

    Returns the content of the given file for a given commit reference.

    Returns the content of the given file for a given commit reference. If the requested file is over 1MB, a 'PayloadTooLarge' error is returned.

Security

  • Read

    Get a single security and risk management finding

    GET /organizations/{provider}/{remoteOrganizationName}/security/items/{srmItemId}

  • Read

    List security and risk management items for an organization

    POST /organizations/{provider}/{remoteOrganizationName}/security/items/search

  • Read

    Get metrics for the security and risk management dashboard

    POST /organizations/{provider}/{remoteOrganizationName}/security/dashboard

  • Read

    List repositories with security findings

    If no filter is specified, only the 10 repositories with the most findings are returned.

  • Read

    Get the evolution of security findings over time

    POST /organizations/{provider}/{remoteOrganizationName}/security/dashboard/history/search

  • Read

    Get the remediation of security findings per severity

    Returns, per severity, the security findings closed in the last 90 days and the security findings open now, both not ignored, judged against the organization's current SLAs.

  • Read

    Get the weekly remediation of security findings over the last 90 days

    Returns, per week and severity, the security findings closed in the last 90 days that are not ignored, judged against the organization's current SLAs.

  • Read

    List security categories with findings

    If no filter is specified, only the 10 categories with the most findings are returned.

  • Read

    List uploaded DAST scan reports and their state

    Results are sorted by submission date, from latest to earliest.

  • Read

    List organization admins and security managers

    GET /organizations/{provider}/{remoteOrganizationName}/security/managers

  • Read

    List organization repositories that have security issues

    GET /organizations/{provider}/{remoteOrganizationName}/security/repositories

  • Read

    List security subcategories that have security issues

    GET /organizations/{provider}/{remoteOrganizationName}/security/categories

  • Read

    Get the SLA configuration for an organization

    GET /organizations/{provider}/{remoteOrganizationName}/security/sla

  • Read

    Get the OSSF Scorecard for a repository

    POST /security/dependencies/ossf/scorecard

  • Write

    Ignore a single item with an optional comment

    Closed items and Jira items cannot be ignored

  • Write

    Unignore a single item (only previously ignored items can be unignored)

    POST /organizations/{provider}/{remoteOrganizationName}/security/items/{srmItemId}/unignore

  • Write

    Upload dynamic application security testing (DAST) scan report generated by the specified tool in the specified format.

    Upload dynamic application security testing (DAST) scan report generated by the specified tool in the specified format.

  • Write

    Assign the Security Manager role to an organization member

    POST /organizations/{provider}/{remoteOrganizationName}/security/managers

  • Destructive

    Revoke the Security Manager role from an organization member

    DELETE /organizations/{provider}/{remoteOrganizationName}/security/managers/{userId}

  • Destructive

    Update the SLA configuration for an organization

    PUT /organizations/{provider}/{remoteOrganizationName}/security/sla

Sbom

  • Read

    List repositories with SBOM dependency information

    POST /organizations/{provider}/{remoteOrganizationName}/sbom/repositories/search

  • Read

    Get a presigned URL for the latest SBOM of the repository

    GET /organizations/{provider}/{remoteOrganizationName}/projects/{repositoryName}/sbom

  • Read

    List Docker images for an organization

    GET /organizations/{provider}/{remoteOrganizationName}/images

  • Read

    List Docker image tags for an organization

    GET /organizations/{provider}/{remoteOrganizationName}/images/{imageName}/tags

  • Write

    Return a list of SBOM dependencies, used across the organization.

    POST /organizations/{provider}/{remoteOrganizationName}/sbom/dependencies/search

  • Write

    Return a paginated list of repositories where a version of the specified SBOM dependency is used.

    POST /organizations/{provider}/{remoteOrganizationName}/sbom/dependencies/repositories/search

  • Write

    Upload an SBOM for a Docker image

    POST /organizations/{provider}/{remoteOrganizationName}/image-sboms

  • Destructive

    Delete all SBOMs for a given image

    DELETE /organizations/{provider}/{remoteOrganizationName}/image-sboms/{imageName}

  • Destructive

    Delete SBOM for a given image/tag combination

    DELETE /organizations/{provider}/{remoteOrganizationName}/image-sboms/{imageName}/tags/{tag}

Jira

  • Read

    Get Jira tickets for a Codacy element

    GET /organizations/{provider}/{remoteOrganizationName}/integrations/jira/tickets

  • Read

    Get available Jira projects for the organization

    GET /organizations/{provider}/{remoteOrganizationName}/integrations/jira/projects

  • Read

    Get available issue types for a Jira project

    GET /organizations/{provider}/{remoteOrganizationName}/integrations/jira/projects/{jiraProjectId}/issueTypes

  • Read

    Get available fields by issue type for a Jira project

    GET /organizations/{provider}/{remoteOrganizationName}/integrations/jira/projects/{jiraProjectId}/issueTypes/{jiraIssueTypeId}/fields

  • Write

    Create a Jira ticket

    POST /organizations/{provider}/{remoteOrganizationName}/integrations/jira/tickets

  • Destructive

    Unlink a Jira ticket from a repository

    DELETE /organizations/{provider}/{remoteOrganizationName}/integrations/jira/tickets/{jiraTicketIdentifier}

Webhooks

  • Read

    List webhook endpoints of the organization

    GET /organizations/{provider}/{remoteOrganizationName}/integrations/webhooks

  • Write

    Add a webhook endpoint to the organization

    POST /organizations/{provider}/{remoteOrganizationName}/integrations/webhooks

  • Destructive

    Delete a webhook endpoint of the organization

    DELETE /organizations/{provider}/{remoteOrganizationName}/integrations/webhooks/{webhookId}

Reports

  • Read

    Generate a CSV file listing all security and risk management items for an organization.

    GET /reports/organizations/{provider}/{remoteOrganizationName}/security/items

  • Read

    Search SBOM dependencies for the organization in CSV format

    POST /reports/organizations/{provider}/{remoteOrganizationName}/sbom/dependencies/search

  • Read

    Get enterprise seats as a CSV file

    GET /reports/enterprises/{provider}/{enterpriseName}/seats-csv

  • Write

    Generate a filtered CSV export of security and risk management items

    POST /reports/organizations/{provider}/{remoteOrganizationName}/security/items/search

Session

  • Write

    Send a heartbeat to keep the session alive

    POST /session/heartbeat

Segments

  • Read

    Get the status of the segments synchronization

    GET /organizations/{provider}/{remoteOrganizationName}/segments/sync

  • Read

    Get the segment keys for the organization

    GET /organizations/{provider}/{remoteOrganizationName}/segments/keys

  • Read

    Get the segment keys with IDs for the organization

    GET /organizations/{provider}/{remoteOrganizationName}/segments/keys/ids

  • Read

    Get the segment values for the organization by segment key

    GET /organizations/{provider}/{remoteOrganizationName}/segments/{segmentKey}/values

  • Write

    Synchronize the segments of the organization with the Git provider

    For GitHub, segments are the repository custom properties

Dast

  • Read

    List configured DAST targets

    GET /organizations/{provider}/{remoteOrganizationName}/dast/targets

  • Write

    Create a DAST target

    POST /organizations/{provider}/{remoteOrganizationName}/dast/targets

  • Write

    Enqueue a DAST analysis for the given target

    POST /organizations/{provider}/{remoteOrganizationName}/dast/targets/{dastTargetId}/analyze

  • Destructive

    Delete a DAST target

    DELETE /organizations/{provider}/{remoteOrganizationName}/dast/targets/{dastTargetId}

Aiinventory

  • Read

    List AI inventory provider summaries for an organization

    Returns a paginated list of provider summaries for an organization. Each summary aggregates resources, references, and repositories for one AI provider, with a per-category-group repository breakdown

  • Read

    Get AI inventory summary for a specific provider

    Returns the summary for a specific AI provider (resource, reference, and repository counts plus a per-category-group repository breakdown). The provider name is given in the request body since it may contain spaces or special characters (e.g. GPT Engineer)

  • Read

    List AI inventory marker summaries for an organization

    Returns a paginated list of marker summaries for an organization. Each summary represents a distinct inventory resource — a (categoryGroup, category, marker) grouping — with reference and repository counts.

  • Read

    List repositories that have AI inventory items

    Returns a paginated list of repositories that have AI inventory items for an organization. Used to populate the Repositories filter dropdown

  • Read

    List AI inventory repository summaries for an organization

    Returns a paginated list of repository summaries for an organization. Each summary aggregates resources, references, and AI provider counts for one repository, with a per-category-group reference breakdown

  • Read

    List AI inventory location summaries for an organization

    Returns a paginated list of location summaries for an organization. Each summary represents a distinct location with an array of regions. Location is a URI with a couple custom protocols like repo-file and repo-sha.

  • Read

    List AI inventory categories grouped by category group

    Returns the available inventory categories grouped by their category group. Used to populate the Categories filter drawer

See How connections work for access and permissions, or browse all integrations.