Skip to Content
API ReferenceBase API Endpoints

Base API Endpoints

API Status Check

Get information about API status and versions.

Request

GET /api/status

Headers

NameTypeDescription
X-API-KeystringRequired. API key

Response

{ "message": "Welcome to Flute CMS API", "flute_version": "1.0.0", "api_version": "1.0.0" }
FieldTypeDescription
messagestringWelcome message
flute_versionstringFlute CMS version
api_versionstringAPI version

Response Codes

CodeDescription
200Successful request
401Invalid or missing API key
403Insufficient permissions to perform request

Get Current API Key Permissions

Get the list of permissions for the current API key.

Request

GET /api/permissions

Headers

NameTypeDescription
X-API-KeystringRequired. API key

Response

{ "permissions": [ { "id": 1, "name": "admin.users", "description": "User management" }, { "id": 2, "name": "admin.roles", "description": "Role management" } ] }
FieldTypeDescription
permissionsarrayArray of permissions
idintegerPermission ID
namestringPermission name
descriptionstringPermission description

Response Codes

CodeDescription
200Successful request
401Invalid or missing API key