Dependency Firewall API
Reference for every operation of the firewall API, generated from its OpenAPI schema.
Each operation page shows its parameters, request body, responses, and request samples. The CLI uses the same API.
Product behavior, such as how rules are evaluated or what an upstream is, is explained in the Dependency Firewall docs.
Base URL
Every path except the namespace list is scoped to a namespace ID:
https://eu-sov-1.bytesafecloud.eu/v1/<namespace-id>/...Request samples on the operation pages use this endpoint.
Authentication
Send an access token in the Authorization header:
Authorization: Bearer <access-token>Clients that only support HTTP Basic can send the token as the password instead. Personal and service access tokens both work. See Manage tokens and the tokens reference.
What a token may do depends on its permissions.
Playground
Each operation page has a Try in Playground button. Enter an access token and your namespace ID, send the request from your browser, and read the response next to it. Requests go straight from your browser to the firewall and act on your real namespace, so a delete operation deletes.
The playground keeps the token, namespace ID, and firewall ID in your browser for 8 hours, so you can move from one operation to the next. Forget removes them at once.
Requests and responses
Requests and responses are JSON. An error response carries error, errors, or both, with a message that describes what went wrong.
Sections
| Section | Covers |
|---|---|
| Firewalls | Firewall configurations, their upstreams, and version history |
| Rules and exceptions | The rules a firewall enforces and the exceptions to them |
| Activity | The firewall log and observed packages |
| Teams | Teams and their members |
| License sets | Named sets of licenses that license rules refer to |
| Webhooks | Webhook endpoints |
| Access tokens | Personal and service access tokens |
| Namespaces | The namespaces the caller can access, and who the caller is |
OpenAPI schema
The firewall publishes this API as an OpenAPI 3.1 schema. Use it to generate a client, import the API into your own tools, or check requests against the schema:
https://eu-sov-1.bytesafecloud.eu/schemas/openapi-v1.jsonThe schema is public and needs no access token.
Related
- Reference: CLI, Firewall config, Permissions, Webhooks