Update license information

curl --request POST \
  --url http://10.2.4.166:8080/composer/api/license \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/vnd.composer.v3+json' \
  --data '
{
  "licenseKey": "<string>"
}
'

import requests

url = "http://10.2.4.166:8080/composer/api/license"

payload = { "licenseKey": "<string>" }
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/vnd.composer.v3+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Basic <encoded-value>',
    'Content-Type': 'application/vnd.composer.v3+json'
  },
  body: JSON.stringify({licenseKey: '<string>'})
};

fetch('http://10.2.4.166:8080/composer/api/license', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8080",
  CURLOPT_URL => "http://10.2.4.166:8080/composer/api/license",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'licenseKey' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/vnd.composer.v3+json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://10.2.4.166:8080/composer/api/license"

	payload := strings.NewReader("{\n  \"licenseKey\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/vnd.composer.v3+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://10.2.4.166:8080/composer/api/license")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/vnd.composer.v3+json")
  .body("{\n  \"licenseKey\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://10.2.4.166:8080/composer/api/license")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/vnd.composer.v3+json'
request.body = "{\n  \"licenseKey\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "instanceToken": "<string>",
  "instanceId": "<string>",
  "expirationDate": "<string>",
  "expired": true,
  "licenseKey": "<string>",
  "shouldWarn": true,
  "daysToExpiration": 123,
  "userCount": 123,
  "userCountViolated": true,
  "numberOfUsers": 123,
  "concurrentSessionLimit": 123,
  "numberAllowedInstances": 123,
  "allowedVersions": [
    "<string>"
  ],
  "versionViolated": true,
  "connectors": [
    "<string>"
  ],
  "connectorRestrictionType": "ALLOW",
  "features": {}
}

{
  "instanceToken": "<string>",
  "instanceId": "<string>",
  "expirationDate": "<string>",
  "expired": true,
  "licenseKey": "<string>",
  "shouldWarn": true,
  "daysToExpiration": 123,
  "userCount": 123,
  "userCountViolated": true,
  "numberOfUsers": 123,
  "concurrentSessionLimit": 123,
  "numberAllowedInstances": 123,
  "allowedVersions": [
    "<string>"
  ],
  "versionViolated": true,
  "connectors": [
    "<string>"
  ],
  "connectorRestrictionType": "ALLOW",
  "features": {}
}

{
  "instanceToken": "<string>",
  "instanceId": "<string>",
  "expirationDate": "<string>",
  "expired": true,
  "licenseKey": "<string>",
  "shouldWarn": true,
  "daysToExpiration": 123,
  "userCount": 123,
  "userCountViolated": true,
  "numberOfUsers": 123,
  "concurrentSessionLimit": 123,
  "numberAllowedInstances": 123,
  "allowedVersions": [
    "<string>"
  ],
  "versionViolated": true,
  "connectors": [
    "<string>"
  ],
  "connectorRestrictionType": "ALLOW",
  "features": {}
}

{
  "instanceToken": "<string>",
  "instanceId": "<string>",
  "expirationDate": "<string>",
  "expired": true,
  "licenseKey": "<string>",
  "shouldWarn": true,
  "daysToExpiration": 123,
  "userCount": 123,
  "userCountViolated": true,
  "numberOfUsers": 123,
  "concurrentSessionLimit": 123,
  "numberAllowedInstances": 123,
  "allowedVersions": [
    "<string>"
  ],
  "versionViolated": true,
  "connectors": [
    "<string>"
  ],
  "connectorRestrictionType": "ALLOW",
  "features": {}
}

Update license information

curl --request POST \
  --url http://10.2.4.166:8080/composer/api/license \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/vnd.composer.v3+json' \
  --data '
{
  "licenseKey": "<string>"
}
'

import requests

url = "http://10.2.4.166:8080/composer/api/license"

payload = { "licenseKey": "<string>" }
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/vnd.composer.v3+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Basic <encoded-value>',
    'Content-Type': 'application/vnd.composer.v3+json'
  },
  body: JSON.stringify({licenseKey: '<string>'})
};

