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:
title: OWASP Dependency-Track System Capabilities API
description: '# REST API of OWASP Dependency-Track
## Pagination
This API implements token-based pagination.'
contact:
name: The Dependency-Track Authors
url: https://github.com/DependencyTrack/dependency-track
email: dependencytrack@owasp.org
license:
name: Apache-2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
version: 2.0.0
servers:
- url: /api/v2
security:
- apiKeyAuth: []
- bearerAuth: []
tags:
- name: System Capabilities
description: Endpoints exposing the capabilities of the running server
paths:
/internal/system-capabilities:
get:
tags:
- System Capabilities
summary: Get system capabilities
description: Returns the capabilities of the system.
operationId: getSystemCapabilities
responses:
'200':
description: System capabilities
content:
application/json:
schema:
$ref: '#/components/schemas/system-capabilities-response'
'401':
$ref: '#/components/responses/generic-unauthorized-error'
default:
$ref: '#/components/responses/generic-error'
components:
responses:
generic-error:
description: Unexpected error
content:
application/problem+json:
schema:
$ref: '#/components/schemas/problem-details'
generic-unauthorized-error:
description: Unauthorized
content:
application/problem+json:
schema:
$ref: '#/components/schemas/problem-details'
example:
type: about:blank
status: 401
title: Unauthorized
detail: Not authorized to access the requested resource.
schemas:
system-capabilities-response:
required:
- capabilities
type: object
properties:
capabilities:
type: object
additionalProperties:
type: object
additionalProperties: true
description: Map of namespaces to capability flags.
example:
capabilities:
secret_management:
read_only: false
problem-details:
required:
- detail
- title
- type
type: object
properties:
type:
type: string
description: A URI reference that identifies the problem type
format: uri-reference
default: about:blank
status:
maximum: 599
minimum: 400
type: integer
description: HTTP status code generated by the origin server for this occurrence of the problem
format: int32
example: 500
title:
maxLength: 255
type: string
description: Short, human-readable summary of the problem type
detail:
maxLength: 1024
type: string
description: Human-readable explanation specific to this occurrence of the problem
instance:
type: string
description: Reference URI that identifies the specific occurrence of the problem
format: uri-reference
description: An RFC 9457 problem object.
externalDocs:
url: https://www.rfc-editor.org/rfc/rfc9457.html
x-parent: true
securitySchemes:
apiKeyAuth:
type: apiKey
description: Authentication via API key.
name: X-Api-Key
in: header
bearerAuth:
type: http
description: 'Authentication via opaque server-issued session token.
Tokens are obtained from `POST /api/v1/user/login`,
`POST /api/v1/user/oidc/login`, or `POST /api/v2/oauth/token`.'
scheme: bearer
bearerFormat: Opaque