NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Codacy connects to a Nagent workspace with an API key. Once it is connected, agents can call 18 Codacy actions, such as "Create API Token", "Get Account Details" and "Get Configuration Status". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Codacy, with input parameters and output schema.
CODACY_CREATE_API_TOKENCreates a new account API token for the authenticated user. The token inherits all permissions from the account owner and provides access to the same organizations and repositories. Note: The token is created with default settings. To configure expiration dates or other settings, use the Codacy web interface. The newly created token can be used to authenticate API requests by including it in the 'api-token' header.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CODACY_DELETE_API_TOKENTool to delete a specific API token from the authenticated user's account. Use after confirming the token ID.
Input parameters
The ID of the API token to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CODACY_GET_ACCOUNT_DETAILSTool to retrieve details of the authenticated user's account. Use when confirming authentication before user-level operations.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CODACY_GET_CONFIGURATION_STATUSTool to retrieve the current configuration status of the Codacy system. Use when checking system setup completion or first-time configuration status.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CODACY_GET_HEALTHTool to check the health status of the Codacy API. Use when verifying API connectivity and service availability.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CODACY_GET_ORGANIZATIONS_REPOSITORIES_SETTINGS_LANGUAGESTool to get the list of all languages with their extensions and enabled status for a repository. Use when you need to understand which programming languages are detected and enabled for analysis in a specific Codacy repository.
Input parameters
Git provider identifier (e.g., 'gh' for GitHub, 'gl' for GitLab, 'bb' for Bitbucket).
Repository name on the Git provider organization.
Organization name on the Git provider.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CODACY_GET_TOOL_PATTERNTool to retrieve the definition of a specific pattern for a given tool. Use when you need to get detailed information about a specific code pattern including its description, examples, parameters, and configuration.
Input parameters
Unique identifier (UUID) for the tool.
Pattern identifier.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CODACY_GET_USER_ORGANIZATIONSRetrieves all organizations the authenticated user belongs to for a specific Git provider. Returns organization details including name, provider, avatar, access permissions (DAST, SCA), and join status. Use this to discover which organizations a user can access on Codacy for a given Git provider (GitHub, GitLab, or Bitbucket). Requires the user to have connected the specified provider to their Codacy account.
Input parameters
Git provider to list organizations from. Supported values: 'gh' (GitHub), 'gl' (GitLab), 'bb' (Bitbucket). Note: User must have connected the corresponding provider to their Codacy account.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CODACY_GET_VERSIONTool to retrieve the version of the Codacy installation. Use when checking the Codacy API version for compatibility or debugging purposes.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CODACY_LIST_ANALYSIS_ORGANIZATIONS_REPOSITORIESTool to list organization repositories with analysis information for the authenticated user. Use when you need to retrieve repositories from a specific organization with their analysis status. For Bitbucket, ensure you URL encode the cursor before using it in subsequent API calls.
Input parameters
Maximum number of results to return. Must be between 1 and 1000. Default is 100.
Pagination cursor. For Bitbucket, you must URL encode the cursor before using it in subsequent API calls, as the pagination comes directly from the Git provider.
Filter repositories by name.
Git provider code. Valid values: 'gh' (GitHub), 'ghe' (GitHub Enterprise), 'gl' (GitLab), 'gle' (GitLab Enterprise), 'bb' (Bitbucket), 'bbe' (Bitbucket Enterprise).
Organization name on the Git provider.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CODACY_LIST_DUPLICATION_TOOLSTool to retrieve the list of duplication detection tools available in Codacy. Use when you need to identify which tools can analyze code duplication for different programming languages.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CODACY_LIST_LANGUAGES_TOOLSTool to retrieve the list of languages supported by available tools. Use when you need to determine which programming languages are supported by Codacy's analysis tools.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CODACY_LIST_LOGIN_INTEGRATIONSTool to list configured login providers on Codacy's platform. Use when you need to discover available authentication methods for Codacy login.
Input parameters
Maximum number of items to return. Defaults to 100.
Cursor to specify a batch of results to request for pagination. See https://docs.codacy.com/codacy-api/using-the-codacy-api/#using-pagination
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CODACY_LIST_METRICS_TOOLSTool to retrieve the list of metrics tools available in Codacy. Use when you need to discover which tools calculate metrics on projects and which languages they support.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CODACY_LIST_PROJECTSTool to list all projects accessible to the authenticated user. Use when you need a list of repositories after confirming API token validity.
Input parameters
Page number for pagination, must be >= 1.
Filter projects by matching project name.
Number of items per page, must be between 1 and 100.
Filter by organization name.
Filter by organization provider (e.g., 'github', 'gitlab').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CODACY_LIST_PROVIDER_INTEGRATIONSTool to list provider integrations existing on Codacy's platform. Use when you need to discover available Git providers that can be integrated with Codacy for authentication and repository management.
Input parameters
Maximum number of items to return. Defaults to 100.
Cursor to specify a batch of results to request for pagination. See https://docs.codacy.com/codacy-api/using-the-codacy-api/#using-pagination
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CODACY_LIST_TOOLSTool to retrieve the list of analysis tools available in Codacy. Use when you need to identify which code analysis tools are available and which programming languages they support.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CODACY_LIST_TOOLS_PATTERNSTool to retrieve the list of patterns for a specific tool. Returns code patterns that the tool can use to find issues, with pagination support.
Input parameters
Maximum number of items to return. Default is 100.
Cursor to specify a batch of results to request (for pagination).
Filter by enabled status. Set to true to return only enabled patterns, or false to return only disabled patterns.
Unique identifier (UUID) for the tool.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 18 Codacy actions on Nagent, including "Create API Token", "Get Account Details" and "Get Configuration Status". Create API Token: Creates a new account API token for the authenticated user. Each action is listed on this page with its input parameters and its output.
Codacy connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
It returns data, error and successful.