fetch('http://10.2.4.166:8080/composer/api/license', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8080",
  CURLOPT_URL => "http://10.2.4.166:8080/composer/api/license",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'licenseKey' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/vnd.composer.v3+json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://10.2.4.166:8080/composer/api/license"

	payload := strings.NewReader("{\n  \"licenseKey\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/vnd.composer.v3+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://10.2.4.166:8080/composer/api/license")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/vnd.composer.v3+json")
  .body("{\n  \"licenseKey\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://10.2.4.166:8080/composer/api/license")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/vnd.composer.v3+json'
request.body = "{\n  \"licenseKey\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "instanceToken": "<string>",
  "instanceId": "<string>",
  "expirationDate": "<string>",
  "expired": true,
  "licenseKey": "<string>",
  "shouldWarn": true,
  "daysToExpiration": 123,
  "userCount": 123,
  "userCountViolated": true,
  "numberOfUsers": 123,
  "concurrentSessionLimit": 123,
  "numberAllowedInstances": 123,
  "allowedVersions": [
    "<string>"
  ],
  "versionViolated": true,
  "connectors": [
    "<string>"
  ],
  "connectorRestrictionType": "ALLOW",
  "features": {}
}

{
  "instanceToken": "<string>",
  "instanceId": "<string>",
  "expirationDate": "<string>",
  "expired": true,
  "licenseKey": "<string>",
  "shouldWarn": true,
  "daysToExpiration": 123,
  "userCount": 123,
  "userCountViolated": true,
  "numberOfUsers": 123,
  "concurrentSessionLimit": 123,
  "numberAllowedInstances": 123,
  "allowedVersions": [
    "<string>"
  ],
  "versionViolated": true,
  "connectors": [
    "<string>"
  ],
  "connectorRestrictionType": "ALLOW",
  "features": {}
}

{
  "instanceToken": "<string>",
  "instanceId": "<string>",
  "expirationDate": "<string>",
  "expired": true,
  "licenseKey": "<string>",
  "shouldWarn": true,
  "daysToExpiration": 123,
  "userCount": 123,
  "userCountViolated": true,
  "numberOfUsers": 123,
  "concurrentSessionLimit": 123,
  "numberAllowedInstances": 123,
  "allowedVersions": [
    "<string>"
  ],
  "versionViolated": true,
  "connectors": [
    "<string>"
  ],
  "connectorRestrictionType": "ALLOW",
  "features": {}
}

{
  "instanceToken": "<string>",
  "instanceId": "<string>",
  "expirationDate": "<string>",
  "expired": true,
  "licenseKey": "<string>",
  "shouldWarn": true,
  "daysToExpiration": 123,
  "userCount": 123,
  "userCountViolated": true,
  "numberOfUsers": 123,
  "concurrentSessionLimit": 123,
  "numberAllowedInstances": 123,
  "allowedVersions": [
    "<string>"
  ],
  "versionViolated": true,
  "connectors": [
    "<string>"
  ],
  "connectorRestrictionType": "ALLOW",
  "features": {}
}

Authorizations

Authorization

string

header

required

HTTP Basic authentication using global administrator credentials (username and password).

Body

application/vnd.composer.v3+json

License update request object contains new license key to update.

licenseKey

string

Response

license successfully updated

License object contains license information.

instanceToken

string

instanceId

string

expirationDate

string

expired

boolean

licenseKey

string

shouldWarn

boolean

daysToExpiration

integer<int64>

userCount

integer<int32>

userCountViolated

boolean

numberOfUsers

integer<int64>

concurrentSessionLimit

integer<int32>

numberAllowedInstances

integer<int32>

allowedVersions

string[]

versionViolated

boolean

connectors

string[]

connectorRestrictionType

enum<string>

Available options:

ALLOW,

BLOCK

features

object

Show child attributes

Release Notes

Administer

Connect to Data

Present Data

Embed and Extend

Reference

Update license information

Authorizations

Body

Response