Types of namespaces
The Reblaze API includes over a dozen namespaces, each containing a number of routes.
Each namespace has its own page in the documentation, listing all its routes, their parameters, and so on. These pages can be accessed in the left sidebar, in the Namespace reference section.
The namespace pages are intended to act as a reference. They assume that you're already familiar with how to use the API, which is explained here Using the Product / The Reblaze API.
Also, by default, every Reblaze planet includes a Swagger UI instance that offers this same namespace information. However, the Swagger instance also provides additional interactive features, such as automatically building curl commands, submitting API calls directly, and more. Read more about this.
Below is a general guide to the namespaces, showing the type of functionality each one provides. The namespaces can be organized into three broad categories:
Security settings
Site-related settings
Other capabilities
Security settings
| API namespace | Full discussion of these settings in the UI |
|---|---|
Site-related settings
| API namespace | Comments |
|---|---|
For managing the services Reblaze is protecting. More info | |
For managing SSL certificates. More info | |
For running custom Lua code. More info | |
For managing SSL associated with load balancers. More info | |
For managing architectural parameters. More info | |
For managing site-level properties. More info |
Other capabilities
| API namespace | Comments |
|---|---|
For managing configurations, the fundamental internal data structure | |
For API access to traffic data and managing quarantined traffic sources | |
For planet-level settings such as interactive challenges | |
For retrieval of tag data | |
For miscellaneous capabilities, including publishing | |
For management of users and API keys |
Last updated