Skip to Content
FeaturesQuality Profiles & Rule Catalog

Configure quality profiles and browse rules

Quality Profiles let organization administrators save language-specific rule selections and assign them to repositories. The Rule Catalog is the searchable inventory used to build those profiles.

Browse the rule catalog

  1. Open SettingsPolicies.
  2. Select Rule Catalog.
  3. Search by rule name or identifier, or filter by analyzer, language, severity, and rule type.

The catalog is read-only. CodeStax uses branded analyzer names in the interface, such as SAST Analyzer, Secret Detection Engine, and Complexity Analyzer.

Create a quality profile

  1. Open SettingsPoliciesQuality Profiles.
  2. Select New Quality Profile.
  3. Choose a name and language.
  4. Add enabled or disabled rule identifiers and any severity overrides.
  5. Save the profile, then assign it to a repository.

You can also clone an existing profile. Built-in profiles cannot be edited or deleted, and a profile assigned to repositories cannot be deleted until those assignments are removed.

Profile management and repository assignment are available today, but analyzer-side enforcement is not yet wired for every analyzer. Confirm the effective rules in a test scan before using a profile as a release control.

Use the API

# List profiles $ curl -H "X-API-Key: <api_key>" \ https://codestax.co/api/quality-profiles # Browse active rules $ curl -H "X-API-Key: <api_key>" \ "https://codestax.co/api/rule-catalog?language=python&severity=high"

Administrators can create profiles with POST /api/quality-profiles, update them with PUT /api/quality-profiles/{profile_id}, and assign them with POST /api/quality-profiles/{profile_id}/assign/{repo_id}. Use POST /api/quality-profiles/unassign/{repo_id} to restore the repository to its inherited profile.

API keys can read profiles and the rule catalog. Profile creation, updates, assignment, and deletion currently require a signed-in organization admin or owner; an API key does not inherit its creator’s role.

For organization-wide scan defaults and repository overrides, see Policies.