Register a client SDK

POST /api/frontend/client/register

This is for future use. Currently Frontend client registration is not supported. Returning 200 for clients that expect this status code. If the Frontend API is disabled 404 is returned.

Request

application/json

Body

required

frontendApiClientSchema

• appName string required

  Name of the application using Unleash

• instanceId string

  Instance id for this application (typically hostname, podId or similar)

• sdkVersion string

  Optional field that describes the sdk version (name:version)

• environment string deprecated

  deprecated

• interval number required

  At which interval, in milliseconds, will this client be expected to send metrics

• started objectrequired

  When this client started. Should be reported as ISO8601 time.

  oneOf

  MOD1

  string date-time

  MOD2

  number
• strategies string[] required

  List of strategies implemented by this application

Responses

• 200
• 400
• 401
• 404

---

This response has no body.

The request data does not match what we expect.

application/json

Schema

Schema

• id string

  The ID of the error instance

• name string

  The name of the error kind

• message string

  A description of what went wrong.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "ValidationError",
  "message": "The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent []."
}

Authorization information is missing or invalid. Provide a valid API token as the authorization header, e.g. authorization:*.*.my-admin-token.

application/json

Schema

Schema

• id string

  The ID of the error instance

• name string

  The name of the error kind

• message string

  A description of what went wrong.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "AuthenticationRequired",
  "message": "You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login."
}

The requested resource was not found.

application/json

Schema

Schema

• id string

  The ID of the error instance

• name string

  The name of the error kind

• message string

  A description of what went wrong.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NotFoundError",
  "message": "Could not find the addon with ID \"12345\"."
}

Loading...