2018-11-20 20:34:42 +01:00
---
id: register
title: /api/client/register
---
2017-06-28 23:13:29 +02:00
refactor: move docs into new structure / fix links for SEO (#2416)
## What
This (admittedly massive) PR updates the "physical" documentation
structure and fixes url inconsistencies and SEO problems reported by
marketing. The main points are:
- remove or move directories : advanced, user_guide, deploy, api
- move the files contained within to the appropriate one of topics,
how-to, tutorials, or reference
- update internal doc links and product links to the content
- create client-side redirects for all the urls that have changed.
A number of the files have been renamed in small ways to better match
their url and to make them easier to find. Additionally, the top-level
api directory has been moved to /reference/api/legacy/unleash (see the
discussion points section for more on this).
## Why
When moving our doc structure to diataxis a while back, we left the
"physical' files lying where they were, because it didn't matter much to
the new structure. However, that did introduce some inconsistencies with
where you place docs and how we organize them.
There's also the discrepancies in whether urls us underscores or hyphens
(which isn't necessarily the same as their file name), which has been
annoying me for a while, but now has also been raised by marketing as an
issue in terms of SEO.
## Discussion points
The old, hand-written API docs have been moved from /api to
/reference/api/legacy/unleash. There _is_ a /reference/api/unleash
directory, but this is being populated by the OpenAPI plugin, and mixing
those could only cause trouble. However, I'm unsure about putting
/legacy/ in the title, because the API isn't legacy, the docs are. Maybe
we could use another path? Like /old-docs/ or something? I'd appreciate
some input on this.
2022-11-22 10:05:30 +01: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](/how-to/how-to-create-api-tokens) and add an Authorization header using the token.
2021-05-18 11:19:33 +02:00
2021-06-04 11:17:15 +02:00
### Client registration {#client-registration}
2017-06-28 23:13:29 +02:00
`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.
2017-06-28 23:13:29 +02:00
```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
2017-06-28 23:13:29 +02:00
}
```
**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
