Register a client SDK | Unleash Documentation

This is for future use. Currently Frontend client registration is not supported. Returning 200 for clients that expect this status code. If the Frontend API is disabled 404 is returned.

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

API key needed to access this API, in Bearer token format

Request

frontendApiClientSchema

appNamestringRequired

Name of the application using Unleash

intervaldoubleRequired

At which interval, in milliseconds, will this client be expected to send metrics

startedstring or doubleRequired

When this client started. Should be reported as ISO8601 time.

strategieslist of stringsRequired

List of strategies implemented by this application

instanceIdstringOptional

Instance id for this application (typically hostname, podId or similar)

sdkVersionstringOptional

Optional field that describes the sdk version (name:version)

environmentstringOptionalDeprecated

deprecated

Response

This response has no body.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

API key needed to access this API

API key needed to access this API, in Bearer token format

frontendApiClientSchema

Name of the application using Unleash

At which interval, in milliseconds, will this client be expected to send metrics

When this client started. Should be reported as ISO8601 time.

List of strategies implemented by this application

Instance id for this application (typically hostname, podId or similar)

Optional field that describes the sdk version (name:version)

This response has no body.

$	curl -X POST https://app.unleash-instance.example.com/api/frontend/client/register \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"appName": "MyFrontendApp",
>	"interval": 15000,
>	"started": "2024-01-15T09:30:00Z",
>	"strategies": [
>	"default",
>	"userWithId"
>	]
>	}'

$	curl -X POST https://app.unleash-instance.example.com/api/frontend/client/register \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"appName": "MyFrontendApp",
>	"interval": 15000,
>	"started": "2024-01-15T09:30:00Z",
>	"strategies": [
>	"default",
>	"userWithId"
>	]
>	}'