This policy establishes a transparent and standardized process for removing API endpoints from the PlexTrac API while minimizing user disruption. By providing timely notification and support, we aim to facilitate a smooth transition for those who rely on these endpoints in their integrations with our platform.
PlexTrac values its customers and recognizes the importance of informing and assisting them with API endpoint removals. Their policy aims to minimize any negative impact and ensure a smooth transition.
Before removing any API endpoint, provide at least 90 days' notice on the API Change Log page. The notification will include the following:
The release in which the API endpoint will be removed
The endpoint being removed
Replacement endpoint(s), when applicable
Per the notification, the API endpoint will be eliminated from the codebase on the scheduled deployment date. PlexTrac will closely observe the effects of this action on their customers and will be ready to provide support in case any problems arise.
Users can view which endpoints will be impacted on the page to provide ample time and warning for affected users to transition to an alternative solution. Users may need to update their code, adjust settings, or search for a different endpoint. Staying up-to-date with API changes is essential to ensure the proper functioning of applications.
Deprecation refers to the process of phasing out or discontinuing an API. This means that the API will no longer be supported by PlexTrac, even though it may still be operational.
Sunsetting means that the API will be removed and not function.
Breaking Changes are modifications that render current solutions ineffective, causing existing code or integrations to fail or produce incorrect results, even if the endpoint itself is not changing.
These APIs will be removed from the codebase on the posted Sunset Date. Additional details for each API can be found in the summary table below.
*The 2.0 release will be rolled out in multiple phases. Cloud-hosted instances will begin on November 29th and continue through December, while on-premise customers will have access on January 2nd.
This section includes modifications in an API update incompatible with the previous version, potentially causing existing code or integrations to fail. Breaking changes can involve the removal of functionality, modification of behavior, changes in response structure or input requirements, and altering data types or values.
API | Route | Deprecation Date | Sunset Date - Release |
---|---|---|---|
API | Route | Change | Change Date - Release |
---|---|---|---|
GET /api/v1/clients/analytics/export
April 6, 2023 - 1.51
GET /api/v1/flaws
April 6, 2023 - 1.51
Get Client Flaws
GET /api/v1/client/{clientID}/topFlaws
April 6, 2023 - 1.51
Get Multiple Client Flaws
POST /api/v1/clients/topFlaws
April 6, 2023 - 1.51
GET /api/v1/clients/findings
April 6, 2023 - 1.51
Get Analytics Bootstrap Findings
GET /api/v1/clients/analytics/bootstrap
May 8, 2023 - 1.53
GET /api/v1/client/{clientID}/analytics/flaws/aging
February 24, 2023
May 30, 2023 - 1.54
GET /api/v1/client/{clientID}/analytics/flaws/{status}
February 24, 2023
May 30, 2023 - 1.54
GET /api/v1/tenant/analytics
February 24, 2023
May 30, 2023 - 1.54
GET /api/v1/tenant/analytics/findings/{status}
February 24, 2023
May 30, 2023 - 1.54
GET /api/v1/client/{clientID}/analytics
February 24, 2023
May 30, 2023 - 1.54
Retrieve Analytics Assets - Suggestion
POST /api/v2/clients/analytics/assets/suggestion
June 7, 2023
September 13, 2023 - 1.59
Import Client Assets v1
POST /api/v1/client/{clientId}/assets/import/{{source}}
August 15, 2022
November 7, 2023 - 1.61
Get Affected Assets by Finding
GET/api/v2/clients/{clientId}/reports/{reportId}/flaws/{flawId}/affected_assets
October 18, 2023
January 2, 2024 - 2.0*
Add Findings from File Imports
POST /api/v1/client/{clientId}/report/{reportId}/import/{source}
October 31, 2023
February 21, 2024 - 2.2
Bulk Get Evidence
POST /api/v2/tenant/{{tenantId}}/client/{{clientId}}/report/{{reportId}}/finding/{{findingId}}/asset/evidence
November 27, 2023
January 30, 2024 - 2.1
Get Security Role
GET /api/v2/tenants/{tenantId}/security/role/{roleId}
Update RBAC ID Values
August 21, 2023 - 1.58
Update Security Role Info
PUT /api/v2/tenants/{tenantId}/security/role/{roleId}/info
Update RBAC ID Values
August 21, 2023 - 1.58
Update Security Role Permission
PUT /api/v2/tenants/{tenantId}/security/role/{roleId}/permissions
Update RBAC ID Values
August 21, 2023 - 1.58
Add Role User
PUT /api/v2/tenants/{tenantId}/security/role/{roleId}/users
Update RBAC ID Values
August 21, 2023 - 1.58
Remove Role User
DELETE /api/v2/tenants/{tenantId}/security/role/{roleId}/users/{userId}
Update RBAC ID Values
August 21, 2023 - 1.58
Delete Security Role
DELETE /api/v2/tenants/{tenantId}/security/role/{roleId}
Update RBAC ID Values
August 21, 2023 - 1.58
Get Finding
GET /api/v1/client/{{clientId}}/report/{{reportId}}/flaw/{{findingId}}
Decouple Finding/Assets
November 7, 2023 - 1.61