Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
contact:
name: The Dependency-Track Authors
url: https://github.com/DependencyTrack/dependency-track
description: 'REST API of OWASP Dependency-Track
> **Note:** This API version is in maintenance mode and will be
> superseded by v2, available under `/api/v2`, which follows a
> spec-first approach.'
license:
name: Apache-2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
title: OWASP Dependency-Track Cwe API
version: 1.0.0
servers:
- url: /api
tags:
- name: cwe
paths:
/v1/cwe:
get:
description: Returns a list of all CWEs
operationId: getCwes
parameters:
- description: Case-insensitive substring filter matched against CWE name and CWE-ID.
in: query
name: searchText
schema:
type: string
- description: The page to return. To be used in conjunction with <code>pageSize</code>.
in: query
name: pageNumber
schema:
type: string
default: '1'
- description: Number of elements to return per page. To be used in conjunction with <code>pageNumber</code>.
in: query
name: pageSize
schema:
type: string
default: '100'
- description: Offset to start returning elements from. To be used in conjunction with <code>limit</code>.
in: query
name: offset
schema:
type: string
- description: Number of elements to return per page. To be used in conjunction with <code>offset</code>.
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 <code>sortName</code>.
in: query
name: sortOrder
schema:
type: string
enum:
- asc, desc
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Cwe'
description: A list of all CWEs
headers:
X-Total-Count:
description: The total number of CWEs
schema:
format: integer
style: simple
'401':
description: Unauthorized
security:
- ApiKeyAuth: []
- BearerAuth: []
tags:
- cwe
summary: Get cwes
x-summary-source: derived
/v1/cwe/{cweId}:
get:
operationId: getCwe
parameters:
- description: The CWE ID of the CWE to retrieve
in: path
name: cweId
required: true
schema:
type: integer
format: int32
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Cwe'
description: A CWE matching the provided ID
'401':
description: Unauthorized
'404':
description: The CWE could not be found
security:
- ApiKeyAuth: []
- BearerAuth: []
summary: Returns a specific CWE
tags:
- cwe
components:
schemas:
Cwe:
type: object
properties:
cweId:
type: integer
format: int32
name:
type: string
pattern: ^[\p{IsWhite_Space}\p{L}\p{M}\p{S}\p{N}\p{P}]*$
securitySchemes:
ApiKeyAuth:
description: Authentication via API key.
in: header
name: X-Api-Key
type: apiKey
BearerAuth:
bearerFormat: Opaque
description: 'Authentication via opaque server-issued session token.
Tokens are obtained from `POST /api/v1/user/login` or
`POST /api/v1/user/oidc/login`.'
scheme: bearer
type: http