Skippr Cloud API reference
The skippr-cloud CLI is the default client. This page is the HTTPS wire contract used by the CLI, SDKs, Terraform, and direct callers. Authenticate with a Cloud JWT or capability-scoped SigV4 credentials, call an operation marked supported or implemented, and validate requests against the published schema.
Status: Preview — confirm each action in the API action reference.
At a glance
| Fact | Value |
|---|---|
| Default client | skippr-cloud — CLI |
| Regions | eu-central-1 (more will follow) |
| Shared endpoint | https://api.cloud.skippr.io |
| Regional endpoint | https://{service}.{region}.cloud.skippr.io |
| JSON target | X-Cloud-Target: Cloud<Service>.<Operation> |
| Authentication | Cloud JWT or capability-scoped SigV4 |
| Catalog version | 1 |
| Catalog digest | schemas/generated/DIGEST |
| Services | Service catalog |
| Actions | API action reference |
| Provisionable resources | Infrastructure resources |
Make a first call
Prefer the CLI:
skippr-cloud login --email you@example.com
skippr-cloud tables list-tablesCloudTables.ListTables is supported. A successful response contains tableNames and may contain an opaque nextToken. Follow Get started for install and OTP sign-in.
The equivalent HTTPS call uses X-Cloud-Target: CloudTables.ListTables against the tables regional endpoint. Use that path only when you are not using the CLI or SDK.
Authenticate
Choose credentials for the caller:
| Credential | Use |
|---|---|
| Cloud JWT | Interactive users and native HTTPS calls |
| Operator access key and secret | Terraform, CDKTF, CI, and control-plane automation |
| Workload access key and secret | Scoped application or automation calls |
| Session credentials | Short-lived scoped calls |
SigV4 uses the capability service code from the Service catalog, such as tables, queue, or gateway.
Permissions are evaluated with policies. Use Cloud User Directory to obtain credentials and manage policies.
Use the right protocol
Native Cloud JSON
Cloud JSON operations use HTTPS, JSON bodies, lower-camel JSON members, and the X-Cloud-Target header.
| Fact | Contract |
|---|---|
| Content type | application/json |
| Target header | X-Cloud-Target: Cloud<Service>.<Operation> |
| Operation names | PascalCase, such as CreateTable |
| JSON members | lowerCamel, such as tableName |
| Durable mutation retry | clientToken where the operation schema defines it |
| Pagination | maxResults and opaque nextToken where defined |
| Concurrent update | Conditional or revision fields where defined |
Use the hostname, target prefix, and SigV4 service code from the Service catalog. Do not substitute similarly shaped target names or service codes.
Objects HTTP
objects uses HTTP object paths at https://objects.cloud.skippr.io instead of native JSON targets. Multipart and presigned URL operations are listed in the API action reference. Contracts use the /cloud/schemas/generated/operations/objects/{operation}.json URL pattern.
Auth REST
auth uses REST at https://auth.cloud.skippr.io. Its contract is /openapi.json (JSON) and /api/openapi.yaml (YAML). The generated OpenAPI index is schemas/openapi/index.json. Cloud JSON RPC services are not REST paths — use the schema discovery index.
Handle errors
Cloud JSON operations return a shared error body:
{
"code": "ResourceNotFoundException",
"message": "resource was not found",
"requestId": "request-id"
}Use code for program flow, show message to the caller when appropriate, and retain requestId for support. An optional details object can contain structured error context, including a resolution hint.
Gateway edge failures (no matching route, unauthorized, forbidden, throttling, gone connections, validation, or upstream errors) use this same JSON envelope. They do not return HTML or plaintext error pages.
When Cloud accepts but ignores, approximates, or coerces a field, the response includes a non-empty ignoredFields array. Do not treat accepted input as applied unless the response confirms it.
Authentication failures, policy denials, validation failures, conflicts, missing resources, throttling, and service failures use the operation's documented HTTP status and shared error schema. Retry only when the operation contract and error permit it; reuse clientToken for an idempotent mutation retry.
Choose an API action
| Status | Meaning |
|---|---|
supported | The operation is available in Preview. |
implemented | The operation is available in Preview (used by some auth operations). |
planned | The operation is coming soon. |
removed | The operation is not part of the current product. |
catalog-only | The service catalog lists the name, but you cannot call it yet. |
The API action reference separates what you can run now from what is coming soon. A service name or familiar request shape does not by itself mean the action is available.
Use limits and contracts
There is no single platform-wide request limit documented for every capability. Use the service guide and operation schema for payload, pagination, retention, concurrency, and resource limits. Do not infer a limit from another service.
The published contract contains service descriptors, operation request and response schemas, resource descriptors, Terraform schemas, shared errors, and a catalog digest:
- Service catalog — hostnames, protocols, target prefixes, and SigV4 service codes.
- API action reference — available and coming-soon actions with request and response schema links.
- Infrastructure resources — provisionable
cloud_*resources, lifecycle, imports, and update strategy. - Schema discovery index — machine-readable entry point.
- Shared error contract — the common JSON error body; other shared contracts are linked by the schema discovery index.
The digest identifies the exact catalog used by the published schemas and provider bindings.
Choose an infrastructure workflow
- Terraform and CDKTF describes the 19 provisionable
cloud_*resources and includes equivalent examples. - Deployment model describes API resource deployment, provider ownership, Functions, Sites, and control/data-plane boundaries.