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

33 lines
1.2 KiB
Markdown
Raw Normal View History

---
id: register
title: /api/client/register
---
2021-05-18 12:07:07 +02:00
> 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](../../user_guide/api-token) and add an Authorization header using the token.
### Client registration
`POST: http://unleash.host.com/api/client/register`
2018-11-22 11:20:28 +01:00
Registers a client instance with the unleash server. The client should send all fields specified.
```json
{
2018-11-22 11:20:28 +01:00
"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:**
2018-11-22 11:20:28 +01:00
- **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](https://en.wikipedia.org/wiki/ISO_8601) time.
- **interval** - At which interval, in milliseconds, will this client be expected to send metrics