-
-
Notifications
You must be signed in to change notification settings - Fork 603
/
Copy pathrest-api.md
24 lines (17 loc) · 1007 Bytes
/
rest-api.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
---
title: REST API
category: Integrations
chapter: 6
order: 8
---
Dependency-Track is built using a *thin server architecture* and an *API-first design*. APIs are simply at the heart
of the platform. Every API is fully documented via OpenAPI v3.
> http://{hostname}:{port}/api/openapi.json
> http://{hostname}:{port}/api/openapi.yaml
**Note:** The OpenAPI endpoints are only available on the backend server, not on the frontend server.
If you run Dependency Track with the default Docker Compose file, this is port `8081` and *not* port `8080`.
The Swagger UI Console (not included) can be used to visualize and explore the wide range of possibilities. Chrome and
Firefox extensions can be used to quickly use the Swagger UI Console.
Prior to using the REST APIs, an API Key must be generated. By default, creating a team will NOT create an API key. A team may have multiple keys.
