Skip to main content

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.
Most users interact with S4Kit through the SDK for SAP operations and the Dashboard for configuration. The Admin API is for advanced automation use cases.

Base URL

https://api.s4kit.com/admin

Authentication

All Admin API requests require authentication using a session token from the dashboard or an admin API key.
curl https://api.s4kit.com/admin/systems \
  -H "Authorization: Bearer <your-token>"

Response Format

All responses are JSON with consistent structure:

Success Response

{
  "data": { ... },
  "meta": {
    "requestId": "req_abc123"
  }
}

Error Response

{
  "error": {
    "code": "NOT_FOUND",
    "message": "System not found",
    "requestId": "req_abc123"
  }
}

Rate Limiting

Admin API requests are rate limited:
LimitValue
Per minute100 requests
Per day10,000 requests
Rate limit headers:
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1640000000

Common Endpoints

Systems

MethodEndpointDescription
GET/admin/systemsList all systems
POST/admin/systemsCreate a system
GET/admin/systems/:idGet a system
PATCH/admin/systems/:idUpdate a system
DELETE/admin/systems/:idDelete a system

Instances

MethodEndpointDescription
GET/admin/systems/:id/instancesList instances
POST/admin/systems/:id/instancesCreate instance
GET/admin/instances/:idGet an instance
PATCH/admin/instances/:idUpdate instance
DELETE/admin/instances/:idDelete instance

API Keys

MethodEndpointDescription
GET/admin/api-keysList API keys
POST/admin/api-keysCreate API key
GET/admin/api-keys/:idGet API key details
PATCH/admin/api-keys/:idUpdate API key
DELETE/admin/api-keys/:idRevoke API key

Logs

MethodEndpointDescription
GET/admin/logsQuery request logs
GET/admin/logs/:idGet 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

SDKs

Currently, the Admin API is best accessed via HTTP requests. Official SDKs for the Admin API are planned for future releases.
// Example using fetch
const response = await fetch('https://api.s4kit.com/admin/systems', {
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  }
});

const { data: systems } = await response.json();