Skip to content
Weik.ioDocs
2026.2
Try Weik.io

HTTP API

Weik.io 2026.2

The hub's REST API, path by path, with the weikio command that calls each one.

On this page

Every weikio command is a call to the hub’s HTTP API, so anything the CLI and the admin UI do, your own scripts and tools can do too. The API is served on the hub’s own address under /api/v1, and the hub describes it in an OpenAPI 3.1 document at GET /api/v1/openapi, which you can load into an API client or a code generator.

Authentication#

The API accepts an API key as a bearer token. A key looks like wk_<keyId>_<secret>, and you create one with weikio apikey create or under Settings > Access > API keys in the admin UI. The key’s grants decide what each call may read and change, exactly as for the CLI.

Terminal
$ curl -H "Authorization: Bearer $WEIKIO_API_KEY" https://weikio.example.com/api/v1/schemas/variable

People who sign in to the admin UI use a browser session on the same address, and the API accepts no other credential.

How the paths work#

GET on a collection lists it, GET on an item reads one record, PUT creates or replaces a record, PATCH changes part of one and DELETE removes one. A record of one environment has the environment in its path, as in /api/v1/environments/{environment}/projects/{project}/deployments/{name}, never in a query parameter.

A reply with a record has an ETag. Send it back in If-Match on a write, and the hub refuses the write with 409 Conflict and the current record when someone changed it in between. A list is one page, {"items": [...]}, with a link to the next page. An error is a problem document, application/problem+json, with a code a script can branch on and a sentence for people, and GET /api/v1/version answers with the hub’s release.

A write accepts the headers the CLI sends: Weikio-Reason for the reason stored with the audit record, and a traceparent, whose trace id ties the call to its audit record and the hub’s log lines.

Login and contexts#

The commands are on Login and contexts.

Method Path Command
POST /api/v1/auth/cli-login/_start weikio login
GET /api/v1/auth/cli-login/{requestId} weikio login
POST /api/v1/auth/cli-login/{requestId}/approve weikio login
POST /api/v1/auth/cli-login/{requestId}/redeem weikio login
GET /api/v1/whoami weikio login
GET /api/v1/settings/install/authority weikio login
GET /api/v1/environments/{name} weikio context set
GET /api/v1/version weikio version

Projects, members and roles#

The commands are on Projects, members and roles.

Method Path Command
PUT /api/v1/projects/{name} weikio project create
GET /api/v1/projects weikio get projects
GET /api/v1/projects/{name} weikio describe project
GET /api/v1/projects/{name}/members weikio describe project
GET /api/v1/projects/{name}/integrations weikio describe project
DELETE /api/v1/projects/{name} weikio delete project
PATCH /api/v1/projects/{project} weikio rename project
GET /api/v1/users/_emails?email= weikio member add
PUT /api/v1/projects/{project}/members/{userId} weikio member add
GET /api/v1/projects/{project}/members weikio get members
GET /api/v1/users/_emails?ids= weikio get members
DELETE /api/v1/projects/{project}/members/{userId} weikio member remove
GET /api/v1/roles weikio get roles
GET /api/v1/roles/{name} weikio describe role
PUT /api/v1/roles/{name} weikio role create
DELETE /api/v1/roles/{name} weikio delete role
PATCH /api/v1/roles/{name} weikio rename role

Environments#

The commands are on Environments.

Method Path Command
PUT /api/v1/environments/{name} weikio env create
GET /api/v1/environments weikio get environments
GET /api/v1/gateways weikio get environments
GET /api/v1/environments/{name}/deployments weikio describe environment
GET /api/v1/agents?environment= weikio describe environment
DELETE /api/v1/environments/{name} weikio delete environment
PATCH /api/v1/environments/{environment} weikio rename environment

Integrations, versions and the developer loop#

The commands are on Integrations, versions and the developer loop.

