For the base URL, authentication and errors, see the REST API overview.
GET /openapi.json
- Request: GET /openapi.json
- Operation: ReadServerApi
- Operation ID:
Server_ReadApiOpenapi.json - Authentication: none, public operation
Example request
bash
curl 'https://YOUR_SERVER/openapi.json'Responses
| Status | Description |
|---|---|
| 200 | ok |
GET /v1/server/actions
- Request: GET /v1/server/actions
- Operation: ReadServerActions
- Operation ID:
Server_ReadActions - Authentication: access token,
Authorization: Bearer YOUR_TOKEN
Example request
bash
curl 'https://YOUR_SERVER/v1/server/actions' \
-H 'Authorization: Bearer YOUR_TOKEN'Responses
| Status | Description |
|---|---|
| 200 | ok |
| 401 | unauthorized |
| 403 | forbidden |
GET /v1/server/assets
- Request: GET /v1/server/assets
- Operation: ReadServerAssets
- Operation ID:
Server_ReadAssets - Authentication: none, public operation
Example request
bash
curl 'https://YOUR_SERVER/v1/server/assets'Responses
| Status | Description |
|---|---|
| 200 | ok |
GET /v1/server/buckets/backends
- Request: GET /v1/server/buckets/backends
- Operation: ReadServerBucketsBackends
- Operation ID:
Server_ReadBucketsBackends - Authentication: none, public operation
Example request
bash
curl 'https://YOUR_SERVER/v1/server/buckets/backends'Responses
| Status | Description |
|---|---|
| 200 | ok |
GET /v1/server/events
- Request: GET /v1/server/events
- Operation: ReadServerEvents
- Operation ID:
Server_ReadEvents - Authentication: none, public operation
Example request
bash
curl 'https://YOUR_SERVER/v1/server/events'Responses
| Status | Description |
|---|---|
| 200 | ok |
GET /v1/server/healthcheck
- Request: GET /v1/server/healthcheck
- Operation: ReadServerHealthcheck
- Operation ID:
Server_ReadHealthcheck - Authentication: none, public operation
Example request
bash
curl 'https://YOUR_SERVER/v1/server/healthcheck'Responses
| Status | Description |
|---|---|
| 200 | ok |
GET /v1/server/settings
- Request: GET /v1/server/settings
- Operation: ReadServerSettings
- Operation ID:
Server_ReadSettings - Authentication: access token,
Authorization: Bearer YOUR_TOKEN
Example request
bash
curl 'https://YOUR_SERVER/v1/server/settings' \
-H 'Authorization: Bearer YOUR_TOKEN'Responses
| Status | Description |
|---|---|
| 200 | ok |
| 401 | unauthorized |
| 403 | forbidden |
GET /v1/server/statistics
- Request: GET /v1/server/statistics
- Operation: ReadServerStatistics
- Operation ID:
Server_ReadStatistics - Authentication: access token,
Authorization: Bearer YOUR_TOKEN
Example request
bash
curl 'https://YOUR_SERVER/v1/server/statistics' \
-H 'Authorization: Bearer YOUR_TOKEN'Responses
| Status | Description |
|---|---|
| 200 | ok |
| 401 | unauthorized |
| 403 | forbidden |
GET /v1/server/swagger.json
- Request: GET /v1/server/swagger.json
- Operation: ReadServerApi
- Operation ID:
Server_ReadApiSwagger.json - Authentication: none, public operation
Example request
bash
curl 'https://YOUR_SERVER/v1/server/swagger.json'Responses
| Status | Description |
|---|---|
| 200 | ok |
GET /v1/server/version
- Request: GET /v1/server/version
- Operation: ReadServerVersion
- Operation ID:
Server_ReadVersion - Authentication: access token,
Authorization: Bearer YOUR_TOKEN
Example request
bash
curl 'https://YOUR_SERVER/v1/server/version' \
-H 'Authorization: Bearer YOUR_TOKEN'Responses
| Status | Description |
|---|---|
| 200 | ok |
| 401 | unauthorized |
| 403 | forbidden |