Instance endpoints
This page is generated from the OpenAPI document of the API (src/Vellum.Web/openapi.json) when the documentation is built.
GET /api/instance
Section titled “GET /api/instance”| Status | Meaning | Body |
|---|---|---|
200 |
OK | InstanceInfoResponse |
GET /api/instance/settings
Section titled “GET /api/instance/settings”| Status | Meaning | Body |
|---|---|---|
200 |
OK | InstanceSettingsResponse |
PUT /api/instance/settings
Section titled “PUT /api/instance/settings”Request body (application/json): JsonElement
| Status | Meaning | Body |
|---|---|---|
200 |
OK | InstanceSettingsResponse |
400 |
Bad Request | ErrorResponse |
409 |
Conflict | ErrorResponse |
413 |
Payload Too Large | ErrorResponse |
428 |
Precondition Required | ErrorResponse |
GET /api/instance/audit
Section titled “GET /api/instance/audit”| Parameter | In | Type | Required |
|---|---|---|---|
limit |
query | integer (int32) or string (int32) | no |
| Status | Meaning | Body |
|---|---|---|
200 |
OK | array of AuditEntryDto |
POST /api/instance/keys/rotate
Section titled “POST /api/instance/keys/rotate”| Status | Meaning | Body |
|---|---|---|
200 |
OK | RotateKeysResponse |
409 |
Conflict | ErrorResponse |
GET /api/instance/diagnostics
Section titled “GET /api/instance/diagnostics”| Status | Meaning | Body |
|---|---|---|
200 |
OK | DiagnosticsResponse |