Base API Endpoints
API Status Check
Get information about API status and versions.
Request
GET /api/statusHeaders
| Name | Type | Description |
|---|---|---|
| X-API-Key | string | Required. API key |
Response
{
"message": "Welcome to Flute CMS API",
"flute_version": "1.0.0",
"api_version": "1.0.0"
}| Field | Type | Description |
|---|---|---|
| message | string | Welcome message |
| flute_version | string | Flute CMS version |
| api_version | string | API version |
Response Codes
| Code | Description |
|---|---|
| 200 | Successful request |
| 401 | Invalid or missing API key |
| 403 | Insufficient permissions to perform request |
Get Current API Key Permissions
Get the list of permissions for the current API key.
Request
GET /api/permissionsHeaders
| Name | Type | Description |
|---|---|---|
| X-API-Key | string | Required. API key |
Response
{
"permissions": [
{
"id": 1,
"name": "admin.users",
"description": "User management"
},
{
"id": 2,
"name": "admin.roles",
"description": "Role management"
}
]
}| Field | Type | Description |
|---|---|---|
| permissions | array | Array of permissions |
| id | integer | Permission ID |
| name | string | Permission name |
| description | string | Permission description |
Response Codes
| Code | Description |
|---|---|
| 200 | Successful request |
| 401 | Invalid or missing API key |