Client APIRegister SDK

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.

Authentication

Authorizationstring
API key needed to access this API
OR
AuthorizationBearer
API key needed to access this API, in Bearer token format

Request

clientApplicationSchema
appNamestringRequired
An identifier for the app that uses the sdk, should be static across SDK restarts
intervaldoubleRequired>=0

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

startedstring or doubleRequired

Either an RFC-3339 timestamp or a unix timestamp in seconds

strategieslist of stringsRequired
Which strategies the SDKs runtime knows about
instanceIdstringOptional

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

sdkVersionstringOptional

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

platformNamestringOptional
The platform the application is running on. For languages that compile to binaries, this can be omitted
platformVersionstringOptional
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.
yggdrasilVersionstringOptional
The semantic version of the Yggdrasil engine used by the client. If the client is using a native engine this can be omitted.
specVersionstringOptional
The version of the Unleash client specification the client supports
environmentstringOptionalDeprecated

The SDK’s configured ‘environment’ property. This property was deprecated in v5. This property does not control which Unleash environment the SDK gets toggles for. To control Unleash environments, use the SDKs API key.

Response

This response has no body.