Overview
The S4Kit Admin API provides programmatic access to manage your S4Kit resources. Use it to automate system configuration, manage API keys, and query logs.Base URL
Authentication
All Admin API requests require authentication using a session token from the dashboard or an admin API key.Response Format
All responses are JSON with consistent structure:Success Response
Error Response
Rate Limiting
Admin API requests are rate limited:| Limit | Value |
|---|---|
| Per minute | 100 requests |
| Per day | 10,000 requests |
Common Endpoints
Systems
| Method | Endpoint | Description |
|---|---|---|
| GET | /admin/systems | List all systems |
| POST | /admin/systems | Create a system |
| GET | /admin/systems/:id | Get a system |
| PATCH | /admin/systems/:id | Update a system |
| DELETE | /admin/systems/:id | Delete a system |
Instances
| Method | Endpoint | Description |
|---|---|---|
| GET | /admin/systems/:id/instances | List instances |
| POST | /admin/systems/:id/instances | Create instance |
| GET | /admin/instances/:id | Get an instance |
| PATCH | /admin/instances/:id | Update instance |
| DELETE | /admin/instances/:id | Delete instance |
API Keys
| Method | Endpoint | Description |
|---|---|---|
| GET | /admin/api-keys | List API keys |
| POST | /admin/api-keys | Create API key |
| GET | /admin/api-keys/:id | Get API key details |
| PATCH | /admin/api-keys/:id | Update API key |
| DELETE | /admin/api-keys/:id | Revoke API key |
Logs
| Method | Endpoint | Description |
|---|---|---|
| GET | /admin/logs | Query request logs |
| GET | /admin/logs/:id | Get log details |
OpenAPI Specification
The complete API specification is available below. You can import this into tools like Postman or use it to generate client libraries.S4Kit Admin API OpenAPI Spec
View the OpenAPI 3.1 specification