API Release 2.0.0-beta.10 - 22-08-2024

Added endpoints

Components

GET /api/v2/components/categories/{category-id}

• Gets the component category

POST /api/v2/components/categories/{category-id}/visibility/business-units

• Shares a component category with a new business unit.

PUT /api/v2/components/categories/{category-id}

• Modifies the component category

GET /api/v2/components/categories/{category-id}/visibility/business-units

• Gets the list of business units with whom a component category is shared.

DELETE /api/v2/components/categories/{category-id}/visibility/business-units/{business-unit-id}

• Stops sharing a component category with a specific business unit.

Projects

POST /api/v2/projects/{project-id}/workflow-states/{workflow-state-id}

• Update the workflow state of a project.

POST /api/v2/projects/versions/compare/changes

• Compare two project versions of the same project and returns a list of changes.

Tags

DELETE /api/v2/tags/{tag-id}

• Deletes a tag.

Templates

POST /api/v2/templates/use-cases/create-general

• Create a use case into the general component.

Users

POST /api/v2/users/reset-password/{reset-password-token-id}/validate

• Validates a given reset password token.

POST /api/v2/users/reset-password-email/send

• Sends an email with a link to reset the password of a user.

POST /api/v2/users/reset-password/{reset-password-token-id}/reset

• Resets the password of a user.

Changed request bodies

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

• The property

  customFields

  is now required.

• The property

  description

  is now required.

• The property

  edited

  is now required.

POST /api/v2/templates/countermeasures

• The property

  customFields

  is now required.

• The property

  description

  is now required.

• The property

  edited

  is now required.

PUT /api/v2/projects/countermeasures/standard-references/{standard-reference-id}

• The property

  reference

  is now required.

POST /api/v2/templates/countermeasures/standard-references

• The property

  reference

  is now required.

POST /api/v2/projects/countermeasures

• The property

  customFields

  is now required.

• The property

  description

  is now required.

• The property

  edited

  is now required.

• The property

  issueId

  is now required.

POST /api/v2/templates/weaknesses

• The property

  description

  is now required.

PUT /api/v2/projects/weaknesses/{weakness-id}

• The property

  description

  is now required.

• The property

  issueId

  is now required.

POST /api/v2/templates/threats

• The property

  customFields

  is now required.

• The property

  description

  is now required.

• The property

  expiryDate

  is now required.

POST /api/v2/custom-views

• The property

  description

  is now required.

PUT /api/v2/templates/countermeasures/standard-references/{standard-reference-id}

• The property

  reference

  is now required.

PUT /api/v2/projects/use-cases/{use-case-id}

• The property

  description

  is now required.

POST /api/v2/projects/countermeasures/standard-references

• The property

  reference

  is now required.

PUT /api/v2/custom-views/{custom-view-id}

• The property

  description

  is now required.

POST /api/v2/projects/threats

• The property

  customFields

  is now required.

• The property

  description

  is now required.

• The property

  expiryDate

  is now required.

• The property

  issueId

  is now required.

PUT /api/v2/projects/weaknesses/tests/{test-id}

• The property

  customFields

  is now required.

• The property

  expiryDate

  is now required.

• The property

  notes

  is now required.

• The property

  steps

  is now required.

PUT /api/v2/templates/weaknesses/{weakness-id}

• The property

  description

  is now required.

PUT /api/v2/templates/weaknesses/tests/{test-id}

• The property

  customFields

  is now required.

• The property

  expiryDate

  is now required.

• The property

  notes

  is now required.

• The property

  steps

  is now required.

POST /api/v2/projects/use-cases

• The property

  description

  is now required.

PUT /api/v2/projects/threats/{threat-id}

• The property

  customFields

  is now required.

• The property

  description

  is now required.

• The property

  expiryDate

  is now required.

• The property

  issueId

  is now required.

• The property

  owner

  is now required.

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

• The property

  customFields

  is now required.

• The property

  description

  is now required.

• The property

  edited

  is now required.

• The property

  issueId

  is now required.

• The property

  owner

  is now required.

POST /api/v2/projects/weaknesses

• The property

  description

  is now required.

• The property

  issueId

  is now required.

PUT /api/v2/templates/countermeasures/tests/{test-id}

• The property

  customFields

  is now required.

• The property

  expiryDate

  is now required.

• The property

  notes

  is now required.

• The property

  steps

  is now required.

POST /api/v2/templates/use-cases

• The property

  description

  is now required.

PUT /api/v2/projects/countermeasures/tests/{test-id}

• The property

  customFields

  is now required.

• The property

  expiryDate

  is now required.

• The property

  notes

  is now required.

• The property

  steps

  is now required.

PUT /api/v2/templates/use-cases/{use-case-id}

• The property

  description

  is now required.

PUT /api/v2/features/settings

• The property

  enableEmbeddedProjects

  has been added.

• The property

  allowedExternalSitesToEmbedProjects

  has been added.

PUT /api/v2/templates/threats/{threat-id}

• The property

  customFields

  is now required.

• The property

  description

  is now required.

• The property

  expiryDate

  is now required.

API Specification

• 2.0.0-beta.10