Skip to content

Skippr Cloud API reference

Skippr Cloud uses capability-based HTTPS APIs. 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 — readiness is defined per operation.

At a glance

FactValue
Default regioneu-central-1
Shared endpointhttps://api.cloud.skippr.io
Regional endpointhttps://{service}.eu-central-1.cloud.skippr.io
JSON targetX-Cloud-Target: Cloud<Service>.<Operation>
AuthenticationCloud JWT or capability-scoped SigV4
Catalog version1
Catalog digestschemas/generated/DIGEST
Exact operationsAPI operations

Make a first call

Use a Cloud JWT to list tables:

bash
export CLOUD_BEARER_TOKEN='<token>'

curl -sS https://tables.eu-central-1.cloud.skippr.io/ \
  -H "Authorization: Bearer ${CLOUD_BEARER_TOKEN}" \
  -H 'Content-Type: application/json' \
  -H 'X-Cloud-Target: CloudTables.ListTables' \
  -d '{}'

CloudTables.ListTables is supported. A successful response contains tableNames and may contain an opaque nextToken. Follow Get started to obtain a token through OTP sign-in.

Authenticate

Choose credentials for the caller:

CredentialUse
Cloud JWTInteractive users and native HTTPS calls
Operator access key and secretTerraform, CDKTF, CI, and control-plane automation
Workload access key and secretScoped application or automation calls
Session credentialsShort-lived scoped calls

SigV4 uses the capability service code from the service index, such as tables, queue, or gateway. Verified credentials determine the tenant. A body field, query parameter, or custom client header cannot select a tenant.

Permissions are evaluated with ABAC. Use Auth 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.

FactContract
Content typeapplication/json
Target headerX-Cloud-Target: Cloud<Service>.<Operation>
Operation namesPascalCase, such as CreateTable
JSON memberslowerCamel, such as tableName
Durable mutation retryclientToken where the operation schema defines it
PaginationmaxResults and opaque nextToken where defined
Concurrent updateConditional or revision fields where defined

Use the exact hostname, target prefix, and SigV4 service code from the service index. 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 operation index. 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 auth.yaml. The generated OpenAPI index is schemas/openapi/index.json.

Handle errors

Cloud JSON operations return a shared error body:

json
{
  "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.

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, ABAC 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.

Check readiness before calling

StatusMeaning
supportedThe operation is a current Preview tenant contract.
implementedThe operation is a current Preview contract, including auth operations that use this label.
plannedThe operation is not a callable current tenant contract.
removedThe operation is not part of the current contract.
catalog-onlyThe generated catalog contains the operation, but the readiness matrix does not assign a current status.

The operations reference separates generated callable contracts from planned entries. A service name, schema, or familiar request shape does not by itself make an operation callable.

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:

  • Services — hostnames, protocols, target prefixes, and SigV4 service codes.
  • Operations — readiness and request/response schema links.
  • 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.