v7

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-015406837.0 KB

Client

Register a client SDK

Register a client SDK with Unleash. SDKs call this endpoint on startup to tell Unleash about their existence. Used to track custom strategies in use as well as SDK versions.

post/api/client/register

Request body

appNamestring required

An identifier for the app that uses the sdk, should be static across SDK restarts

instanceIdstring

A unique identifier identifying the instance of the application running the SDK. Often changes based on execution environment. For instance: two pods in Kubernetes will have two different instanceIds

sdkVersionstring

An SDK version identifier. Usually formatted as "unleash-client-<language>:<version>"

platformNamestring

The platform the application is running on. For languages that compile to binaries, this can be omitted

platformVersionstring

The version of the platform the application is running on. Languages that compile to binaries, this is expected to be the compiler version used to assemble the binary.

yggdrasilVersionstring

The semantic version of the Yggdrasil engine used by the client. If the client is using a native engine this can be omitted.

specVersionstring

The version of the Unleash client specification the client supports

sdkFlavorstring

The identifier of an integration built on top of an Unleash SDK (e.g. an OpenFeature provider). Sent so adoption of the integration can be tracked alongside sdkVersion.

sdkFlavorVersionstring

The version of the integration identified by sdk flavor, that has been built on top of an Unleash SDK

intervalnumber required

How often (in seconds) does the client refresh its toggles

strategiesstring[] required

Which strategies the SDKs runtime knows about

Example request

{
  "appName": "example-app",
  "instanceId": "b77f3d13-5f48-4a7b-a3f4-a449b97ce43a",
  "sdkVersion": "unleash-client-java:7.0.0",
  "platformName": ".NET Core",
  "platformVersion": "3.1",
  "yggdrasilVersion": "1.0.0",
  "specVersion": "3.0.0",
  "sdkFlavor": "unleash-openfeature-node-provider",
  "sdkFlavorVersion": "1.0.1",
  "interval": 10,
  "strategies": [
    "default",
    "gradualRollout",
    "remoteAddress"
  ]
}

Response

This response has no body.