The Codacy connector lets your AI agent act in each user's Codacy account. Each user connects their own Codacy API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 60 tools.
- Tools
- 60
- What they doRead · write · destructive
- 47 · 12 · 147 read12 write1 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Codacy connection
In AgentKit > Connections, create a Codacy connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'codacy'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Codacy:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'codacy_tools_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "codacy"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Codacy:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="codacy_tools_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Codacy credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolcodacy_category_overviews_listGet the number of Codacy issues per category, such as Security or Code Style, for a branch.Read-onlyList Category Overviews
Get the number of Codacy issues per category, such as Security or Code Style, for a branch. Returns each category with its issue count and share. Use Search Issues to list the issues.
Inputs
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
repository_namestringrequired- Repository name inside the organization, e.g. awesome-repo. Example: awesome-repo.
branchstring- Branch name; defaults to the repository's main branch. Example: main.
codacy_coding_standard_getGet one Codacy coding standard.Read-onlyGet Coding Standard
Get one Codacy coding standard. Returns its name, languages, enabled tools and linked repository count. Use List Coding Standards to find the ID.
Inputs
coding_standard_idintegerrequired- Coding standard ID, from List Coding Standards. Example: 12.
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
codacy_coding_standards_listList the coding standards (shared tool and pattern configurations) of a Codacy organization.Read-onlyList Coding Standards
List the coding standards (shared tool and pattern configurations) of a Codacy organization. Returns each standard's id, name, default flag and languages. Use Apply Coding Standard to link repositories.
Inputs
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
codacy_commit_delta_issues_listList the issues a commit added or fixed compared with its parent or another commit.Read-onlyList Commit Delta Issues
List the issues a commit added or fixed compared with its parent or another commit. Returns each issue's status (new or fixed), pattern, severity, file and line. Set targetCommitUuid to compare two commits.
Inputs
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
repository_namestringrequired- Repository name inside the organization, e.g. awesome-repo. Example: awesome-repo.
src_commit_uuidstringrequired- Commit SHA to inspect. Example: 2957025d42e8daadf937d4044516f991d21deea4.
cursorstring- Cursor for the next page, from the previous response's pagination.cursor. Omit for the first page. Example: Yms345gh==.
limitinteger- Maximum number of items to return, 1 to 100. Example: 20.
only_potentialboolean- Set to `true` to return only potential issues. Example: false.
statusstring- Filter issues by status. Valid values are `all`, `new`, or `fixed`. Example: new.one of
allnewfixed target_commit_uuidstring- Commit SHA to compare with; defaults to the parent commit. Example: 1a2b3c4d5e6f708192a3b4c5d6e7f8091a2b3c4d.
codacy_commit_delta_statistics_getGet the quality changes a commit introduced in Codacy.Read-onlyGet Commit Delta Statistics
Get the quality changes a commit introduced in Codacy. Returns new and fixed issue counts and complexity, duplication and coverage variation. Use Get Commit Analysis for the full commit view.
Inputs
commit_uuidstringrequired- Commit SHA, from List Repository Commits. Example: 2957025d42e8daadf937d4044516f991d21deea4.
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
repository_namestringrequired- Repository name inside the organization, e.g. awesome-repo. Example: awesome-repo.
codacy_commit_getGet the Codacy analysis of one commit.Read-onlyGet Commit Analysis
Get the Codacy analysis of one commit. Returns new and fixed issues, complexity, duplication and coverage deltas. Use List Commit Delta Issues for the issues.
Inputs
commit_uuidstringrequired- Commit SHA, from List Repository Commits. Example: 2957025d42e8daadf937d4044516f991d21deea4.
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
repository_namestringrequired- Repository name inside the organization, e.g. awesome-repo. Example: awesome-repo.
codacy_commit_statistics_listGet daily Codacy analysis statistics of a repository branch for recent days.Read-onlyList Commit Statistics
Get daily Codacy analysis statistics of a repository branch for recent days. Returns per-day issues, complexity, duplication and coverage numbers. Use it to chart quality over time.
Inputs
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
repository_namestringrequired- Repository name inside the organization, e.g. awesome-repo. Example: awesome-repo.
branchstring- Branch name; defaults to the repository's main branch. Example: main.
daysinteger- Number of days of data to return (1-365, defaults to 31). Example: 30.
codacy_commits_listList the analyzed commits of a Codacy repository branch.Read-onlyList Repository Commits
List the analyzed commits of a Codacy repository branch. Returns each commit's SHA, author, message, date and quality deltas. Use Get Commit Analysis for one commit.
Inputs
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
repository_namestringrequired- Repository name inside the organization, e.g. awesome-repo. Example: awesome-repo.
branchstring- Branch name; defaults to the repository's main branch. Example: main.
cursorstring- Cursor for the next page, from the previous response's pagination.cursor. Omit for the first page. Example: Yms345gh==.
limitinteger- Maximum number of items to return, 1 to 100. Example: 20.
codacy_coverage_reports_listList the latest coverage reports uploaded to a Codacy repository.Read-onlyList Coverage Reports
List the latest coverage reports uploaded to a Codacy repository. Returns each report's commit, language, status and upload time. Use it to check coverage uploads are working.
Inputs
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
repository_namestringrequired- Repository name inside the organization, e.g. awesome-repo. Example: awesome-repo.
limitinteger- Maximum number of items to return, 1 to 100. Example: 20.
codacy_file_coverage_getGet the line coverage of one file in Codacy.Read-onlyGet File Coverage
Get the line coverage of one file in Codacy. Returns covered and uncovered lines and the coverage percentage. Use List Files to find the file ID.
Inputs
file_idintegerrequired- Codacy file ID, from List Files. Example: 12345.
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
repository_namestringrequired- Repository name inside the organization, e.g. awesome-repo. Example: awesome-repo.
codacy_file_getGet the Codacy analysis of one file.Read-onlyGet File Analysis
Get the Codacy analysis of one file. Returns its grade, issues, complexity, duplication and coverage. Use Get File Issues for the issues in it.
Inputs
file_idintegerrequired- Codacy file ID, from List Files. Example: 12345.
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
repository_namestringrequired- Repository name inside the organization, e.g. awesome-repo. Example: awesome-repo.
codacy_file_issues_listList the Codacy issues in one file.Read-onlyGet File Issues
List the Codacy issues in one file. Returns each issue's pattern, severity, line and message. Use List Files to find the file ID.
Inputs
file_idintegerrequired- Codacy file ID, from List Files. Example: 12345.
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
repository_namestringrequired- Repository name inside the organization, e.g. awesome-repo. Example: awesome-repo.
cursorstring- Cursor for the next page, from the previous response's pagination.cursor. Omit for the first page. Example: Yms345gh==.
limitinteger- Maximum number of items to return, 1 to 100. Example: 20.
codacy_files_listList the files of a Codacy repository branch with their quality metrics.Read-onlyList Files
List the files of a Codacy repository branch with their quality metrics. Returns each file's id, path, grade, issues, complexity, duplication and coverage. Use a file ID with Get File Analysis.
Inputs
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
repository_namestringrequired- Repository name inside the organization, e.g. awesome-repo. Example: awesome-repo.
branchstring- Branch name; defaults to the repository's main branch. Example: main.
cursorstring- Cursor for the next page, from the previous response's pagination.cursor. Omit for the first page. Example: Yms345gh==.
directionstring- Sort direction. Possible values are 'asc' (ascending) or 'desc' (descending). Example: desc.
limitinteger- Maximum number of items to return, 1 to 100. Example: 20.
pathstring- Relative path of the folder whose direct child files are listed. When absent, all files in the repository are returned (recursive). When empty, only files at the repository root are returned. Example: src/.
searchstring- Text to filter results by name. Example: api.
sortstring- Field used to sort the results. For files the valid values are `filename`, `issues`, `grade`, `duplication`, `complexity`, and `coverage`. For folders the valid values are `name`, `issues`, `grade`, `duplication`, `complexity`, and `coverage`. Example: issues.
codacy_gate_policies_listList the quality gate policies of a Codacy organization.Read-onlyList Gate Policies
List the quality gate policies of a Codacy organization. Returns each policy's id, name and default flag. Use Get Gate Policy for its rules.
Inputs
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
cursorstring- Cursor for the next page, from the previous response's pagination.cursor. Omit for the first page. Example: Yms345gh==.
limitinteger- Maximum number of items to return, 1 to 100. Example: 20.
codacy_gate_policy_getGet one Codacy quality gate policy.Read-onlyGet Gate Policy
Get one Codacy quality gate policy. Returns its name and the thresholds for issues, complexity, duplication and coverage. Use List Gate Policies to find the ID.
Inputs
gate_policy_idintegerrequired- Gate policy ID, from List Gate Policies. Example: 7.
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
codacy_issue_getGet one open Codacy issue.Read-onlyGet Issue
Get one open Codacy issue. Returns its pattern, severity, category, file, line, message and commit. Use Search Issues to find the ID.
Inputs
issue_idintegerrequired- Codacy issue ID, from Search Issues. Example: 67890.
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
repository_namestringrequired- Repository name inside the organization, e.g. awesome-repo. Example: awesome-repo.
codacy_issues_overview_getCount the open Codacy issues of a repository by category, severity, language, tag, pattern and author, with filters.Read-onlyGet Issues Overview
Count the open Codacy issues of a repository by category, severity, language, tag, pattern and author, with filters. Returns counts grouped by each dimension. Use Search Issues to list them.
Inputs
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
repository_namestringrequired- Repository name inside the organization, e.g. awesome-repo. Example: awesome-repo.
author_emailsarray- Set of commit author email addresses. Example: ["dev@example.com"].
branch_namestring- Branch name in the repository. Example: main.
categoriesarray- Set of issue categories. Example: ["Security"].
languagesarray- Set of language names, without spaces. Example: ["JavaScript"].
levelsarray- Set of issue severity levels. Example: ["Error"].
pattern_idsarray- Set of code pattern identifiers, as returned by the endpoint listPatterns. Example: ["ESLint8_no-unused-vars"].
potential_false_positivesboolean- If true, only issues that are potential false positives will be included in the search, if false, only issues that are not potential false positives will be included in the search. Example: false.
tagsarray- Set of issue pattern tags. Example: ["cwe-79"].
tool_uuidsarray- Set of tool UUIDs to filter issues by the tools that detected them. Example: ["847feb32-9ff2-11ea-bb37-0242ac130002"].
codacy_issues_searchSearch the open Codacy issues of a repository by branch, pattern, tool, language, category, severity, tag or author.Read-onlySearch Issues
Search the open Codacy issues of a repository by branch, pattern, tool, language, category, severity, tag or author. Returns a page of issues with id, pattern, severity, file, line and message. Use Get Issues Overview for counts only.
Inputs
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
repository_namestringrequired- Repository name inside the organization, e.g. awesome-repo. Example: awesome-repo.
author_emailsarray- Set of commit author email addresses. Example: ["dev@example.com"].
branch_namestring- Branch name in the repository. Example: main.
categoriesarray- Set of issue categories. Example: ["Security"].
cursorstring- Cursor for the next page, from the previous response's pagination.cursor. Omit for the first page. Example: Yms345gh==.
languagesarray- Set of language names, without spaces. Example: ["JavaScript"].
levelsarray- Set of issue severity levels. Example: ["Error"].
limitinteger- Maximum number of items to return, 1 to 100. Example: 20.
pattern_idsarray- Set of code pattern identifiers, as returned by the endpoint listPatterns. Example: ["ESLint8_no-unused-vars"].
potential_false_positivesboolean- If true, only issues that are potential false positives will be included in the search, if false, only issues that are not potential false positives will be included in the search. Example: false.
tagsarray- Set of issue pattern tags. Example: ["cwe-79"].
tool_uuidsarray- Set of tool UUIDs to filter issues by the tools that detected them. Example: ["847feb32-9ff2-11ea-bb37-0242ac130002"].
codacy_organization_getGet one Codacy organization.Read-onlyGet Organization
Get one Codacy organization. Returns its name, provider, plan and settings. Use List My Organizations to find it.
Inputs
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
codacy_organization_people_listList the people in a Codacy organization.Read-onlyList Organization People
List the people in a Codacy organization. Returns each person's name, email, role and last login. Set onlyMembers to exclude committers who are not members.
Inputs
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
cursorstring- Cursor for the next page, from the previous response's pagination.cursor. Omit for the first page. Example: Yms345gh==.
limitinteger- Maximum number of items to return, 1 to 100. Example: 20.
only_membersboolean- If true, returns only Codacy users. If false, returns also commit authors that are not Codacy users. Example: true.
searchstring- Text to filter results by name. Example: api.
codacy_organization_pull_requests_listList recent pull requests across a Codacy organization's repositories.Read-onlyList Organization Pull Requests
List recent pull requests across a Codacy organization's repositories. Returns each pull request with its repository, status, quality gate result and new issues. Use List Pull Requests for one repository.
Inputs
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
limitinteger- Maximum number of items to return, 1 to 100. Example: 20.
repositoriesstring- **Deprecated:** Use searchOrganizationRepositoriesWithAnalysis instead. Example: awesome-repo.
searchstring- Text to filter results by name. Example: api.
codacy_organization_repositories_listList the repositories of a Codacy organization, with search and language filters.Read-onlyList Organization Repositories
List the repositories of a Codacy organization, with search and language filters. Returns each repository's name, visibility, languages and whether Codacy analyzes it. Use List Analyzed Repositories for grades and issue counts.
Inputs
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
cursorstring- Cursor for the next page, from the previous response's pagination.cursor. Omit for the first page. Example: Yms345gh==.
filterstring- Filter for which repositories to return. Use `Synced` for repositories the user has access to, `NotSynced` for repositories fetched from the provider, or `AllSynced` for all organization repositories (requires admin access). Example: AllSynced.one of
SyncedNotSyncedAllSynced languagesstring- Comma-separated list of programming languages to filter results by. Example: JavaScript.
limitinteger- Maximum number of items to return, 1 to 100. Example: 20.
searchstring- Text to filter results by name. Example: api.
segmentsstring- Filter by a comma-separated list of segment identifiers. Example: 1.
stack_tagsstring- Comma-separated list of detected stack tags to filter repositories by. Example: react.
codacy_pull_request_commits_listList the commits of a pull request with their Codacy analysis.Read-onlyList Pull Request Commits
List the commits of a pull request with their Codacy analysis. Returns each commit's SHA, author, message and quality deltas. Use Get Commit Analysis for one commit.
Inputs
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb pull_request_numberintegerrequired- Pull request number on the Git provider. Example: 42.
remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
repository_namestringrequired- Repository name inside the organization, e.g. awesome-repo. Example: awesome-repo.
cursorstring- Cursor for the next page, from the previous response's pagination.cursor. Omit for the first page. Example: Yms345gh==.
limitinteger- Maximum number of items to return, 1 to 100. Example: 20.
codacy_pull_request_coverage_getGet the code coverage of a pull request in Codacy.Read-onlyGet Pull Request Coverage
Get the code coverage of a pull request in Codacy. Returns diff coverage, coverage variation and the coverage report status. Use Get Pull Request Files Coverage per file.
Inputs
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb pull_request_numberintegerrequired- Pull request number on the Git provider. Example: 42.
remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
repository_namestringrequired- Repository name inside the organization, e.g. awesome-repo. Example: awesome-repo.
codacy_pull_request_files_coverage_getGet the code coverage of each file changed in a pull request.Read-onlyGet Pull Request Files Coverage
Get the code coverage of each file changed in a pull request. Returns each file's coverage and coverage change. Use Get Pull Request Coverage for the totals.
Inputs
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb pull_request_numberintegerrequired- Pull request number on the Git provider. Example: 42.
remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
repository_namestringrequired- Repository name inside the organization, e.g. awesome-repo. Example: awesome-repo.
codacy_pull_request_files_listList the files changed in a pull request with their Codacy quality deltas.Read-onlyList Pull Request Files
List the files changed in a pull request with their Codacy quality deltas. Returns each file's path, new and fixed issues, complexity, duplication and coverage change. Use List Pull Request Issues for issue details.
Inputs
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb pull_request_numberintegerrequired- Pull request number on the Git provider. Example: 42.
remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
repository_namestringrequired- Repository name inside the organization, e.g. awesome-repo. Example: awesome-repo.
column_orderstring- Sort direction. The possible values are `asc` (ascending - default) or `desc` (descending). Example: desc.one of
ascdesc cursorstring- Cursor for the next page, from the previous response's pagination.cursor. Omit for the first page. Example: Yms345gh==.
limitinteger- Maximum number of items to return, 1 to 100. Example: 20.
sort_columnstring- Field used to sort the results. The possible values are `deltaCoverage` (to sort by the coverage variation value of the files), `totalCoverage` (to sort by the total coverage value of the files) or `filename` (default - to sort by the name of the files). Example: deltaCoverage.one of
totalCoveragedeltaCoveragefilename
codacy_pull_request_getGet the Codacy analysis of one pull request.Read-onlyGet Pull Request
Get the Codacy analysis of one pull request. Returns new and fixed issues, complexity and duplication deltas, coverage and the quality gate result. Use List Pull Request Issues for the issues.
Inputs
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb pull_request_numberintegerrequired- Pull request number on the Git provider. Example: 42.
remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
repository_namestringrequired- Repository name inside the organization, e.g. awesome-repo. Example: awesome-repo.
codacy_pull_request_issues_listList the issues Codacy found in a pull request.Read-onlyList Pull Request Issues
List the issues Codacy found in a pull request. Returns each issue's pattern, severity, file, line and message. Use status new or fixed to see what the pull request introduces or removes.
Inputs
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb pull_request_numberintegerrequired- Pull request number on the Git provider. Example: 42.
remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
repository_namestringrequired- Repository name inside the organization, e.g. awesome-repo. Example: awesome-repo.
cursorstring- Cursor for the next page, from the previous response's pagination.cursor. Omit for the first page. Example: Yms345gh==.
limitinteger- Maximum number of items to return, 1 to 100. Example: 20.
only_potentialboolean- Set to `true` to return only potential issues. Example: false.
statusstring- Filter issues by status. Valid values are `all`, `new`, or `fixed`. Example: new.one of
allnewfixed
codacy_pull_request_quality_settings_getGet the quality gate rules Codacy applies to pull requests of a repository.Read-onlyGet Pull Request Quality Gate
Get the quality gate rules Codacy applies to pull requests of a repository. Returns thresholds for new issues, complexity, duplication and coverage. Use Get Repository Quality Goals for repository goals.
Inputs
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
repository_namestringrequired- Repository name inside the organization, e.g. awesome-repo. Example: awesome-repo.
codacy_pull_requests_listList the pull requests of a Codacy repository, with search and target branch filters.Read-onlyList Pull Requests
List the pull requests of a Codacy repository, with search and target branch filters. Returns each pull request's number, title, status, quality gate result and issue deltas. Use Get Pull Request for one.
Inputs
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
repository_namestringrequired- Repository name inside the organization, e.g. awesome-repo. Example: awesome-repo.
cursorstring- Cursor for the next page, from the previous response's pagination.cursor. Omit for the first page. Example: Yms345gh==.
include_not_analyzedboolean- If true, also return pull requests that weren't analyzed. Example: false.
limitinteger- Maximum number of items to return, 1 to 100. Example: 20.
searchstring- Text to filter results by name. Example: api.
target_branchstring- Filter pull requests by the name of their target branch. Pull requests targeting any other branch are excluded from the results. By default, pull requests targeting any branch are returned. Example: main.
text_querystring- Filter pull requests by a free-text search matched, case-insensitively, against the pull request title or the author's handle. Example: fix login.
codacy_repositories_analysis_listList an organization's repositories with their Codacy analysis summary.Read-onlyList Analyzed Repositories
List an organization's repositories with their Codacy analysis summary. Returns each repository's grade, issue count, complexity, duplication and coverage. Use Get Repository Analysis for one repository.
Inputs
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
cursorstring- Cursor for the next page, from the previous response's pagination.cursor. Omit for the first page. Example: Yms345gh==.
limitinteger- Maximum number of items to return, 1 to 100. Example: 20.
repositoriesstring- **Deprecated:** Use searchOrganizationRepositoriesWithAnalysis instead. Example: awesome-repo.
searchstring- Text to filter results by name. Example: api.
segmentsstring- Filter by a comma-separated list of segment identifiers. Example: 1.
codacy_repository_analysis_getGet the Codacy analysis summary of a repository branch.Read-onlyGet Repository Analysis
Get the Codacy analysis summary of a repository branch. Returns grade, issues, complexity, duplication, coverage and last analyzed commit. Use List Category Overviews for issues by category.
Inputs
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
repository_namestringrequired- Repository name inside the organization, e.g. awesome-repo. Example: awesome-repo.
branchstring- Branch name; defaults to the repository's main branch. Example: main.
codacy_repository_analysis_progress_getGet the progress of a Codacy repository's first analysis.Read-onlyGet Analysis Progress
Get the progress of a Codacy repository's first analysis. Returns the analysis status and steps. Use it right after Add Repository.
Inputs
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
repository_namestringrequired- Repository name inside the organization, e.g. awesome-repo. Example: awesome-repo.
branchstring- Branch name; defaults to the repository's main branch. Example: main.
codacy_repository_branches_listList the branches of a Codacy repository, optionally only analyzed ones.Read-onlyList Branches
List the branches of a Codacy repository, optionally only analyzed ones. Returns each branch's name, whether it is enabled and its last analysis. Use Update Branch to turn analysis on or off.
Inputs
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
repository_namestringrequired- Repository name inside the organization, e.g. awesome-repo. Example: awesome-repo.
cursorstring- Cursor for the next page, from the previous response's pagination.cursor. Omit for the first page. Example: Yms345gh==.
directionstring- Sort direction. Possible values are 'asc' (ascending) or 'desc' (descending). Example: asc.
enabledboolean- Filter by branch status. Set to `true` to return only enabled branches, or `false` to return only disabled branches. Example: true.
limitinteger- Maximum number of items to return, 1 to 100. Example: 20.
searchstring- Text to filter results by name. Example: api.
sortstring- Field used to sort the list of branches. The allowed values are 'name' and 'last-updated'. Example: name.
codacy_repository_getGet one Codacy repository's settings and status.Read-onlyGet Repository
Get one Codacy repository's settings and status. Returns its name, visibility, default branch, languages and problems. Use Get Repository Analysis for grades and metrics.
Inputs
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
repository_namestringrequired- Repository name inside the organization, e.g. awesome-repo. Example: awesome-repo.
codacy_repository_quality_settings_getGet the quality goals of a Codacy repository, such as maximum issue percentage and minimum coverage.Read-onlyGet Repository Quality Goals
Get the quality goals of a Codacy repository, such as maximum issue percentage and minimum coverage. Returns the configured thresholds. Use Get Pull Request Quality Gate for pull request rules.
Inputs
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
repository_namestringrequired- Repository name inside the organization, e.g. awesome-repo. Example: awesome-repo.
codacy_repository_tool_patterns_listList the patterns (rules) of a tool in a Codacy repository, filtered by language, category, severity, tags or state.Read-onlyList Repository Tool Patterns
List the patterns (rules) of a tool in a Codacy repository, filtered by language, category, severity, tags or state. Returns each pattern's id, title, category, severity and whether it is enabled. Use Update Repository Tool Patterns to switch matching patterns on or off.
Inputs
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
repository_namestringrequired- Repository name inside the organization, e.g. awesome-repo. Example: awesome-repo.
tool_uuidstringrequired- UUID of the analysis tool, from List Tools or List Repository Tools. Example: 847feb32-9ff2-11ea-bb37-0242ac130002.
categoriesstring- Filter by a comma-separated list of code pattern categories. Valid values are `Security`, `ErrorProne`, `CodeStyle`, `Compatibility`, `UnusedCode`, `Complexity`, `Comprehensibility`, `Documentation`, `BestPractice`, and `Performance`. Example: Security.
cursorstring- Cursor for the next page, from the previous response's pagination.cursor. Omit for the first page. Example: Yms345gh==.
directionstring- Sort direction. Possible values are 'asc' (ascending) or 'desc' (descending). Example: desc.
enabledboolean- Filter by pattern status. Set to `true` to return only enabled patterns, or `false` to return only disabled patterns. Example: true.
languagesstring- Comma-separated list of programming languages to filter results by. Example: JavaScript.
limitinteger- Maximum number of items to return, 1 to 100. Example: 20.
matches_stackboolean- Filter repository code patterns by whether they match the repository stack. Example: true.
recommendedboolean- Filter by recommended status. Set to `true` to return only recommended patterns, or `false` to return only non-recommended patterns. Example: true.
searchstring- Text to filter results by name. Example: api.
severity_levelsstring- Filter by a comma-separated list of code pattern severity levels. Valid values are `Error`, `High`, `Warning`, and `Info`. Example: Error.
sortstring- Field used to sort the tool's code patterns. Valid values are `category`, `recommended`, and `severity`. Example: severity.
tagsstring- Filter by a comma-separated list of pattern tags. Example: cwe-79.
codacy_repository_tools_listList the analysis tools of a Codacy repository and whether each is enabled.Read-onlyList Repository Tools
List the analysis tools of a Codacy repository and whether each is enabled. Returns each tool's UUID, name, enabled state and config-file use. Use Configure Repository Tool to change one.
Inputs
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
repository_namestringrequired- Repository name inside the organization, e.g. awesome-repo. Example: awesome-repo.
codacy_security_dashboard_getGet an organization's Codacy security dashboard metrics, filtered by repository, priority, category or scan type.Read-onlyGet Security Dashboard
Get an organization's Codacy security dashboard metrics, filtered by repository, priority, category or scan type. Returns open and overdue finding counts and remediation metrics. Use Search Security Findings for the findings.
Inputs
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
categoriesarray- Security categories to filter by. Use `_other_` to search for issues that don't have a security category. Example: ["XSS"].
prioritiesarray- Security issue priorities to filter by. See SrmPriority for valid values. Example: ["High"].
repositoriesarray- Repository names to filter by. Example: ["awesome-repo"].
scan_typesarray- Scan types to filter by. Example: ["SAST"].
segmentsarray- Segments ids to filter by. Example: [1].
codacy_security_finding_getGet one Codacy security finding.Read-onlyGet Security Finding
Get one Codacy security finding. Returns its title, priority, status, category, repository, location and due date. Use Search Security Findings to find the ID.
Inputs
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
srm_item_idstringrequired- Security finding ID (UUID), from Search Security Findings. Example: 80f64371-e6bc-4d9b-b022-7c873cc5e39f.
codacy_security_findings_searchSearch an organization's Codacy security findings by repository, priority, status, category or scan type.Read-onlySearch Security Findings
Search an organization's Codacy security findings by repository, priority, status, category or scan type. Returns a page of findings with id, title, priority, status, repository and due date. Use Get Security Finding for one.
Inputs
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
categoriesarray- Security categories to filter by. Use `_other_` to search for issues that don't have a security category. Example: ["XSS"].
container_imageobject- Filter for container scanning items. The image `name` is required; `tag` is optional. Filtering by tag alone (without name) is not allowed. Example: {"name": "api", "tag": "latest"}.
cursorstring- Cursor for the next page, from the previous response's pagination.cursor. Omit for the first page. Example: Yms345gh==.
dast_target_urlsarray- Filter containing a list of Dast target urls. Example: ["https://app.example.com"].
directionstring- Sort direction. Possible values are 'asc' (ascending) or 'desc' (descending). Example: desc.
limitinteger- Maximum number of items to return, 1 to 100. Example: 20.
prioritiesarray- Security issue priorities to filter by. See SrmPriority for valid values. Example: ["High"].
repositoriesarray- Repository names to filter by. Example: ["awesome-repo"].
scan_typesarray- Scan types to filter by. Example: ["SAST"].
search_textstring- Text to search for in security items. Example: injection.
segmentsarray- Segments ids to filter by. Example: [1].
sortstring- Field to sort SRM items by. Example: DetectedAt.one of
StatusDetectedAt statusesarray- Security issue status to filter by. See SrmStatus for valid values. Example: ["Overdue"].
codacy_tool_pattern_getGet one pattern (rule) of a Codacy analysis tool.Read-onlyGet Tool Pattern
Get one pattern (rule) of a Codacy analysis tool. Returns its title, description, explanation, category, severity and parameters. Use List Tool Patterns to find the ID.
Inputs
pattern_idstringrequired- Pattern (rule) ID, from List Tool Patterns. Example: ESLint8_no-unused-vars.
tool_uuidstringrequired- UUID of the analysis tool, from List Tools or List Repository Tools. Example: 847feb32-9ff2-11ea-bb37-0242ac130002.
codacy_tool_patterns_listList the patterns (rules) of a Codacy analysis tool.Read-onlyList Tool Patterns
List the patterns (rules) of a Codacy analysis tool. Returns each pattern's id, title, category, severity and default state. Use Get Tool Pattern for one pattern's details.
Inputs
tool_uuidstringrequired- UUID of the analysis tool, from List Tools or List Repository Tools. Example: 847feb32-9ff2-11ea-bb37-0242ac130002.
cursorstring- Cursor for the next page, from the previous response's pagination.cursor. Omit for the first page. Example: Yms345gh==.
enabledboolean- Filter by enabled status. Set to `true` to return only enabled patterns, or `false` to return only disabled patterns. Example: true.
limitinteger- Maximum number of items to return, 1 to 100. Example: 20.
codacy_tools_listList the analysis tools Codacy supports.Read-onlyList Tools
List the analysis tools Codacy supports. Returns each tool's UUID, name, languages and whether it is client-side. Use a tool UUID with the pattern tools.
Inputs
cursorstring- Cursor for the next page, from the previous response's pagination.cursor. Omit for the first page. Example: Yms345gh==.
limitinteger- Maximum number of items to return, 1 to 100. Example: 20.
codacy_user_getGet the Codacy user that owns the account API token.Read-onlyGet Current User
Get the Codacy user that owns the account API token. Returns the user's id, name, main email and other emails. Use it to confirm which account the token belongs to.
Inputs
This tool takes no inputs.
codacy_user_organizations_by_provider_listList the token user's Codacy organizations on one Git provider.Read-onlyList My Organizations By Provider
List the token user's Codacy organizations on one Git provider. Returns each organization's name and identifier. Use List My Organizations for every provider.
Inputs
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb cursorstring- Cursor for the next page, from the previous response's pagination.cursor. Omit for the first page. Example: Yms345gh==.
limitinteger- Maximum number of items to return, 1 to 100. Example: 20.
codacy_user_organizations_listList the Codacy organizations the token's user belongs to, across Git providers.Read-onlyList My Organizations
List the Codacy organizations the token's user belongs to, across Git providers. Returns each organization's name, provider and identifier. Use the provider and name in every organization tool.
Inputs
cursorstring- Cursor for the next page, from the previous response's pagination.cursor. Omit for the first page. Example: Yms345gh==.
limitinteger- Maximum number of items to return, 1 to 100. Example: 20.
codacy_coding_standard_repositories_applyLink repositories to a Codacy coding standard, or unlink them.WriteApply Coding Standard
Link repositories to a Codacy coding standard, or unlink them. Returns the result per repository. Send both lists; either may be empty.
Inputs
coding_standard_idintegerrequired- Coding standard ID, from List Coding Standards. Example: 12.
linkarrayrequired- Repository names to link to the coding standard. Example: ["awesome-repo"].
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
unlinkarrayrequired- Repository names to unlink from it. Example: [].
codacy_commit_reanalyzeAsk Codacy to analyze a commit again, optionally clearing the cache.WriteReanalyze Commit
Ask Codacy to analyze a commit again, optionally clearing the cache. Returns an empty success response; analysis runs in the background. Use Get Commit Analysis to see the new results.
Inputs
commit_uuidstringrequired- Commit SHA, from List Repository Commits. Example: 2957025d42e8daadf937d4044516f991d21deea4.
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
repository_namestringrequired- Repository name inside the organization, e.g. awesome-repo. Example: awesome-repo.
clean_cacheboolean- If true, the cache will be cleaned before the analysis. Example: false.
codacy_issue_state_updateIgnore a Codacy issue with a reason, or bring an ignored issue back.WriteIgnore Or Unignore Issue
Ignore a Codacy issue with a reason, or bring an ignored issue back. Returns an empty success response. Use Bulk Ignore Issues for many issues.
Inputs
ignoredbooleanrequired- True if the issue is ignored. Example: true.
issue_idstringrequired- Codacy issue ID, from Search Issues. Example: 67890.
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
repository_namestringrequired- Repository name inside the organization, e.g. awesome-repo. Example: awesome-repo.
commentstring- Optional comment justifying the ignore action. Example: Test fixture, not production code.
reasonstring- Predefined reason for ignoring the issue. Example: FalsePositive.one of
AcceptedUseFalsePositiveNotExploitableTestCodeExternalCode
codacy_issues_bulk_ignoreIgnore several Codacy issues of a repository at once.WriteBulk Ignore Issues
Ignore several Codacy issues of a repository at once. Returns an empty success response. Use Ignore Or Unignore Issue for a single issue.
Inputs
issue_idsarrayrequired- List of issue ids to ignore. Example: ["67890", "67891"].
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
repository_namestringrequired- Repository name inside the organization, e.g. awesome-repo. Example: awesome-repo.
commentstring- Optional comment. Example: Generated code.
reasonstring- Optional reason for ignoring. Example: FalsePositive.
codacy_organization_people_removeRemove people from a Codacy organization by email.WriteRemove Organization People
Remove people from a Codacy organization by email. Returns an empty success response. Requires organization admin rights.
Inputs
emailsarrayrequired- List of emails to add. Example: ["dev@example.com"].
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
codacy_repository_addAdd a Git repository to Codacy so it gets analyzed.WriteAdd Repository
Add a Git repository to Codacy so it gets analyzed. Returns the added repository. Give the provider and the full path org/repository.
Inputs
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb repository_full_pathstringrequired- Full path of the repository on the provider, organization/repository. Example: codacy/awesome-repo.
codacy_repository_branch_updateTurn Codacy analysis on or off for a repository branch.WriteUpdate Branch
Turn Codacy analysis on or off for a repository branch. Returns an empty success response. Use List Branches to see current settings.
Inputs
branch_namestringrequired- Branch name in the repository. Example: main.
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
repository_namestringrequired- Repository name inside the organization, e.g. awesome-repo. Example: awesome-repo.
is_enabledboolean- True if Codacy should analyze the branch. Example: true.
codacy_repository_followFollow a repository that is already added to Codacy, so it shows on your dashboard.WriteFollow Repository
Follow a repository that is already added to Codacy, so it shows on your dashboard. Returns an empty success response. Use Unfollow Repository to stop.
Inputs
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
repository_namestringrequired- Repository name inside the organization, e.g. awesome-repo. Example: awesome-repo.
codacy_repository_tool_configureEnable or disable an analysis tool for a Codacy repository, choose its config file use, or set patterns.WriteConfigure Repository Tool
Enable or disable an analysis tool for a Codacy repository, choose its config file use, or set patterns. Returns an empty success response. Use List Repository Tools for tool UUIDs.
Inputs
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
repository_namestringrequired- Repository name inside the organization, e.g. awesome-repo. Example: awesome-repo.
tool_uuidstringrequired- UUID of the analysis tool, from List Tools or List Repository Tools. Example: 847feb32-9ff2-11ea-bb37-0242ac130002.
enabledboolean- Whether to enable or disable the tool. Example: true.
patternsarray- The patterns to enable or disable. Example: [{"id": "ESLint8_no-unused-vars", "enabled": true}].
use_configuration_fileboolean- Marks the tool as using a configuration file or not. Example: false.
codacy_repository_tool_patterns_updateEnable or disable every pattern of a repository tool that matches the filters.WriteUpdate Repository Tool Patterns
Enable or disable every pattern of a repository tool that matches the filters. Returns an empty success response. Without filters it changes all patterns of the tool.
Inputs
enabledbooleanrequired- True enables the code patterns, and False disables them. Example: true.
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
repository_namestringrequired- Repository name inside the organization, e.g. awesome-repo. Example: awesome-repo.
tool_uuidstringrequired- UUID of the analysis tool, from List Tools or List Repository Tools. Example: 847feb32-9ff2-11ea-bb37-0242ac130002.
categoriesstring- Filter by a comma-separated list of code pattern categories. Valid values are `Security`, `ErrorProne`, `CodeStyle`, `Compatibility`, `UnusedCode`, `Complexity`, `Comprehensibility`, `Documentation`, `BestPractice`, and `Performance`. Example: Security.
languagesstring- Comma-separated list of programming languages to filter results by. Example: JavaScript.
matches_stackboolean- Filter repository code patterns by whether they match the repository stack. Example: true.
recommendedboolean- Filter by recommended status. Set to `true` to return only recommended patterns, or `false` to return only non-recommended patterns. Example: true.
searchstring- Text to filter results by name. Example: api.
severity_levelsstring- Filter by a comma-separated list of code pattern severity levels. Valid values are `Error`, `High`, `Warning`, and `Info`. Example: Error.
tagsstring- Filter by a comma-separated list of pattern tags. Example: cwe-79.
codacy_security_finding_ignoreIgnore a Codacy security finding with a reason and comment.WriteIgnore Security Finding
Ignore a Codacy security finding with a reason and comment. Returns the updated finding. Use Unignore Security Finding to reopen it.
Inputs
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
srm_item_idstringrequired- Security finding ID (UUID), from Search Security Findings. Example: 80f64371-e6bc-4d9b-b022-7c873cc5e39f.
commentstring- Comment describing why we ignore an issue. Example: Only used in test environment.
reasonstring- The reason why we ignore an issue. Must be one of `AcceptedUse`, `FalsePositive`, `NotExploitable`, `TestCode`, `ExternalCode`. Example: AcceptedUse.
codacy_security_finding_unignoreReopen a Codacy security finding that was ignored.WriteUnignore Security Finding
Reopen a Codacy security finding that was ignored. Returns the updated finding. Use Search Security Findings to find it.
Inputs
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
srm_item_idstringrequired- Security finding ID (UUID), from Search Security Findings. Example: 80f64371-e6bc-4d9b-b022-7c873cc5e39f.
codacy_repository_unfollowStop following a Codacy repository.DestructiveUnfollow Repository
Stop following a Codacy repository. Returns an empty success response. The repository keeps being analyzed.
- Idempotent
Inputs
providerstringrequired- Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of
ghglbb remote_organization_namestringrequired- Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
repository_namestringrequired- Repository name inside the organization, e.g. awesome-repo. Example: awesome-repo.
No tools match.