Method Path Command
GET /api/v1/camel-lines weikio init
GET /api/v1/schemas weikio validate
GET /api/v1/projects/{project}/kamelets weikio validate
POST /api/v1/projects/{project}/integrations/{name}/source/missing weikio apply
PUT /api/v1/projects/{project}/integrations/{name}/source?dryRun=&version= weikio apply
PUT /api/v1/configuration?environment=&dryRun=&builds= weikio apply
POST /api/v1/configuration/prune?environment=&dryRun= weikio apply
PUT /api/v1/configuration?dryRun=true&builds= weikio diff
GET /api/v1/configuration/export?project=&environment= weikio diff
PUT /api/v1/projects/{project}/integrations/{name}/source?dryRun=true&version= weikio diff
POST /api/v1/configuration/prune?environment=&dryRun=true weikio diff
PATCH /api/v1/environments/{environment}/projects/{project}/deployments/{name} weikio run
GET /api/v1/projects/{project}/integrations/{name}/status weikio run
GET /api/v1/logs/tail weikio run
GET /api/v1/environments/{environment}/projects/{project}/deployments/{name}/configuration?name=... weikio dev run
GET /api/v1/projects/{project}/kamelets/_local weikio dev run
GET /api/v1/camel-lines/{line}/cluster-jar weikio dev run
GET /api/v1/environments/{environment}/projects/{project}/secrets/{name}/reveal weikio dev run
GET /api/v1/projects/{project}/secrets/{name}/reveal weikio dev run
GET /api/v1/environments/{environment}/projects/{project}/integrations/{i}/secrets/{name}/reveal weikio dev run
GET /api/v1/projects/{project}/integrations/{i}/secrets/{name}/reveal weikio dev run
GET /api/v1/projects/{project}/integrations?type= weikio get integrations
GET /api/v1/projects/{project}/integrations/{name} weikio describe integration
GET /api/v1/projects/{project}/integrations/{name}/versions weikio get versions
GET /api/v1/projects/{project}/integrations/{name}/versions/{version} weikio describe version
POST /api/v1/projects/{project}/integrations/{name}/versions weikio version create
GET /api/v1/projects/{project}/integrations/{name}/source/files/{path}?version= weikio version compare
GET /api/v1/metrics/summary weikio status
GET /api/v1/traces/_related weikio status
GET /api/v1/logs?whole=true&order=oldest weikio logs
GET /api/v1/logs/tail?whole=true weikio logs
GET /api/v1/logs/histogram weikio logs
GET /api/v1/projects/{project}/integrations/{name}/versions/{version}/build weikio logs
POST /api/v1/environments/{environment}/projects/{project}/deployments/{name}/invoke?agent= weikio invoke
DELETE /api/v1/projects/{project}/integrations/{name}?dryRun=true weikio delete integration
DELETE /api/v1/projects/{project}/integrations/{name} weikio delete integration
PATCH /api/v1/projects/{project}/integrations/{name} weikio rename integration
GET /api/v1/projects/{project}/kamelets/_usage weikio get kamelets
GET /api/v1/projects/{project}/kamelets/{name} weikio describe kamelet
DELETE /api/v1/projects/{project}/kamelets/{name} weikio delete kamelet

Deployments#

The commands are on Deployments.

Method Path Command
GET /api/v1/environments/{environment}/projects/{project}/deployments/{name} weikio deploy
PATCH /api/v1/environments/{environment}/projects/{project}/deployments/{name}[?force=true] weikio deploy
GET /api/v1/environments/{environment}/deployments weikio get deployments
GET /api/v1/environments/{environment}/projects/{project}/deployments weikio get deployments
GET /api/v1/deployments?environment=&project= weikio get deployments
GET /api/v1/deployments?environment=&project=&health= weikio get fleet
GET /api/v1/agents/{id} weikio describe deployment
GET /api/v1/environments/{A}/projects/{project}/deployments/{name} weikio promote
PATCH /api/v1/environments/{B}/projects/{project}/deployments/{name}?dryRun=true weikio promote
PATCH /api/v1/environments/{B}/projects/{project}/deployments/{name} weikio promote
DELETE /api/v1/environments/{environment}/projects/{project}/deployments/{name} weikio undeploy

