Skip to main content

API Parity Between Checkmarx One and Legacy

SAST/OSA REST

Checkmarx One REST

Description

{{SAST-server}}/cxrestapi/auth/AssignableUsers (GET)

None

List users that can be assigned to a vulnerability

{{SAST-server}}/cxrestapi/auth/AuthenticationProviders (GET)

{{iam-server-url}}/auth/admin/realms (GET)

List authentication providers

{{SAST-server}}/cxrestapi/auth/Configurations (GET)

{{ast-server-url}}/api/flags/* (GET)

List settings/flags (not many)

{{SAST-server}}/cxrestapi/auth/LDAPRoleMappings (GET)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/groups/{id}/role-mappings/realm (GET)

Show LDAP-provided info mapped to roles

{{SAST-server}}/cxrestapi/auth/LDAPRoleMappings/:id (DELETE)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/groups/{id}/role-mappings/realm (DELETE)

Remove mapping of LDAP-provided info to roles

{{SAST-server}}/cxrestapi/auth/LDAPServer/:id/TeamMappings (PATCH)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/identity-provider/instances/{alias}/mappers/{id} (PUT)

Update a team mapping based on LDAP info

{{SAST-server}}/cxrestapi/auth/LDAPServers (GET)

{{iam-server-url}}/auth/admin/realms`/{{tenant}}/components (GET)

List LDAP servers

{{SAST-server}}/cxrestapi/auth/LDAPServers (POST)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/components (PUT)

Add LDAP server

{{SAST-server}}/cxrestapi/auth/LDAPServers/:id (DELETE)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/components/{id} (DELETE)

Delete LDAP server

{{SAST-server}}/cxrestapi/auth/LDAPServers/:id (GET)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/components/{id} (GET)

Get info for a specific LDAP server

{{SAST-server}}/cxrestapi/auth/LDAPServers/:id (PUT)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/components/{id} (PUT)

Update info for a specific LDAP server

{{SAST-server}}/cxrestapi/auth/LDAPServers/:id/RoleMappings (PATCH)

None

Update role mapping for an LDAP server's returned info

{{SAST-server}}/cxrestapi/auth/LDAPServers/:id/RoleMappings (PUT)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/groups/{id}/role-mappings/realm (PUT)

Create role mapping for an LDAP server's returned info

{{SAST-server}}/cxrestapi/auth/LDAPServers/:id/TeamMappings (PUT)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/identity-provider/instances/{alias}/mappers (PUT)

Add a team mapping based on LDAP info

{{SAST-server}}/cxrestapi/auth/LDAPServers/TestConnection (GET)

None

Test the connection to the LDAP server

{{SAST-server}}/cxrestapi/auth/LDAPTeamMappings (GET)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/identity-provider/instances/{alias}/mappers (GET)

List the mappings between LDAP servers and teams

{{SAST-server}}/cxrestapi/auth/LDAPTeamMappings/:id (DELETE)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/identity-provider/instances/{alias}/mappers/{id} (DELETE)

Delete a specific mapping between LDAP servers and teams

{{SAST-server}}/cxrestapi/auth/MyProfile (GET)

{{iam-server-url}}/auth/admin/{{tenant}}/console/whoami

Get user profile info

{{SAST-server}}/cxrestapi/auth/MyProfile (PUT)

None

Update user profile

{{SAST-server}}/cxrestapi/auth/OIDCClients (GET)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/clients (GET)

List OIDC auth clients

{{SAST-server}}/cxrestapi/auth/OIDCClients (POST)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/clients (POST)

Add OIDC auth client

{{SAST-server}}/cxrestapi/auth/OIDCClients/:id (DELETE)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/clients/{id} (DELETE)

Delete OIDC auth client

{{SAST-server}}/cxrestapi/auth/OIDCClients/:id (GET)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/clients/{id} (GET)

Get details of an OIDC auth client

{{SAST-server}}/cxrestapi/auth/OIDCClients/:id (PUT)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/clients/{id} (PUT)

Update an OIDC auth client

{{SAST-server}}/cxrestapi/auth/Permissions (GET)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/clients/{id}/roles (GET)

Get a list of permissions

{{SAST-server}}/cxrestapi/auth/Permissions (POST)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/clients/{id}/roles (POST)

Add a permission

{{SAST-server}}/cxrestapi/auth/Permissions/:id (DELETE)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/clients/{id}/roles/{role-name} (DELETE) {{iam-server-url}}/auth/admin/realms/{{tenant}}/clients/{id}/roles-by-id/{role-id} (DELETE)

Delete a permission

{{SAST-server}}/cxrestapi/auth/Permissions/:id (GET)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/clients/{id}/roles/{role-name} (GET) {{iam-server-url}}/auth/admin/realms/{{tenant}}/clients/{id}/roles-by-id/{role-id} (GET)

Get info for a permission

{{SAST-server}}/cxrestapi/auth/Permissions/:id (PUT)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/clients/{id}/roles/{role-name} (PUT) {{iam-server-url}}/auth/admin/realms/{{tenant}}/clients/{id}/roles-by-id/{role-id} (PUT)

Modify a permission

{{SAST-server}}/cxrestapi/auth/Roles (GET)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/clients/{id}/roles (GET)

Get a list of roles

{{SAST-server}}/cxrestapi/auth/Roles (POST)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/clients/{id}/roles (POST)

Add a role

{{SAST-server}}/cxrestapi/auth/Roles/:id (DELETE)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/clients/{id}/roles/{role-name} (DELETE) {{iam-server-url}}/auth/admin/realms/{{tenant}}/clients/{id}/roles-by-id/{role-id} (DELETE)

Delete a role

{{SAST-server}}/cxrestapi/auth/Roles/:id (GET)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/clients/{id}/roles/{role-name} (GET) {{iam-server-url}}/auth/admin/realms/{{tenant}}/clients/{id}/roles-by-id/{role-id} (GET)

Get info for a role

{{SAST-server}}/cxrestapi/auth/Roles/:id (PUT)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/clients/{id}/roles/{role-name} (PUT) {{iam-server-url}}/auth/admin/realms/{{tenant}}/clients/{id}/roles-by-id/{role-id} (PUT)

Update a role

{{SAST-server}}/cxrestapi/auth/SamlIdentityProviders (GET)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/identity-provider/providers (GET) {{iam-server-url}}/auth/admin/realms/{{tenant}}/identity-provider/instances (GET)

Get a list of SAML ID providers

{{SAST-server}}/cxrestapi/auth/SamlIdentityProviders (POST)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/identity-provider/instances (POST)

Add a SAML ID provider

{{SAST-server}}/cxrestapi/auth/SamlIdentityProviders/:id (DELETE)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/identity-provider/instances/{name} (DELETE)

Delete a SAML ID provider

{{SAST-server}}/cxrestapi/auth/SamlIdentityProviders/:id (GET)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/identity-provider/instances/{name} (GET)

Get details for a SAML ID provider

{{SAST-server}}/cxrestapi/auth/SamlIdentityProviders/:id (PUT)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/identity-provider/instances/{name} (PUT)

Modify a SAML ID provider

{{SAST-server}}/cxrestapi/auth/SamlIdentityProviders/:id/RoleMappings (PUT)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/groups/{id}/role-mappings/realm (PUT)

Add a role mapping based on SAML IDP attribute

{{SAST-server}}/cxrestapi/auth/SamlIdentityProviders/:id/TeamMappings (PUT)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/identity-provider/instances/{alias}/mappers (PUT)

Modify a role mapping based on SAML IDP attribute

{{SAST-server}}/cxrestapi/auth/SamlRoleMappings (GET)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/groups/{id}/role-mappings/realm (GET)

Get a list of role mappings from SAML ID providers

{{SAST-server}}/cxrestapi/auth/SamlServiceProvider (GET)

None

Get a list of SAML Service providers

{{SAST-server}}/cxrestapi/auth/SamlServiceProvider (PUT)

None

Modify a SAML service provider

{{SAST-server}}/cxrestapi/auth/SamlServiceProvider/metadata (GET)

None

Get metadata for a SAML service provider

{{SAST-server}}/cxrestapi/auth/SamlTeamMappings (GET)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/identity-provider/instances/{alias}/mappers (GET)

Get a list of team mappings from SAML ID providers

{{SAST-server}}/cxrestapi/auth/SessionTimeout (GET)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/ (GET)

Get the current session timeout settings

{{SAST-server}}/cxrestapi/auth/SMTPSettings (GET)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/ (GET)

Get the current mail server settings

{{SAST-server}}/cxrestapi/auth/SMTPSettings (POST)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/ (POST)

Set the mail server settings

{{SAST-server}}/cxrestapi/auth/SMTPSettings/:id (GET)

None

Get the details of a mail server.

{{SAST-server}}/cxrestapi/auth/SMTPSettings/:id (PUT)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/ (PUT)

Update the details of a mail server.

{{SAST-server}}/cxrestapi/auth/Teams (GET)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/groups (GET)

Get a list of teams

{{SAST-server}}/cxrestapi/auth/Teams (POST)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/groups (POST) {{iam-server-url}}/auth/admin/realms/{{tenant}}/groups/{id}/children (POST)

Add a team mapping based on LDAP info

{{SAST-server}}/cxrestapi/auth/teams/:team-id (DELETE)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/groups/{id} (DELETE)

Delete a team

{{SAST-server}}/cxrestapi/auth/teams/:team-id (GET)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/groups/{id} (GET)

Get details for a specific team

{{SAST-server}}/cxrestapi/auth/teams/:team-id (PUT)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/groups/{id} (PUT)

Update a specific team

{{SAST-server}}/cxrestapi/auth/Teams/:team-id/Users (GET)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/groups/{id}/members (GET)

Get a list of users in a team

{{SAST-server}}/cxrestapi/auth/Teams/:team-id/Users (PUT)

None

Add a user to a team

{{SAST-server}}/cxrestapi/auth/Teams/:team-id/Users/:user-id (DELETE)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/users/{user-id}/groups/{group-id} (DELETE)

Remove a user from a team

{{SAST-server}}/cxrestapi/auth/Teams/:team-id/Users/:user-id (POST)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/users/{user-id}/groups/{group-id} (PUT)

Update a user's membership in a team

{{SAST-server}}/cxrestapi/auth/Users (GET)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/users (GET)

Get a list of users

{{SAST-server}}/cxrestapi/auth/Users (POST)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/users (POST)

Add a new user

{{SAST-server}}/cxrestapi/auth/Users/:id/ResetPassword (POST)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/users/{id}/reset-password (PUT) {{iam-server-url}}/auth/admin/realms/{{tenant}}/users/{id}/execute-actions-email (PUT)

Reset (randomly generate) a new password

{{SAST-server}}/cxrestapi/auth/Users/:user-id (DELETE)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/users/{id} (DELETE)

Delete a user

{{SAST-server}}/cxrestapi/auth/Users/:user-id (GET)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/users/{id} (GET)

Get a user's details

{{SAST-server}}/cxrestapi/auth/Users/:user-id (PUT)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/users/{id} (PUT)

Update a user's details

{{SAST-server}}/cxrestapi/auth/Users/bulkAddRemoveUsersRoles (POST)

None

Bulk operation to add/remove users and their roles

{{SAST-server}}/cxrestapi/auth/Users/bulkDelete (POST)

None

Bulk operation to delete users

{{SAST-server}}/cxrestapi/auth/Users/bulkUpdateStatus (POST)

None

Bulk operation to update user status

{{SAST-server}}/cxrestapi/auth/Users/ChangeMyPassword (POST)

None

Update own user password

{{SAST-server}}/cxrestapi/auth/Users/ChangePassword (POST)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/users/{id}/reset-password (PUT) {{iam-server-url}}/auth/admin/realms/{{tenant}}/users/{id}/execute-actions-email (PUT)

Update specific user's password

{{SAST-server}}/cxrestapi/auth/Users/DomainToLdapMigration (POST)

None

Migrate/convert a user from Domain to LDAP

{{SAST-server}}/cxrestapi/auth/Users/FirstAdmin (POST)

None

Create initial administrator account

{{SAST-server}}/cxrestapi/auth/Users/FirstAdminExistence (GET)

None

Check if an administrator account exists

{{SAST-server}}/cxrestapi/auth/Users/ForgotPassword (POST)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/login-actions/reset-credentials (POST)

Reset a user's credentials

{{SAST-server}}/cxrestapi/auth/Users/ResetPassword (POST)

{{iam-server-url}}/auth/admin/realms/{{tenant}}/login-actions/reset-credentials (POST)

Reset a user's password (to something randomly generated)

{{SAST-server}}/cxrestapi/auth/WindowsDomains (GET)

None

{{SAST-server}}/cxrestapi/auth/WindowsDomains (POST)

None

{{SAST-server}}/cxrestapi/auth/WindowsDomains/:id (DELETE)

None

{{SAST-server}}/cxrestapi/auth/WindowsDomains/:id (GET)

None

{{SAST-server}}/cxrestapi/auth/WindowsDomains/:id (PUT)

None

{{SAST-server}}/cxrestapi/auth/WindowsDomains/:id/UserEntries (GET)

None

{{SAST-server}}/cxrestapi/configurationsExtended/:group (GET)

None

Get values from the CxComponentConfiguration table

{{SAST-server}}/cxrestapi/configurationsExtended/:group (PUT)

None

Set values in the CxComponentConfiguration table

{{SAST-server}}/cxrestapi/customFields (GET)

None

Get a list of project-level custom fields

{{SAST-server}}/cxrestapi/customTasks (GET)

None

Get a list of pre/post-scan actions

{{SAST-server}}/cxrestapi/customTasks/:id (GET)

{{ast-server-url}}/api/webhooks/:id (GET)

Get info for a specific pre/post-scan action

{{SAST-server}}/cxrestapi/customTasks/name/:name (GET)

None

Get info for a specific pre/post-scan action (by name)

{{SAST-server}}/cxrestapi/CWE/:cwe-id (GET)

None

Assume this returns CWE info but can't find documentation

{{SAST-server}}/cxrestapi/issueTrackingSystems (GET)

None

Get a list of linked issue trackers/bug reporting systems

{{SAST-server}}/cxrestapi/issueTrackingSystems/:id/metadata (GET)

None

Get the details of a specific linked issue tracker

{{SAST-server}}/cxrestapi/LicenseDetails (GET)

None

Get the current license details

{{SAST-server}}/cxrestapi/osa/fileextensions (GET)

None

Get all supported Open Source file extensions

{{SAST-server}}/cxrestapi/osa/libraries (GET)

None

Returns all the used libraries for the specified scan Id.

{{SAST-server}}/cxrestapi/osa/licenses (GET)

None

Returns the licenses associated with the given scan request

{{SAST-server}}/cxrestapi/osa/reports (GET)

None

Returns a Json summary report for the specified scan Id.

{{SAST-server}}/cxrestapi/osa/scans (GET)

None

Returns basic scan details for all scans associated with a specified project id

{{SAST-server}}/cxrestapi/osa/scans (POST)

None

Creates a new scan request.

{{SAST-server}}/cxrestapi/osa/scans/:id (GET)

None

Returns basic scan details for a specified scan.

{{SAST-server}}/cxrestapi/osa/vulnerabilities (GET)

None

Returns all the vulnerabilities for the specified scan Id. Each vulnerability returned is unique to its library or file.

{{SAST-server}}/cxrestapi/osa/vulnerabilities/:id/comments (GET)

None

Returns a list of comments associated with the instances of the given vulnerability.

{{SAST-server}}/cxrestapi/projects (GET)

{{ast-server-url}}/api/projects (GET)

Get a list of projects

{{SAST-server}}/cxrestapi/projects (POST)

{{ast-server-url}}/api/projects (POST)

Add a project

{{SAST-server}}/cxrestapi/projects (PUT)

{{ast-server-url}}/api/projects/:id (PUT)

Update a project

{{SAST-server}}/cxrestapi/projects/:id/publisher/policyFindings/status (GET)

{{ast-server-url}}/api/projects/:id (GET)

Get the project status of the scan results publishing process

{{SAST-server}}/cxrestapi/projects/:id/sourceCode/attachments (POST)

{{ast-server-url}}/{{upload-url}} (PUT)

Attach source code for a project's next scan

{{SAST-server}}/cxrestapi/projects/:id/sourceCode/excludeSettings (GET)

{{ast-server-url}}/api/projects/:id (GET)

Get the project exclusion settings

{{SAST-server}}/cxrestapi/projects/:id/sourceCode/excludeSettings (PUT)

{{ast-server-url}}/api/projects/:id (PUT)

Update the project exclusion settings

{{SAST-server}}/cxrestapi/projects/:id/sourceCode/remoteSettings/custom (GET)

{{ast-server-url}}/api/projects/:id (GET)

Get custom source repository settings

{{SAST-server}}/cxrestapi/projects/:id/sourceCode/remoteSettings/custom (POST)

{{ast-server-url}}/api/projects/:id (PUT)

Update custom source repo settings

{{SAST-server}}/cxrestapi/projects/:id/sourceCode/remoteSettings/git (GET)

{{ast-server-url}}/api/projects/:id (GET)

Get git repo settings

{{SAST-server}}/cxrestapi/projects/:id/sourceCode/remoteSettings/git (POST)

{{ast-server-url}}/api/projects/:id (PUT)

Update git repo settings

{{SAST-server}}/cxrestapi/projects/:id/sourceCode/remoteSettings/git/ssh (POST)

{{ast-server-url}}/api/projects/:id (PUT)

Update git repo settings to use SSH urls

{{SAST-server}}/cxrestapi/projects/:id/sourceCode/remoteSettings/perforce (GET)

{{ast-server-url}}/api/projects/:id (GET)

Get perforce repo settings

{{SAST-server}}/cxrestapi/projects/:id/sourceCode/remoteSettings/perforce (POST)

{{ast-server-url}}/api/projects/:id (PUT)

Update perforce repo settings

{{SAST-server}}/cxrestapi/projects/:id/sourceCode/remoteSettings/shared (GET)

{{ast-server-url}}/api/projects/:id (GET)

Get shared network drive settings

{{SAST-server}}/cxrestapi/projects/:id/sourceCode/remoteSettings/shared (POST)

{{ast-server-url}}/api/projects/:id (PUT)

Set shared network drive settings

{{SAST-server}}/cxrestapi/projects/:id/sourceCode/remoteSettings/svn (GET)

{{ast-server-url}}/api/projects/:id (GET)

Get svn repo settings

{{SAST-server}}/cxrestapi/projects/:id/sourceCode/remoteSettings/svn (POST)

{{ast-server-url}}/api/projects/:id (PUT)

Set svn repo settings

{{SAST-server}}/cxrestapi/projects/:id/sourceCode/remoteSettings/svn/ssh (POST)

{{ast-server-url}}/api/projects/:id (PUT)

Set svn repo to use SSH

{{SAST-server}}/cxrestapi/projects/:id/sourceCode/remoteSettings/tfs (GET)

{{ast-server-url}}/api/projects/:id (GET)

Get TFS repo settings

{{SAST-server}}/cxrestapi/projects/:id/sourceCode/remoteSettings/tfs (POST)

{{ast-server-url}}/api/projects/:id (PUT)

Set TFS repo settings

{{SAST-server}}/cxrestapi/projects/:project-id (DELETE)

{{ast-server-url}}/api/projects/:id (DELETE)

Delete a project

{{SAST-server}}/cxrestapi/projects/:project-id (GET)

{{ast-server-url}}/api/projects/:id (GET)

Get a project info

{{SAST-server}}/cxrestapi/projects/:project-id (PATCH)

None

Partial-update/merge of a project's settings

{{SAST-server}}/cxrestapi/projects/:project-id (PUT)

{{ast-server-url}}/api/projects/:id (PUT)

Update a project's settings

{{SAST-server}}/cxrestapi/projects/:project-id/branch (POST)

None

Branch a project to another location

{{SAST-server}}/cxrestapi/projects/:project-id/dataRetentionSettings (POST)

None

Chane project's data retention settings

{{SAST-server}}/cxrestapi/projects/:project-id/forceScanOnNoCodeChanges (POST)

None

9.5 feature to for next scan to be full if it's incremental. To be used when upgrading environments/changing queries.

{{SAST-server}}/cxrestapi/projects/:project-id/issueTrackingSettings/jira (POST)

None

Update Jira settings for a project

{{SAST-server}}/cxrestapi/projects/branch/:id (GET)

None

Checks if this project is a branch of another project.

{{SAST-server}}/cxrestapi/queries/:query-id (GET)

{{ast-server-url}}/api/queries (GET)

Get a specific query's info

{{SAST-server}}/cxrestapi/queries/:query-id/CxDescription (GET)

{{ast-server-url}}/api/queries/descriptions (GET)

Get a query's description

{{SAST-server}}/cxrestapi/queries/queryVersionCode (GET)

None

Get information regarding a queryversioncode

{{SAST-server}}/cxrestapi/reports/sastScan (POST)

{{ast-server-url}}/api/reports (POST)

Generate a report

{{SAST-server}}/cxrestapi/reports/sastScan/:report-id/status (GET)

{{ast-server-url}}/api/reports/:reportId (GET)

Get the status of a report generation request

{{SAST-server}}/cxrestapi/reports/sastScan/:scan-id (GET)

{{ast-server-url}}/api/reports/:reportId/download (GET)

Download a report

{{SAST-server}}/cxrestapi/sast/dataRetention/:id/status (GET)

None

{{SAST-server}}/cxrestapi/sast/dataRetention/byDateRange (POST)

None

{{SAST-server}}/cxrestapi/sast/dataRetention/byNumberOfScans (POST)

None

{{SAST-server}}/cxrestapi/sast/dataRetention/stop (POST)

None

{{SAST-server}}/cxrestapi/sast/engineConfigurations (GET)

None

Get a list of engine configurations ("multi-language scan mode" etc)

{{SAST-server}}/cxrestapi/sast/engineConfigurations/:id (GET)

None

Get a specific engine configuration

{{SAST-server}}/cxrestapi/sast/engineServers (GET)

None

{{SAST-server}}/cxrestapi/sast/engineServers (POST)

None

{{SAST-server}}/cxrestapi/sast/engineServers/:id (DELETE)

None

{{SAST-server}}/cxrestapi/sast/engineServers/:id (GET)

None

{{SAST-server}}/cxrestapi/sast/engineServers/:id (PATCH)

None

{{SAST-server}}/cxrestapi/sast/engineServers/:id (PUT)

None

{{SAST-server}}/cxrestapi/sast/lockScan (PUT)

None

Lock a scan to prevent data retention

{{SAST-server}}/cxrestapi/sast/presets (GET)

{{ast-server-url}}/api/presets (GET) {{ast-server-url}}/api/queries/presets (GET)

Get a list of presets

{{SAST-server}}/cxrestapi/sast/presets/:id (GET)

{{ast-server-url}}/api/presets/{id} (GET)

Get information regarding a specific preset

{{SAST-server}}/cxrestapi/sast/project/:id/queueSettings (POST)

None

9.4 parallel scan cancellation feature

{{SAST-server}}/cxrestapi/sast/project/:id/queueSettings (PUT)

None

9.4 parallel scan cancellation feature

{{SAST-server}}/cxrestapi/sast/project/:id/scheduling (PUT)

None

Setting a project's scan schedule

{{SAST-server}}/cxrestapi/sast/resultPathCommentsHistory (GET)

{{ast-server-url}}/api/sast-results (GET)

Retrieve comments related to a finding

{{SAST-server}}/cxrestapi/sast/results (PATCH)

None

IAST Correlation id set

{{SAST-server}}/cxrestapi/sast/results/attack-vectors (GET)

{{ast-server-url}}/api/sast-results (GET)

Retrieve the attack vectors for a finding

{{SAST-server}}/cxrestapi/sast/results/attack-vectors-by-bfl (GET)

{{ast-server-url}}/api/bfl (GET)

Retrieve the attack vectors related to a BFL

{{SAST-server}}/cxrestapi/sast/results/tickets (POST)

None

Attach a ticket ID to scan results.

{{SAST-server}}/cxrestapi/sast/scans (GET)

{{ast-server-url}}/api/scans (GET)

Get a list of scans

{{SAST-server}}/cxrestapi/sast/scans (POST)

{{ast-server-url}}/api/scans (POST)

Start a scan

{{SAST-server}}/cxrestapi/sast/scans/:id (DELETE)

{{ast-server-url}}/api/scans/:id (DELETE)

Delete a scan

{{SAST-server}}/cxrestapi/sast/scans/:id (GET)

{{ast-server-url}}/api/scans/:scan-id

Get a scan's information

{{SAST-server}}/cxrestapi/sast/scans/:id (PATCH)

None

Update the comment on a scan

{{SAST-server}}/cxrestapi/sast/scans/:scan-id/failedGeneralQueries (GET)

None

Get a list of general queries that failed to run for a scan

{{SAST-server}}/cxrestapi/sast/scans/:scan-id/failedQueries (GET)

None

Get a list of queries that failed to run for a scan

{{SAST-server}}/cxrestapi/sast/scans/:scan-id/logs (GET)

{{ast-server-url}}/api/logs/:scan-id/sast

Get a scan's logs

{{SAST-server}}/cxrestapi/sast/scans/:scan-id/parsedFiles (GET)

None

Get a list of files parsed in a scan

{{SAST-server}}/cxrestapi/sast/scans/:scan-id/results/:path-id/labels (GET)

{{ast-server-url}}/api/sast-results (GET)

Get the current result audit state for a finding

{{SAST-server}}/cxrestapi/sast/scans/:scan-id/results/:path-id/shortDescription (GET)

{{ast-server-url}}/api/queries/descriptions (GET)

Get a description of a finding

{{SAST-server}}/cxrestapi/sast/scans/:scan-id/resultsStatistics (GET)

{{ast-server-url}}/api/scan-summary?scan-ids=:scan-id&include-queries=false&include-files=false

Shows the high-level # of findings

{{SAST-server}}/cxrestapi/sast/scans/:scan-id/statistics (GET)

{{ast-server-url}}/api/sast-metadata/:scan-id/metrics (GET)

Scanner metrics for a specific scan

{{SAST-server}}/cxrestapi/sast/scans/:scan-id/succeededGeneralQueries (GET)

None

Get a list of general queries that ran for a scan

{{SAST-server}}/cxrestapi/sast/scanSettings (GET)

{{ast-server-url}}/api/configuration/project (GET)

Get a project's scan settings (preset, configuration, post-scan actions)

{{SAST-server}}/cxrestapi/sast/scanSettings (POST)

{{ast-server-url}}/api/configuration/project (POST)

Update a project's default scan configuration

{{SAST-server}}/cxrestapi/sast/scanSettings (PUT)

{{ast-server-url}}/api/configuration/project (PATCH)

Update a project's default scan configuration

{{SAST-server}}/cxrestapi/sast/scanSettings/:project-id (GET)

{{ast-server-url}}/api/configuration/project (GET)

Get a project's scan configuration

{{SAST-server}}/cxrestapi/sast/scansQueue (GET)

{{ast-server-url}}/api/sast-rm/scans (GET)

Get the scans in the queue

{{SAST-server}}/cxrestapi/sast/scansQueue/:scan-id (GET)

{{ast-server-url}}/api/sast-rm/scans/:id (GET)

Get a scan's information

{{SAST-server}}/cxrestapi/sast/scansQueue/:scan-id (PATCH)

{{ast-server-url}}/api/sast-rm/scans/:correlation-id (DELETE)

Cancel a running scan

{{SAST-server}}/cxrestapi/sast/scanWithSettings (POST)

{{ast-server-url}}/api/scans (POST)

Creates a new scan.

{{SAST-server}}/cxrestapi/sast/unLockScan (PUT)

None

Related to data retention

{{SAST-server}}/cxrestapi/serverLicenseData (GET)

None

{{SAST-server}}/cxrestapi/system/version (GET)

None