API Release 2.0.0-beta.8 - 27-06-2024

Added endpoints

Issue tracker profiles

GET /api/v2/issue-tracker-profiles/summary

• Retrieves all the issue tracker profiles available to be used as the default issue tracker profile.

Libraries

GET /api/v2/libraries/threats/summary

• Gets the summary threat list in a library context.

GET /api/v2/libraries/weaknesses/summary

• Gets the list of weakness summaries in the system.

GET /api/v2/libraries/countermeasures/summary

• Gets the list of countermeasure summaries in a library.

Projects

GET /api/v2/projects/reports/{report-id}/content

• Gets the report content.

Standards

POST /api/v2/standards/{standard-id}/analytics/compliance/summary/query

• Get a compliance summary for a specific standard.

Templates

GET /api/v2/templates/{template-id}/diagram/metadata

• Provides a template's diagram metadata.

GET /api/v2/templates/{template-id}/diagram/metadata/components

• Gets the weakness test distribution of a template.

GET /api/v2/templates/{template-id}/diagram/metadata/trust-zones

• Provides the trustzones from a template's diagram metadata.

GET /api/v2/templates/{template-id}/diagram/metadata/categories

• Provides the categories from a template's diagram metadata.

GET /api/v2/templates/{template-id}/diagram/metadata/components/{component-id}/risk-patterns

• Provides the risk patterns of a component from the metadata of a template diagram.

Removed endpoints

Issue tracker profiles

GET /api/v2/issue-tracker-profiles/assignable

• Retrieves all the issue tracker profiles available to be used as the default issue tracker profile.

Projects

GET /api/v2/projects/countermeasures/assignable-issue-tracker-profiles

• Retrieves all the issue tracker profiles available to be assigned to countermeasures.

GET /api/v2/projects/assignable-issue-tracker-profiles

• Retrieves all the issue tracker profiles available to be assigned to projects.

GET /api/v2/projects/components/assignable-issue-tracker-profiles

• Retrieves all the issue tracker profiles available to be assigned to components.

GET /api/v2/projects/threats/assignable-issue-tracker-profiles

• Retrieves all the issue tracker profiles available to be assigned to threats.

GET /api/v2/projects/weaknesses/assignable-issue-tracker-profiles

• Retrieves all the issue tracker profiles available to be assigned to weaknesses.

Changed parameters

PUT /api/v2/templates/{template-id}/diagram/content

• The parameter

  keepState

  has been added.

GET /api/v2/issue-tracker-profiles

• The parameter

  filter

  has been added.

• The parameter

  size

  has been added.

• The parameter

  page

  has been added.

• The parameter

  sort

  has been added.

PUT /api/v2/projects/{project-id}/diagram/content

• The parameter

  keepState

  has been added.

Changed request bodies

PUT /api/v2/templates/countermeasures/{countermeasure-id}

• The property

  state

  has been removed.

POST /api/v2/projects/countermeasures/analytics/states/implemented/timeline/query

• The property

  filters

  has been added.

• The property

  filter

  has been removed.

PUT /api/v2/projects/countermeasures/{countermeasure-id}

• The property

  state

  has been removed.

PUT /api/v2/issue-tracker-profiles/settings

• The property

  closeIssueWhenWeaknessTestPass

  is now required.

• The property

  createIssuesWhenWeaknessTestFail

  is now required.

• The property

  defaultProfile

  is now required.

• The property

  synchronizationInterval

  is now required.

PUT /api/v2/features/settings

• The property

  enableModelWithAi

  has been added.

API Specification

• 2.0.0-beta.8