Variables and secrets#

The commands are on Variables and secrets.

Method Path Command
GET /api/v1/projects/{project}/variables weikio get variables
GET /api/v1/environments/{environment}/projects/{project}/variables weikio get variables
GET /api/v1/projects/{project}/integration-variables weikio get variables
GET /api/v1/projects/{project}/integrations/{integration}/variables weikio get variables
GET /api/v1/environments/{environment}/projects/{project}/integrations/{integration}/variables weikio get variables
GET /api/v1/environments/{environment}/projects/{project}/deployments/{name}/configuration weikio get variables
GET /api/v1/projects/{project}/variables/{name} weikio describe variable
GET /api/v1/environments/{environment}/projects/{project}/variables/{name} weikio describe variable
GET /api/v1/projects/{project}/integrations/{integration}/variables/{name} weikio describe variable
GET /api/v1/environments/{environment}/projects/{project}/integrations/{integration}/variables/{name} weikio describe variable
GET /api/v1/projects/{project}/integration-secrets weikio variable set
DELETE /api/v1/projects/{project}/variables/{name} weikio delete variable
DELETE /api/v1/environments/{environment}/projects/{project}/variables/{name} weikio delete variable
DELETE /api/v1/projects/{project}/integrations/{integration}/variables/{name} weikio delete variable
DELETE /api/v1/environments/{environment}/projects/{project}/integrations/{integration}/variables/{name} weikio delete variable
GET /api/v1/projects/{project}/secrets weikio get secrets
GET /api/v1/environments/{environment}/projects/{project}/secrets weikio get secrets
GET /api/v1/projects/{project}/integrations/{integration}/secrets weikio get secrets
GET /api/v1/environments/{environment}/projects/{project}/integrations/{integration}/secrets weikio get secrets
GET /api/v1/projects/{project}/secrets/{name} weikio secret set
GET /api/v1/environments/{environment}/projects/{project}/secrets/{name} weikio secret set
GET /api/v1/environments/{environment}/projects/{project}/integrations/{integration}/secrets/{name}/reveal weikio secret reveal
GET /api/v1/projects/{project}/integrations/{integration}/secrets/{name}/reveal weikio secret reveal
DELETE /api/v1/projects/{project}/secrets/{name} weikio delete secret
DELETE /api/v1/environments/{environment}/projects/{project}/secrets/{name} weikio delete secret
DELETE /api/v1/projects/{project}/integrations/{integration}/secrets/{name} weikio delete secret
DELETE /api/v1/environments/{environment}/projects/{project}/integrations/{integration}/secrets/{name} weikio delete secret

Events and the entity store#

The commands are on Events and the entity store.

Method Path Command
GET /api/v1/projects/{project}/channels weikio get channels
PUT /api/v1/configuration weikio channel create
GET /api/v1/projects/{project}/integrations?type=event-source weikio get eventsources
GET /api/v1/projects/{project}/integrations?type=event-subscription weikio get eventsubscriptions
GET /api/v1/environments/{environment}/streams weikio get streams
GET /api/v1/records/{uid} weikio get record
GET /api/v1/environments/{environment}/events?family=&channel={p}/{name}&project={p}&api=&integration=&type={p}/{type}&recordUid=&from=&to=&source={p}/{name}&withBody=true&limit=&before=&after=&order= weikio events list
GET /api/v1/environments/{environment}/streams/{stream}/events/{seq} weikio events show
POST /api/v1/environments/{environment}/streams/{stream}/events/_purge weikio events purge
GET /api/v1/environments/{environment}/dead-letters?project={p}&integration={n}&recordUid=&channel={p}/{name}&from=&to=&limit=&before=&after=&order= weikio deadletters list
GET /api/v1/environments/{environment}/dead-letters/{seq} weikio deadletters show
GET /api/v1/environments/{environment}/readers?project={p}&integration={n}&channel={p}/{name} weikio get readers
POST /api/v1/environments/{environment}/streams/{stream}/events/{seq}/resend weikio events resend
GET /api/v1/environments/{environment}/projects/{project}/entities/{type}?updatedSince&idPrefix&limit&before&after weikio entities list
GET /api/v1/environments/{environment}/projects/{project}/entities/{type}/{id} weikio entities get
DELETE /api/v1/environments/{environment}/projects/{project}/entities/{type}/{id} weikio entities delete
GET /api/v1/environments/{environment}/entity-store weikio get entity-store-policies
GET /api/v1/environments/{environment}/projects/{project}/entity-store weikio get entity-store-policies
GET /api/v1/environments/{environment}/projects/{project}/entity-store/{type}/policy weikio describe entity-store-policy
PUT /api/v1/environments/{environment}/projects/{project}/entity-store/{type}/policy weikio entitystore policy set
DELETE /api/v1/environments/{environment}/projects/{project}/entity-store/{type}/policy weikio entitystore policy delete
PATCH /api/v1/projects/{project}/entity-store/{type} weikio rename entity-store-policy

