console

Register Runtime Version

Called by the release-runtime CI workflow after building and pushing a runtime image to the container registry. Creates or updates the version record in the shared SurrealDB namespace.

Authenticated against the Pragmatiks Console Clerk realm — only a ConsoleMachine M2M token is accepted. Customer-realm tokens are rejected at the Clerk SDK layer (wrong JWKS); ConsoleUser session tokens are rejected with 403 by require_console_machine.

Args: body: Runtime version registration payload. service: Shared-namespace RuntimeVersionService for persistence. machine: Authenticated ConsoleMachine performing the release.

Returns: The persisted RuntimeVersion record.

POST

console

runtime

versions

curl --request POST \
  --url https://api.example.com/console/runtime/versions \
  --header 'Content-Type: application/json' \
  --data '
{
  "version": "<string>",
  "image_url": "<string>",
  "changelog": "<string>"
}
'

{
  "version": "<string>",
  "image_url": "<string>",
  "released_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "changelog": "<string>"
}

Body

application/json

Request body for registering a new runtime version.

Attributes: version: Semver version string (e.g., "0.40.0"). image_url: Full container image URL for this runtime version (e.g., europe-west4-docker.pkg.dev/.../pragma-runtime:0.40.0). changelog: Optional release notes in markdown.

version

string

required

image_url

string

required

changelog

string | null

Response

Successful Response

A tracked runtime image version.

Identity fields (frozen): version: Semver string (e.g., "0.39.0"), used as SurrealDB record ID.

Metadata: image_url: Full container image URL for this runtime version. released_at: Timestamp when this version was released. changelog: Optional release notes in markdown.

version

string

required

image_url

string

required

released_at

string<date-time>

required

created_at

string<date-time>

updated_at

string<date-time>

changelog

string | null

Register Platform Provider VersionRegister a first-party provider version backed by a wheel. Called by provider release CI after publishing a wheel to PyPI. Authenticates against the Pragmatiks Console Clerk realm and accepts only ConsoleMachine M2M tokens. The payload must target ``platform/<name>``; customer provider registration remains on the customer-realm ``POST /provider-versions`` route. Args: body: Wheel registration payload. machine: Authenticated ConsoleMachine performing the release. engine: Provider engine for registration persistence. Returns: Persisted PUBLISHED ProviderVersion. Raises: HTTPException: 403 when the payload targets a non-platform namespace; 422 when required metadata is missing.

curl --request POST \
  --url https://api.example.com/console/runtime/versions \
  --header 'Content-Type: application/json' \
  --data '
{
  "version": "<string>",
  "image_url": "<string>",
  "changelog": "<string>"
}
'

{
  "version": "<string>",
  "image_url": "<string>",
  "released_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "changelog": "<string>"
}

Documentation Index

Body

Response