Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2024-10-18 20:09:08 +02:00
Code Issues Projects Releases Wiki Activity
ddad9e27a3
unleash.unleash/docs/api/client/register-api.md
Denis Dzyubenko 570bdd9f90 Fixed typos and broken links in the documentation
2020-02-20 08:34:12 +01:00

1012 B
Raw Blame History

This document describes the client registration endpoints

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 ISO8610 time.
  • interval - At which interval, in milliseconds, will this client be expected to send metrics