APIs and subscriptions#

The commands are on APIs and subscriptions.

Method Path Command
PUT /api/v1/gateways/{name} weikio gateway create
GET /api/v1/settings/install weikio gateway create
GET /api/v1/gateways/{like} weikio gateway create
GET /api/v1/apim/instances weikio gateway set
GET /api/v1/gateways/{a}/diff/{b} weikio gateway diff
GET /api/v1/gateways?environment= weikio get gateways
GET /api/v1/gateways/{name} weikio describe gateway
DELETE /api/v1/gateways/{name} weikio delete gateway
PATCH /api/v1/gateways/{name} weikio rename gateway
PUT /api/v1/environments/{environment}/projects/{project}/api-deployments/{api}/{v} weikio api deploy
POST /api/v1/environments/{environment}/projects/{project}/api-deployments/{api}/{v}/rollback weikio api rollback
DELETE /api/v1/environments/{environment}/projects/{project}/api-deployments/{api}/{v} weikio api undeploy
GET /api/v1/environments/{environment}/projects/{project}/api-deployments weikio get api-deployments
GET /api/v1/projects/{project}/apis/{api}/deployments weikio get api-deployments
GET /api/v1/projects/{project}/apis weikio get apis
GET /api/v1/projects/{project}/apis/{name} weikio describe api
GET /api/v1/environments/{environment}/projects/{project}/api-subscriptions?api= weikio describe api
GET /api/v1/projects/{project}/apis/{api}/versions weikio get apiversions
GET /api/v1/projects/{project}/apis/{api}/versions/{version} weikio describe apiversion
DELETE /api/v1/projects/{project}/apis/{name} weikio delete api
PATCH /api/v1/projects/{project}/apis/{name} weikio rename api
DELETE /api/v1/projects/{project}/apis/{api}/versions/{version} weikio delete apiversion
GET /api/v1/projects/{project}/api-subscriptions?api= weikio get subscriptions
PUT /api/v1/environments/{environment}/projects/{project}/api-subscriptions/{name} weikio subscription create
POST /api/v1/environments/{environment}/projects/{project}/api-subscriptions/{name}/credential weikio subscription key
PATCH /api/v1/environments/{environment}/projects/{project}/api-subscriptions/{name} weikio subscription disable
DELETE /api/v1/environments/{environment}/projects/{project}/api-subscriptions/{name} weikio delete subscription

Agents and sites#

The commands are on Agents and sites.

Method Path Command
POST /api/v1/agents weikio agent enrol
GET /api/v1/agents/{id}/desired weikio describe agent
GET /api/v1/agents/{id}/status weikio describe agent
GET /api/v1/agents/{id}/diff weikio describe agent
GET /api/v1/logs weikio agent logs
PATCH /api/v1/agents/{id} weikio agent set-capabilities
POST /api/v1/agents/{id}/drain weikio agent drain
POST /api/v1/agents/{id}/undrain weikio agent undrain
POST /api/v1/agents/{id}/credentials weikio agent credentials
POST /api/v1/agents/{id}/revoke weikio agent revoke
DELETE /api/v1/agents/{id} weikio delete agent

