Skip to main content

Register a client SDK

POST 
/api/client/register

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.

Request​

Body

required

clientApplicationSchema

    appName stringrequired

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

    Example: example-app
    instanceId string

    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

    Example: b77f3d13-5f48-4a7b-a3f4-a449b97ce43a
    sdkVersion string

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

    Example: unleash-client-java:7.0.0
    environment stringdeprecated

    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.

    Example: development
    platformName string

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

    Example: .NET Core
    platformVersion string

    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.

    Example: 3.1
    yggdrasilVersion string

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

    Example: 1.0.0
    specVersion string

    The version of the Unleash client specification the client supports

    Example: 3.0.0
    interval numberrequired

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

    Example: 10

    started

    object

    required

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

    oneOf

    string

    strategies string[]required

    Which strategies the SDKs runtime knows about

    Example: ["default","gradualRollout","remoteAddress"]

Responses​

This response has no body.

Loading...