Complete reference for the Grimoire REST API.
| Page | What you’ll learn |
|---|---|
| Authentication | How to authenticate against both API planes |
| Management API | Full CRUD reference — applications, environments, secrets, configs |
| Consumer API | Read-only reference — getting secrets and configuration at runtime |
By default the API runs on port 8080:
1
http://localhost:8080
All responses use camelCase JSON. Errors follow the RFC 9457 Problem Details format:
1
2
3
4
5
{
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401
}
| Code | Meaning |
|---|---|
200 OK |
Successful read or update |
201 Created |
Resource created |
204 No Content |
Successful delete |
400 Bad Request |
Validation error (FluentValidation) |
401 Unauthorized |
Missing or invalid credentials |
404 Not Found |
Resource does not exist |
409 Conflict |
Duplicate resource (slug, key, etc.) |
500 Internal Server Error |
Unexpected server error |
The Swagger UI is available in Development environment:
http://localhost:8080/swagger → select “Management API”http://localhost:8080/swagger → select “Consumer API”