Users, API keys, providers and mappings#

The commands are on Users, API keys, providers and mappings.

Method Path Command
GET /api/v1/users weikio get users
POST /api/v1/users weikio user create
POST /api/v1/users/{id}/password-reset weikio user create
DELETE /api/v1/users/{id}/totp weikio user reset-totp
GET /api/v1/users/{id} weikio describe user
GET /api/v1/users/_emails?email= weikio describe user
GET /api/v1/api-keys?user= weikio describe user
PUT /api/v1/users/{id} weikio user set
PATCH /api/v1/users/{id} weikio user disable
DELETE /api/v1/users/{id} weikio delete user
POST /api/v1/api-keys weikio apikey create
GET /api/v1/api-keys/{keyId} weikio describe apikey
DELETE /api/v1/api-keys/{keyId} weikio apikey revoke
GET /api/v1/providers weikio get providers
GET /api/v1/providers/{name} weikio provider set
PUT /api/v1/providers/{name} weikio provider set
DELETE /api/v1/providers/{name} weikio delete provider
GET /api/v1/mappings?provider= weikio get mappings
POST /api/v1/mappings weikio mapping add
GET /api/v1/mappings/{uid} weikio delete mapping
DELETE /api/v1/mappings/{uid} weikio delete mapping

Observability#

The commands are on Observability.

Method Path Command
GET /api/v1/logs/top-errors weikio logs
GET /api/v1/platform/health weikio platform metrics
GET /api/v1/platform/metrics weikio platform metrics
GET /api/v1/platform/series weikio platform metrics
GET /api/v1/audit?from&to&actor&action&targetKind&targetId&targetUid&outcome&correlationId&project&projectUid&environment&environmentUid&limit&before&after weikio audit query
GET /api/v1/audit?correlationId=&limit=1000 weikio audit show
GET /api/v1/summary/problems?environment=&project= weikio problems
GET /api/v1/activity?project=&environment=&integration=&api=&from=&to=&limit=&before=&after= weikio activity
GET /api/v1/metrics weikio metrics
GET /api/v1/metrics/names weikio metrics
GET /api/v1/metrics/metadata weikio metrics
GET /api/v1/traces weikio traces
GET /api/v1/traces/{id} weikio trace
GET /api/v1/traces?exchangeId= weikio trace
GET /healthz weikio platform health
GET /readyz weikio platform health
GET /.well-known/openid-configuration weikio platform health

Platform administration#

The commands are on Platform administration.

Method Path Command
GET /api/v1/search?q= weikio search
GET /api/v1/break-glass weikio platform breakglass
PUT /api/v1/platform/secrets/{name} weikio platform secret set
GET /api/v1/platform/secrets weikio platform secret list
DELETE /api/v1/platform/secrets/{name} weikio platform secret delete
GET /api/v1/forwarding[?effective=true] weikio forwarding get
GET /api/v1/forwarding weikio forwarding status
GET /api/v1/forwarding/status weikio forwarding status
DELETE /api/v1/forwarding weikio forwarding delete
POST /api/v1/forwarding/audit-from[?dryRun=true] weikio forwarding audit-from
GET /api/v1/certificates weikio get certificates
POST /api/v1/gateways/{name}/certificates/renew?hostname= weikio certificates renew
POST /api/v1/settings/install/certificates/renew?hostname= weikio certificates renew
POST /api/v1/environments/{environment}/projects/{project}/apis/{api}/client-certificate/renew weikio certificates renew
POST /api/v1/settings/install/certificates/dns/{name}/test weikio certificates dns add
GET /api/v1/agents weikio settings get
PUT /api/v1/settings/install weikio settings set