API Change Log

Deprecated endpoint name: Get Analytics Bootstrap Findings - GET /api/v1/clients/analytics/bootstrap

Context: Deprecating legacy bootstrap implementation of analytics.

Replacement: none

Deprecated endpoint name: GET /api/v1/clients/analytics/export

Context: The legacy endpoint had poor performance and was no longer used by the PlexTrac frontend.

Replacement: none

-----

Deprecated endpoint name: GET /api/v1/flaws

Context: This endpoint was returning an empty array with no data.

Replacement:

These replacements provide similar functionality but don't retrieve all findings across an instance.

• Get Findings by Report - POST /api/v2/clients/{clientId}/reports/{reportId}/findings

• List Client Findings - POST /api/v2/client/{clientId}/findings

-----

Deprecated endpoint name: Get Client Flaws - GET /api/v1/client/{clientID}/topFlaws

Context: Deprecated in favor of v2 endpoint with similar functionality and better data fetching performance.

Replacement:

• List Client Findings - POST /api/v2/client/{clientId}/findings

-----

Deprecated endpoint name: Get Multiple Client Flaws - POST /api/v1/clients/topFlaws

Context: Deprecated in favor of v2 endpoint with similar functionality and better data fetching performance.

Replacement:

• List Client Findings - POST /api/v2/client/{clientId}/findings

-----

Deprecated endpoint name: GET /api/v1/clients/findings

Context: The v1 endpoint returned finding information for all clients across the tenant. This resulted in poor performance and was deprecated in favor of data segmentation by client to improve performance.

Replacement:

The replacement provides similar functionality but doesn't retrieve all findings across an instance.

• List Client Findings - POST /api/v2/client/{clientId}/findings

Deprecated endpoint name: GET /api/v1/client/{clientID}/analytics

Context: Removing functionality to get data for a single client in favor of the more performant way of getting all data simultaneously.

Replacement:

• POST /api/v1/clients/analytics

-----

Deprecated endpoint name: GET /api/v1/tenant/analytics/findings/{status}

Context: Deprecating legacy implementation of analytics.

Replacement:

• GET /api/v2/tenant/analytics/findings/{status}

-----

Deprecated endpoint name: GET /api/v1/tenant/analytics

Context: Deprecating legacy implementation of analytics.

Replacement:

• GET /api/v2/tenant/analytics

-----

Deprecated endpoint name: GET /api/v1/client/{clientID}/analytics/flaws/{status}

Context: Deprecating legacy implementation of analytics.

Replacement:

• GET /api/v2/tenant/analytics/findings/{status}

-----

Deprecated endpoint name: GET /api/v1/client/{clientID}/analytics/flaws/aging

Context: Deprecating legacy implementation of analytics.

Replacement: none

Deprecated endpoint name: Retrieve Analytics Assets - Suggestion - POST /api/v2/clients/analytics/assets/suggestion

Context: Deprecating legacy implementation of analytics.

Replacement: none

Deprecated endpoint name: Import Client Assets v1 - POST /api/v1/client/{clientId}/assets/import/{source}

Context: This endpoint has been marked as deprecated in our Postman docs since adding the v2 endpoint with the same functionality, but was not planned for immediate removal.

Replacement: Import Client Assets v2 - POST /api/v2/client/{clientId}/assets/import/{source}

Deprecated endpoint name: Get Affected Assets by Finding - GET/api/v2/clients/{clientId}/reports/{reportId}/flaws/{flawId}/affected_assets

Context: This endpoint returns a subset of the finding information regarding the affected assets. In order to minimize the number of endpoints we have to maintained, this is being deprecated in favor of using the endpoint that retrieves the entire finding, including the affected asset information from this endpoint.

Replacement: Get Finding - GET /api/v1/client/{clientId}/report/{reportId}/flaw/{findingId}

Deprecated endpoint name: Bulk Get Evidence - POST /api/v2/tenant/{{tenantId}}/client/{{clientId}}/report/{{reportId}}/finding/{{findingId}}/asset/evidence

Context: A bug in evidence handling was identified where the same evidence could be linked to multiple affected assets, leading to unintended modifications. As a result, the endpoint will be deprecated due to changes in the response, which now includes duplicate data for certain evidence objects. Acknowledging this modification and adjusting implementations accordingly before the endpoint is sunset is crucial.

Overview of Changes

Important: The response will change and contain seemingly duplicate evidence entries in version 1.62. The endpoint will be removed in version 1.63.

