1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-10-18 20:09:08 +02:00
unleash.unleash/website/docs/api/client/register-api.md
2021-10-26 11:25:19 +02:00

1.2 KiB

id title
register /api/client/register

In order to access the client API endpoints you need to identify yourself. Unless you're using the none authentication method, you'll need to create a CLIENT token and add an Authorization header using the token.

Client registration

POST: http://unleash.host.com/api/client/register

Registers a client instance with the unleash server. The client should send all fields specified.

{
  "appName": "appName",
  "instanceId": "instanceId",
  "sdkVersion": "unleash-client-java:2.2.0",
  "strategies": ["default", "some-strategy-1"],
  "started": "2016-11-03T07:16:43.572Z",
  "interval": 10000
}

Fields:

  • appName - Name of the application seen by unleash-server
  • instanceId - Instance id for this application (typically hostname, podId or similar)
  • sdkVersion - Optional field that describes the sdk version (name:version)
  • strategies - List of strategies implemented by this application
  • started - When this client started. Should be reported as ISO8601 time.
  • interval - At which interval, in milliseconds, will this client be expected to send metrics