mirror of
https://github.com/Unleash/unleash.git
synced 2025-04-01 01:18:10 +02:00
33 lines
1.2 KiB
Markdown
33 lines
1.2 KiB
Markdown
---
|
|
id: register
|
|
title: /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](/user_guide/api-token) and add an Authorization header using the token.
|
|
|
|
### Client registration {#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.
|
|
|
|
```json
|
|
{
|
|
"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](https://en.wikipedia.org/wiki/ISO_8601) time.
|
|
- **interval** - At which interval, in milliseconds, will this client be expected to send metrics
|