Replacement: Get Scanner Output - GET /api/v1/client/{{clientId}}/report/{{reportId}}/flaw/{{findingId}}/asset/{{assetId}}/scanoutput

Deprecated endpoint name: Add Findings from File Imports V1 - POST /api/v1/client/{clientId}/report/{reportId}/import/{source}

Context: This endpoint has a V2 that was created to fix performance issues. The V2 endpoint does not leave the HTTP request open throughout the entire import process, removing the possibility that the request could fail due to timeout errors on larger imports.

Overview of Changes

The V1 endpoint will be removed in favor of the V2 endpoint. Please read the differences between endpoints! Updating to the V2 endpoint is not as simple as replacing the route.

V1 Description vs V2 Description

Replacement: Add Findings from File Imports V2 - POST /api/v2/client/{clientId}/report/{reportId}/importAsync/{source}

Deprecated endpoint name: List Client Assets - GET /api/v1/client/{clientID}/assets

Context: This endpoint is being removed as it returns an unpaginated list of assets that can be very large and result in database errors.

Replacements: Depending on the need, the following could be used to retrieve assets:

• Get Tenant Assets (all assets) + full related finding information

  - no child asset information

• Get Assets by Client (client-specific assets) - only has a count of related findings with no finding information - no child assets information

• List Report Assets (report-specific assets) + full related finding information and count of related findings + includes child asset information

Deprecated endpoint name: Create and Link Jira Ticket to Finding - POST /api/v1/client/{clientId}/report/{reportId}/flaw/{findingId}/createAndLinkJiraTicket

Context: The Jira integration has been updated to follow a new integration framework pattern. This includes a new set of API endpoints that will follow the pattern for all future integrations.

Replacements: Create Jira Ticket from Findings

Deprecated endpoint name: Bulk Create and Link Jira Tickets to Findings - POST /api/v2/client/{clientId}/report/{reportId}/findings/createJiraTickets

Context: The Jira integration has been updated to follow a new integration framework pattern. This includes a new set of API endpoints that will follow the pattern for all future integrations.

Replacements: Create Jira Ticket from Findings

Summary: This change has been carefully designed to enhance your experience by speeding up the delivery of a more concise data set. We are proactively contacting you to ensure that there will be no data disruption on your account.

Details:

Get Finding API Functionality: The Get Finding endpoint returns the finding information about the finding and related affected assets. The standard use case for this endpoint is to gather data relevant to the finding of the findingId specified in the request. Currently, the returned affected asset information also references relational data to other findings not specified in the request.

What's changing: This update modifies the data that will be returned using the Get Finding endpoint. We have increased performance and security by maintaining the findings and related assets and excluding the third level of data (data for every other finding related to each affected asset in the requested finding) in the returned data set. If you were using the Get Finding endpoint to access these findings related to an asset, please see the recommended routes below.

Routes for Accessing Findings Related to an Asset: We understand that you might have specific requirements for other data needed. To address this, we have existing designated routes to get you access to findings related to an asset. The Get Asset route will retrieve a single record, or for multiple records in a single request, use the List Client Assets route.

Impacted Endpoints:

• Get Finding - GET /api/v1/client/{{clientId}}/report/{{reportId}}/flaw/{{findingId}}

Summary: Replaces the randomly generated roleID with set values.

Details: Currently, the admin, standard, and analyst roleID are randomly generated when the tenancy is created. In the future, this will be a standard set value. Users must locate all occurrences of this variable and update the endpoint.

For example, with the admin role, change /api/v2/tenants/0/security/role/cl75q1auk00040yoff389h206 (random roleID value) to /api/v2/tenants/0/security/role/cljhc9ggj000008l99gkyai90 (the new standard value).

Release 1.58 will implement this modification, supporting the legacy and the new solution. Release 1.59 will no longer provide support for the legacy method.

The new set ID values for each default RBAC role are listed below.

• ADMIN: cljhc9ggj000008l99gkyai90

• STD_USER: cljhc9rvn000208l9g4lpai54

• ANALYST: cljhc9yh1000308l9ar7j8mux

Impacted Endpoints:

• GET /api/v2/tenants/{tenantId}/security/role/{roleId}

• PUT /api/v2/tenants/{tenantId}/security/role/{roleId}/info

• PUT /api/v2/tenants/{tenantId}/security/role/{roleId}/permissions

• PUT /api/v2/tenants/{tenantId}/security/role/{roleId}/users

• DELETE /api/v2/tenants/{tenantId}/security/role/{roleId}/users/{userId}

• DELETE /api/v2/tenants/{tenantId}/security/role/{roleId}