Endpoint /license/register

POST https://example.com/license/register

POST

Registers DS Server locally based on a given license string (not serial number).

Examples

The following sample registers DS Server with the Text Control store and returns a license string.

# Request:
curl --request GET 'https://trial.dsserver.io/license/registeronline?serial=yourserialnumber' \
    --header 'Authorization: Basic e3t1c2VyX25hbWV9fTp7e3Bhc3N3b3JkfX0='

# Result:
GHGHJ678GTZEJBJD643HJDGJGD565678HHJDHHD

Authorization

This endpoint supports the Basic authorization method:

Basic

Header Field Description
Authorization

The username "admin" and your admin password are combined into a string separated by a colon, e.g.: admin:password. The resulting string is encoded using the RFC2045-MIME variant of Base64, except not limited to 76 char/line. The authorization method and a space i.e. "Basic " is then put before the encoded string. For example:

Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l

Request Payload

Type Value
RegistrationInfo The RegistrationInfo object object contains the given license string and information, if this request is a renewal or new installation.

RegistrationInfo

Name Type Value Optional
txTextControlLicense String The given license string. no
renew Boolean Specifies whether this request is a new license or a renew request. no

Success Response

Status Description
200 On success, the HTTP status code in the response header is 200 (OK). The return value contains the license string.

Error Response

Status Description
401 A 401 (Unauthorized) is returned, if the user is not authorized.
400 A 400 (Bad Request) is returned, if the serial number has a bad format.