To re-parent the project, set parent to an object containing
the new parent's uuid. Omit parent (or set it to
- null) to remove the parent. Providing parent
+ null) to leave the parent unchanged. Providing parent
without a non-null uuid is rejected with 400.
Requires permission PORTFOLIO_MANAGEMENT or PORTFOLIO_MANAGEMENT_UPDATE
@@ -5453,6 +5343,7 @@ paths: - description: The version of the project to query on in: query name: version + required: true schema: type: string responses: @@ -5676,10 +5567,6 @@ paths: $ref: "#/components/schemas/ProblemDetails" description: Access to the requested project is forbidden "404": - content: - application/problem+json: - schema: - $ref: "#/components/schemas/ProblemDetails" description: The UUID of the project could not be found "500": description: Unable to delete components of the project @@ -6850,7 +6737,7 @@ paths: schema: type: array items: - $ref: "#/components/schemas/TagResponse" + $ref: "#/components/schemas/Tag" description: A list of all tags associated with a given policy headers: X-Total-Count: @@ -7501,7 +7388,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/DeleteTeamRequest" + $ref: "#/components/schemas/Team" responses: "204": description: Team removed successfully @@ -7747,52 +7634,8 @@ paths: - team /v1/team/visible: get: - description:Optional query parameter searchText. The search
- is case insensitive and matches team names.
pageSize.
- in: query
- name: pageNumber
- schema:
- type: string
- default: "1"
- - description: Number of elements to return per page. To be used in conjunction
- with pageNumber.
- in: query
- name: pageSize
- schema:
- type: string
- default: "100"
- - description: Offset to start returning elements from. To be used in conjunction
- with limit.
- in: query
- name: offset
- schema:
- type: string
- - description: Number of elements to return per page. To be used in conjunction
- with offset.
- in: query
- name: limit
- schema:
- type: string
- - description: Name of the resource field to sort on.
- in: query
- name: sortName
- schema:
- type: string
- - description: Ordering of items when sorting with sortName.
- in: query
- name: sortOrder
- schema:
- type: string
- enum:
- - "asc, desc"
responses:
"200":
content:
@@ -7802,12 +7645,6 @@ paths:
items:
$ref: "#/components/schemas/VisibleTeams"
description: The Visible Teams
- headers:
- X-Total-Count:
- description: The total number of visible teams
- schema:
- format: integer
- style: simple
"401":
description: Unauthorized
security:
@@ -7915,7 +7752,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/DeleteUserRequest"
+ $ref: "#/components/schemas/LdapUser"
responses:
"204":
description: LDAP user removed successfully
@@ -8045,7 +7882,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/DeleteUserRequest"
+ $ref: "#/components/schemas/ManagedUser"
responses:
"204":
description: User removed successfully
@@ -8184,7 +8021,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/DeleteUserRequest"
+ $ref: "#/components/schemas/OidcUser"
responses:
"204":
description: OIDC user removed successfully
@@ -8306,7 +8143,7 @@ paths:
operationId: updateSelf
requestBody:
content:
- application/json:
+ '*/*':
schema:
$ref: "#/components/schemas/ManagedUser"
responses:
@@ -9644,15 +9481,6 @@ paths:
tags:
- version
components:
- headers:
- TotalCountType:
- description: Whether `X-Total-Count` is exact (`EXACT`) or a lower bound (`AT_LEAST`).
- `AT_LEAST` with a count of 0 means the total is unknown.
- schema:
- type: string
- enum:
- - EXACT
- - AT_LEAST
schemas:
About:
type: object
@@ -9740,8 +9568,7 @@ components:
lastSeen:
type: integer
format: int64
- deprecated: true
- description: Deprecated; always equal to firstSeen
+ description: UNIX epoch timestamp in milliseconds
source:
type: string
enum:
@@ -9753,17 +9580,19 @@ components:
- OSV
- SNYK
- CX
- - JVN
- UNKNOWN
required:
- firstSeen
- lastSeen
- AnalysisRequest:
+ Analysis:
type: object
properties:
+ analysisComments:
+ type: array
+ items:
+ $ref: "#/components/schemas/AnalysisComment"
analysisDetails:
type: string
- pattern: "^[\\p{IsWhite_Space}\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\n\\r\\t]*$"
analysisJustification:
type: string
enum:
@@ -9795,40 +9624,60 @@ components:
- NOT_AFFECTED
- RESOLVED
- NOT_SET
- comment:
+ cvssV2Score:
+ type: number
+ cvssV2Vector:
type: string
- pattern: "^[\\p{IsWhite_Space}\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\n\\r\\t]*$"
- component:
+ cvssV3Score:
+ type: number
+ cvssV3Vector:
+ type: string
+ cvssV4Score:
+ type: number
+ cvssV4Vector:
type: string
- pattern: "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
isSuppressed:
type: boolean
- writeOnly: true
- project:
+ owaspScore:
+ type: number
+ owaspVector:
type: string
- pattern: "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
- suppressed:
- type: boolean
- vulnerability:
+ severity:
type: string
- pattern: "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
+ enum:
+ - CRITICAL
+ - HIGH
+ - MEDIUM
+ - LOW
+ - INFO
+ - UNASSIGNED
required:
- - component
- - vulnerability
- AnalysisTrailResponse:
+ - analysisDetails
+ - analysisJustification
+ - analysisResponse
+ - analysisState
+ AnalysisComment:
+ type: object
+ properties:
+ comment:
+ type: string
+ commenter:
+ type: string
+ timestamp:
+ type: integer
+ format: int64
+ description: UNIX epoch timestamp in milliseconds
+ required:
+ - comment
+ - timestamp
+ AnalysisRequest:
type: object
properties:
- analysisComments:
- type: array
- description: Audit trail of analysis comments
- items:
- $ref: "#/components/schemas/Comment"
analysisDetails:
type: string
- description: Free-form details of the analysis decision
+ pattern: "^[\\p{IsWhite_Space}\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\n\\r\\t]*$"
analysisJustification:
type: string
- description: The justification of the analysis decision
enum:
- CODE_NOT_PRESENT
- CODE_NOT_REACHABLE
@@ -9842,7 +9691,6 @@ components:
- NOT_SET
analysisResponse:
type: string
- description: The vendor response to the vulnerability
enum:
- CAN_NOT_FIX
- WILL_NOT_FIX
@@ -9852,7 +9700,6 @@ components:
- NOT_SET
analysisState:
type: string
- description: The state of the analysis decision
enum:
- EXPLOITABLE
- IN_TRIAGE
@@ -9860,47 +9707,26 @@ components:
- NOT_AFFECTED
- RESOLVED
- NOT_SET
- cvssV2Score:
- type: number
- description: CVSS v2 score assigned by the analysis
- cvssV2Vector:
- type: string
- description: CVSS v2 vector assigned by the analysis
- cvssV3Score:
- type: number
- description: CVSS v3 score assigned by the analysis
- cvssV3Vector:
+ comment:
type: string
- description: CVSS v3 vector assigned by the analysis
- cvssV4Score:
- type: number
- description: CVSS v4 score assigned by the analysis
- cvssV4Vector:
+ pattern: "^[\\p{IsWhite_Space}\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\n\\r\\t]*$"
+ component:
type: string
- description: CVSS v4 vector assigned by the analysis
+ pattern: "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
isSuppressed:
type: boolean
- description: Whether the finding is suppressed
- owaspScore:
- type: number
- description: OWASP Risk Rating score assigned by the analysis
- owaspVector:
+ writeOnly: true
+ project:
type: string
- description: OWASP Risk Rating vector assigned by the analysis
- severity:
+ pattern: "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
+ suppressed:
+ type: boolean
+ vulnerability:
type: string
- description: Severity assigned by the analysis
- enum:
- - CRITICAL
- - HIGH
- - MEDIUM
- - LOW
- - INFO
- - UNASSIGNED
+ pattern: "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
required:
- - analysisComments
- - analysisState
- - isSuppressed
+ - component
+ - vulnerability
ApiKey:
type: object
properties:
@@ -9933,7 +9759,6 @@ components:
type: boolean
bom:
type: string
- format: bytes
description: Base64 encoded BOM
example: ewogICJib21Gb3JtYXQiOiAiQ3ljbG9uZURYIiwKICAic3BlY1ZlcnNpb24iOiAiMS40IiwKICAiY29tcG9uZW50cyI6IFsKICAgIHsKICAgICAgInR5cGUiOiAibGlicmFyeSIsCiAgICAgICJuYW1lIjogImFjbWUtbGliIiwKICAgICAgInZlcnNpb24iOiAiMS4wLjAiCiAgICB9CiAgXQp9
pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"
@@ -10120,7 +9945,6 @@ components:
type: array
items:
type: string
- format: uuid
uniqueItems: true
description:
type: string
@@ -10728,17 +10552,6 @@ components:
- name
- publisher
- scope
- CreateOidcGroupRequest:
- type: object
- properties:
- name:
- type: string
- description: Name of the group to create
- maxLength: 255
- minLength: 1
- pattern: "[\\P{Cc}]+"
- required:
- - name
CreatePolicyConditionRequest:
type: object
properties:
@@ -10954,15 +10767,6 @@ components:
- UNKNOWN
name:
type: string
- DeleteNotificationRuleRequest:
- type: object
- properties:
- uuid:
- type: string
- format: uuid
- description: UUID of the notification rule to delete
- required:
- - uuid
DeleteProjectPropertyRequest:
type: object
properties:
@@ -10981,24 +10785,6 @@ components:
required:
- groupName
- propertyName
- DeleteTeamRequest:
- type: object
- properties:
- uuid:
- type: string
- format: uuid
- description: UUID of the team to delete
- required:
- - uuid
- DeleteUserRequest:
- type: object
- properties:
- username:
- type: string
- description: Username of the user to delete
- minLength: 1
- required:
- - username
DependencyGraphResponse:
type: object
properties:
@@ -11253,16 +11039,6 @@ components:
properties:
processing:
type: boolean
- status:
- type: string
- description: The processing status associated with the token. Null when
- no processing is associated with the token.
- enum:
- - PENDING
- - RUNNING
- - COMPLETED
- - FAILED
- nullable: true
required:
- processing
LdapUser:
@@ -11282,10 +11058,6 @@ components:
type: array
items:
$ref: "#/components/schemas/Permission"
- teams:
- type: array
- items:
- $ref: "#/components/schemas/Team"
username:
type: string
maxLength: 255
@@ -11609,19 +11381,6 @@ components:
required:
- dn
- team
- MappedLdapGroupResponse:
- type: object
- properties:
- dn:
- type: string
- description: Distinguished name of the mapped LDAP group
- uuid:
- type: string
- format: uuid
- description: UUID of the mapping
- required:
- - dn
- - uuid
MappedOidcGroup:
type: object
properties:
@@ -11644,18 +11403,6 @@ components:
required:
- group
- team
- MappedOidcGroupResponse:
- type: object
- properties:
- group:
- $ref: "#/components/schemas/OidcGroupResponse"
- uuid:
- type: string
- format: uuid
- description: UUID of the mapping
- required:
- - group
- - uuid
NotificationPublisher:
type: object
properties:
@@ -11845,19 +11592,6 @@ components:
required:
- name
- uuid
- OidcGroupResponse:
- type: object
- properties:
- name:
- type: string
- description: Name of the group
- uuid:
- type: string
- format: uuid
- description: UUID of the group
- required:
- - name
- - uuid
OidcUser:
type: object
properties:
@@ -11866,19 +11600,11 @@ components:
maxLength: 255
minLength: 0
pattern: "[\\P{Cc}]+"
- permissions:
- type: array
- items:
- $ref: "#/components/schemas/Permission"
subjectIdentifier:
type: string
maxLength: 255
minLength: 1
pattern: "[\\P{Cc}]+"
- teams:
- type: array
- items:
- $ref: "#/components/schemas/Team"
username:
type: string
maxLength: 255
@@ -11952,8 +11678,6 @@ components:
type: boolean
includeChildren:
type: boolean
- invertTagMatch:
- type: boolean
name:
type: string
maxLength: 255
@@ -12851,14 +12575,6 @@ components:
- detail
- status
- title
- TagResponse:
- type: object
- properties:
- name:
- type: string
- description: Name of the tag
- required:
- - name
TaggedCollectionProjectListResponseItem:
type: object
properties:
@@ -13232,22 +12948,6 @@ components:
- name
- scope
- uuid
- UpdateOidcGroupRequest:
- type: object
- properties:
- name:
- type: string
- description: New name of the group
- maxLength: 255
- minLength: 1
- pattern: "[\\P{Cc}]+"
- uuid:
- type: string
- format: uuid
- description: UUID of the group to update
- required:
- - name
- - uuid
UpdatePolicyConditionRequest:
type: object
properties:
diff --git a/docs/reference/api/openapi-v2.yaml b/docs/reference/api/openapi-v2.yaml
index 8dd3a10a..6f3cb81c 100644
--- a/docs/reference/api/openapi-v2.yaml
+++ b/docs/reference/api/openapi-v2.yaml
@@ -76,10 +76,6 @@ info:
}
```
- A request that takes too long to complete is aborted and rejected
- with `504 Gateway Timeout`. Any operation can time out, so operations
- do not document it individually.
-
## Authentication
Two credential types are accepted:
@@ -175,8 +171,6 @@ tags:
description: Endpoints related to components
- name: Extensions
description: Endpoints related to extensions
-- name: Kev Data Sources
- description: Endpoints related to KEV data sources
- name: Projects
description: Endpoints related to projects
- name: Secrets
@@ -665,89 +659,6 @@ paths:
$ref: "#/components/responses/generic-not-found-error"
default:
$ref: "#/components/responses/generic-error"
- /kev-data-sources/{name}/mirror-runs:
- post:
- tags:
- - Kev Data Sources
- summary: Trigger a KEV data source mirror run
- description: |-
- Triggers a mirror run for the given KEV data source.
-
- Requires permission `SYSTEM_CONFIGURATION` or `SYSTEM_CONFIGURATION_UPDATE`.
- operationId: triggerKevDataSourceMirrorRun
- parameters:
- - name: name
- in: path
- description: "Name of the KEV data source (e.g. `cisa`, `enisa`)."
- required: true
- schema:
- type: string
- responses:
- "202":
- description: Mirror run triggered
- headers:
- Location:
- description: URL of the latest mirror run resource.
- schema:
- type: string
- format: uri
- "400":
- description: Mirror run cannot be started
- content:
- application/problem+json:
- schema:
- $ref: "#/components/schemas/problem-details"
- "401":
- $ref: "#/components/responses/generic-unauthorized-error"
- "403":
- $ref: "#/components/responses/generic-forbidden-error"
- "404":
- $ref: "#/components/responses/generic-not-found-error"
- "409":
- description: A mirror run is already in progress
- content:
- application/problem+json:
- schema:
- $ref: "#/components/schemas/problem-details"
- default:
- $ref: "#/components/responses/generic-error"
- /kev-data-sources/{name}/mirror-runs/latest:
- get:
- tags:
- - Kev Data Sources
- summary: Get the latest KEV data source mirror run
- description: |-
- Returns the status of the most recent mirror run for a given
- KEV data source.
-
- Returns 404 if no mirror run is available
- (e.g. none has been triggered yet, or the most recent run
- is no longer retained), or if the data source is unknown.
-
- Requires permission `SYSTEM_CONFIGURATION` or `SYSTEM_CONFIGURATION_READ`.
- operationId: getLatestKevDataSourceMirrorRun
- parameters:
- - name: name
- in: path
- description: "Name of the KEV data source (e.g. `cisa`, `enisa`)."
- required: true
- schema:
- type: string
- responses:
- "200":
- description: Mirror run status
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/kev-data-source-mirror-status"
- "401":
- $ref: "#/components/responses/generic-unauthorized-error"
- "403":
- $ref: "#/components/responses/generic-forbidden-error"
- "404":
- $ref: "#/components/responses/generic-not-found-error"
- default:
- $ref: "#/components/responses/generic-error"
/projects/{uuid}/clone:
post:
tags:
@@ -2184,26 +2095,6 @@ components:
type: array
items:
$ref: "#/components/schemas/extension-test-check"
- kev-data-source-mirror-status:
- required:
- - status
- type: object
- properties:
- status:
- type: string
- description: Status of the mirror run.
- enum:
- - PENDING
- - RUNNING
- - COMPLETED
- - FAILED
- started_at:
- $ref: "#/components/schemas/timestamp"
- completed_at:
- $ref: "#/components/schemas/timestamp"
- failure_reason:
- type: string
- description: Reason for why the mirror run failed.
clone-project-request:
required:
- version
@@ -2836,16 +2727,12 @@ components:
list-extensions-response-item:
required:
- configurable
- - display_name
- name
- testable
type: object
properties:
name:
type: string
- display_name:
- type: string
- description: Human-readable name of the extension.
configurable:
type: boolean
description: Whether the extension supports runtime configuration.
@@ -3110,7 +2997,6 @@ components:
kev-assertion:
required:
- asserter
- - asserter_display_name
- created_at
- updated_at
- vuln_id
@@ -3120,10 +3006,7 @@ components:
asserter:
type: string
description: "The entity that asserted the vulnerability is known to be\
- \ exploited (e.g. `cisa`, `enisa`)."
- asserter_display_name:
- type: string
- description: Human-readable name of the asserting entity (e.g. `CISA KEV`).
+ \ exploited (e.g. `CISA`, `ENISA`)."
vuln_source:
type: string
description: Source of the asserted vulnerability identifier (e.g. `NVD`).