Download OpenAPI specification:
API for deploying, managing, and monitoring SlideRule processing clusters. Supports cluster lifecycle management (deploy, extend, destroy, status), user auto-scaling groups, and test runner deployments. All endpoints require JWT authentication; owner-level operations additionally require request signature verification.
Returns user information derived from the JWT claims, including username, organization roles, known and deployable clusters, and resource limits.
| X-Sliderule-Timestamp | string Unix timestamp (seconds since epoch) of when the request was signed. Required for owner-level operations. |
| X-Sliderule-Signature | string Base64-encoded signature of the canonical request string. Required for owner-level operations. |
{- "username": "string",
- "orgRoles": [
- "owner"
], - "knownClusters": [
- "string"
], - "deployableClusters": [
- "string"
], - "maxNodes": 50,
- "maxTTL": 720
}Creates a new SlideRule processing cluster via CloudFormation. Provisions an intelligent load balancer, monitor, and processing nodes.
| X-Sliderule-Timestamp | string Unix timestamp (seconds since epoch) of when the request was signed. Required for owner-level operations. |
| X-Sliderule-Signature | string Base64-encoded signature of the canonical request string. Required for owner-level operations. |
| cluster required | string <= 40 characters ^[A-Za-z0-9-_]+$ Name of the cluster to deploy. Must not be a system keyword (login, provisioner, client, recorder, runner, mcp, sliderule, monitor). |
| node_capacity required | integer [ 1 .. 100 ] Number of processing nodes to provision. |
| ttl required | integer >= 15 Time to live in minutes before automatic shutdown. Members max 720 (12 hours), owners max 525600 (1 year). |
| is_public | boolean Default: false Whether the cluster should be publicly accessible. |
| version | string Default: "latest" Container image version to deploy. |
{- "cluster": "developers",
- "node_capacity": 4,
- "ttl": 60,
- "is_public": false,
- "version": "latest"
}{- "parms": [
- {
- "ParameterKey": "string",
- "ParameterValue": "string"
}
], - "response": { }
}Creates a user-specific auto-scaling group attached to an existing cluster. The username in the path must match the authenticated user.
| username required | string Username of the authenticated user (must match JWT sub claim). |
| X-Sliderule-Timestamp | string Unix timestamp (seconds since epoch) of when the request was signed. Required for owner-level operations. |
| X-Sliderule-Signature | string Base64-encoded signature of the canonical request string. Required for owner-level operations. |
| cluster required | string <= 40 characters ^[A-Za-z0-9-_]+$ Name of the cluster to deploy. Must not be a system keyword (login, provisioner, client, recorder, runner, mcp, sliderule, monitor). |
| node_capacity required | integer [ 1 .. 100 ] Number of processing nodes to provision. |
| ttl required | integer >= 15 Time to live in minutes before automatic shutdown. Members max 720 (12 hours), owners max 525600 (1 year). |
| is_public | boolean Default: false Whether the cluster should be publicly accessible. |
| version | string Default: "latest" Container image version to deploy. |
{- "cluster": "developers",
- "node_capacity": 4,
- "ttl": 60,
- "is_public": false,
- "version": "latest"
}{- "parms": [
- {
- "ParameterKey": "string",
- "ParameterValue": "string"
}
], - "response": { }
}Extends the auto-shutdown time of a cluster by updating the EventBridge schedule rule with a new cron expression based on the requested TTL.
| X-Sliderule-Timestamp | string Unix timestamp (seconds since epoch) of when the request was signed. Required for owner-level operations. |
| X-Sliderule-Signature | string Base64-encoded signature of the canonical request string. Required for owner-level operations. |
| cluster required | string <= 40 characters ^[A-Za-z0-9-_]+$ Name of the cluster to extend. |
| ttl required | integer >= 15 New TTL in minutes from now. |
| node_capacity | integer [ 1 .. 100 ] Node capacity (validated but not used for extend). |
{- "cluster": "string",
- "ttl": 60,
- "node_capacity": 1
}{- "cron_expression": "cron(30 14 7 5 ? 2026)",
- "response": { }
}Extends the auto-shutdown time of a user auto-scaling group.
| username required | string Username of the authenticated user (must match JWT sub claim). |
| X-Sliderule-Timestamp | string Unix timestamp (seconds since epoch) of when the request was signed. Required for owner-level operations. |
| X-Sliderule-Signature | string Base64-encoded signature of the canonical request string. Required for owner-level operations. |
| cluster required | string <= 40 characters ^[A-Za-z0-9-_]+$ Name of the cluster to extend. |
| ttl required | integer >= 15 New TTL in minutes from now. |
| node_capacity | integer [ 1 .. 100 ] Node capacity (validated but not used for extend). |
{- "cluster": "string",
- "ttl": 60,
- "node_capacity": 1
}{- "cron_expression": "cron(30 14 7 5 ? 2026)",
- "response": { }
}Destroys a cluster and all associated user ASG stacks. Removes EventBridge auto-shutdown rules and deletes CloudFormation stacks.
| X-Sliderule-Timestamp | string Unix timestamp (seconds since epoch) of when the request was signed. Required for owner-level operations. |
| X-Sliderule-Signature | string Base64-encoded signature of the canonical request string. Required for owner-level operations. |
| cluster required | string <= 40 characters ^[A-Za-z0-9-_]+$ Name of the cluster. |
{- "cluster": "developers"
}{- "status": true,
- "exception": "string",
- "property1": {
- "EventBridge Target Removed": true,
- "EventBridge Rule Removed": true,
- "response": { }
}, - "property2": {
- "EventBridge Target Removed": true,
- "EventBridge Rule Removed": true,
- "response": { }
}
}Destroys a user-specific auto-scaling group attached to a cluster.
| username required | string Username of the authenticated user (must match JWT sub claim). |
| X-Sliderule-Timestamp | string Unix timestamp (seconds since epoch) of when the request was signed. Required for owner-level operations. |
| X-Sliderule-Signature | string Base64-encoded signature of the canonical request string. Required for owner-level operations. |
| cluster required | string <= 40 characters ^[A-Za-z0-9-_]+$ Name of the cluster. |
{- "cluster": "developers"
}{- "status": true,
- "exception": "string",
- "property1": {
- "EventBridge Target Removed": true,
- "EventBridge Rule Removed": true,
- "response": { }
}, - "property2": {
- "EventBridge Target Removed": true,
- "EventBridge Rule Removed": true,
- "response": { }
}
}Returns the current deployment status of a cluster including CloudFormation stack status, auto-shutdown time, current node count, version, and whether the cluster is public.
| X-Sliderule-Timestamp | string Unix timestamp (seconds since epoch) of when the request was signed. Required for owner-level operations. |
| X-Sliderule-Signature | string Base64-encoded signature of the canonical request string. Required for owner-level operations. |
| cluster required | string <= 40 characters ^[A-Za-z0-9-_]+$ Name of the cluster. |
{- "cluster": "developers"
}{- "response": { },
- "auto_shutdown": "string",
- "current_nodes": 0,
- "version": "string",
- "is_public": "string",
- "node_capacity": "string"
}Returns the current deployment status of a user auto-scaling group.
| username required | string Username of the authenticated user (must match JWT sub claim). |
| X-Sliderule-Timestamp | string Unix timestamp (seconds since epoch) of when the request was signed. Required for owner-level operations. |
| X-Sliderule-Signature | string Base64-encoded signature of the canonical request string. Required for owner-level operations. |
| cluster required | string <= 40 characters ^[A-Za-z0-9-_]+$ Name of the cluster. |
{- "cluster": "developers"
}{- "response": { },
- "auto_shutdown": "string",
- "current_nodes": 0
}Returns CloudFormation stack events for a cluster deployment.
| X-Sliderule-Timestamp | string Unix timestamp (seconds since epoch) of when the request was signed. Required for owner-level operations. |
| X-Sliderule-Signature | string Base64-encoded signature of the canonical request string. Required for owner-level operations. |
| cluster required | string <= 40 characters ^[A-Za-z0-9-_]+$ Name of the cluster. |
{- "cluster": "developers"
}[- { }
]Returns CloudFormation stack events for a user ASG deployment.
| username required | string Username of the authenticated user (must match JWT sub claim). |
| X-Sliderule-Timestamp | string Unix timestamp (seconds since epoch) of when the request was signed. Required for owner-level operations. |
| X-Sliderule-Signature | string Base64-encoded signature of the canonical request string. Required for owner-level operations. |
| cluster required | string <= 40 characters ^[A-Za-z0-9-_]+$ Name of the cluster. |
{- "cluster": "developers"
}[- { }
]Returns a report of all deployed clusters including auto-shutdown time, node count, version, and per-user ASG details. Requires member role.
{- "property1": {
- "auto_shutdown": "string",
- "current_nodes": 0,
- "version": "string",
- "is_public": "string",
- "node_capacity": "string",
- "users": {
- "property1": {
- "auto_shutdown": "string",
- "current_nodes": 0
}, - "property2": {
- "auto_shutdown": "string",
- "current_nodes": 0
}
}
}, - "property2": {
- "auto_shutdown": "string",
- "current_nodes": 0,
- "version": "string",
- "is_public": "string",
- "node_capacity": "string",
- "users": {
- "property1": {
- "auto_shutdown": "string",
- "current_nodes": 0
}, - "property2": {
- "auto_shutdown": "string",
- "current_nodes": 0
}
}
}
}Returns a report for a single deployed cluster. Requires member role.
| cluster required | string <= 40 characters ^[A-Za-z0-9-_]+$ Cluster name. |
{- "property1": {
- "auto_shutdown": "string",
- "current_nodes": 0,
- "version": "string",
- "is_public": "string",
- "node_capacity": "string",
- "users": {
- "property1": {
- "auto_shutdown": "string",
- "current_nodes": 0
}, - "property2": {
- "auto_shutdown": "string",
- "current_nodes": 0
}
}
}, - "property2": {
- "auto_shutdown": "string",
- "current_nodes": 0,
- "version": "string",
- "is_public": "string",
- "node_capacity": "string",
- "users": {
- "property1": {
- "auto_shutdown": "string",
- "current_nodes": 0
}, - "property2": {
- "auto_shutdown": "string",
- "current_nodes": 0
}
}
}
}Returns the summary report from the last test runner deployment. Requires member role.
| branch | string Default: "main" Git branch to run tests against. |
{- "branch": "main"
}{ }Deploys a test runner CloudFormation stack that automatically runs tests and destroys itself after completion. Only one test runner can be active at a time. Requires member role.
| branch | string Default: "main" Git branch to run tests against. |
{- "branch": "main"
}{- "parms": [
- {
- "ParameterKey": "string",
- "ParameterValue": "string"
}
], - "response": { }
}