Settings and Server Info

All PUT endpoints update only the fields present in the body; see Updating Resources.

GET`/v1/settings`GET /v1/settings

Code samples

cURL


# You can also use wget
curl -X GET /v1/settings \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/settings',
{
  method: 'GET',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/settings";
      var result = await GetAsync(url);
    }
 
    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);
 
        //Validate result
        response.EnsureSuccessStatusCode();
 
    }
    
    
    
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /v1/settings

Gets the application settings.

Parameters

Name	In	Type	Required	Description
request	query	Management.GetSettingsRequest	false	The request containing the parameters for the application settings to retrieve.

Example responses

200 Response


{"success":true,"code":0,"message":"string","settings":[{"group":"string","name":"string","type":"string","value":null}]}


{
  "success": true,
  "code": 0,
  "message": "string",
  "settings": [
    {
      "group": "string",
      "name": "string",
      "type": "string",
      "value": null
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.GetSettingsResponse

Authentication: API key (x-api-key).

PUT`/v1/settings`PUT /v1/settings

Code samples

cURL


# You can also use wget
curl -X PUT /v1/settings \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


const inputBody = '{
  "settings": [
    {
      "group": "string",
      "name": "string",
      "type": "string",
      "value": null
    }
  ]
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/settings',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    
    /// Make a dummy request
    public async Task MakePutRequest()
    {
      int id = 1;
      string url = "/v1/settings";
 
      
      string json = @"{
  ""settings"": [
    {
      ""group"": ""string"",
      ""name"": ""string"",
      ""type"": ""string"",
      ""value"": null
    }
  ]
}";
      Management.UpdateSettingsRequest content = JsonConvert.DeserializeObject(json);
      var result = await PutAsync(id, content, url);
      
          
    }
 
    /// Performs a PUT Request
    public async Task PutAsync(int id, Management.UpdateSettingsRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);
 
        //Execute PUT request
        HttpResponseMessage response = await Client.PutAsync(url + $"/{id}", jsonContent);
 
        //Return response
        return await DeserializeObject(response);
    }
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Management.UpdateSettingsRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);
 
        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

PUT /v1/settings

Updates the application settings.

Body parameter


{
  "settings": [
    {
      "group": "string",
      "name": "string",
      "type": "string",
      "value": null
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	Management.UpdateSettingsRequest	false	The request containing the updated settings.

Example responses

200 Response


{"success":true,"code":0,"message":"string"}


{
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.UpdateSettingsResponse

Authentication: API key (x-api-key).

GET`/v1/info`GET /v1/info

Code samples

cURL


# You can also use wget
curl -X GET /v1/info \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/info',
{
  method: 'GET',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/info";
      var result = await GetAsync(url);
    }
 
    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);
 
        //Validate result
        response.EnsureSuccessStatusCode();
 
    }
    
    
    
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /v1/info

Gets the server information.

Example responses

200 Response


{"success":true,"code":0,"message":"string","product":"string","edition":0,"version":"string","license":"string","serverHost":"string","serverTime":"2019-08-24T14:15:22Z","clientAddress":"string","activeTokens":0,"maxTokens":0,"activationTokens":0,"floatingTokens":0,"expiredTokens":0,"totalLicenses":0,"revokedLicenses":0,"tracedLicenses":0,"activationLicenses":0,"floatingLicenses":0,"fileLicenses":0}


{
  "success": true,
  "code": 0,
  "message": "string",
  "product": "string",
  "edition": 0,
  "version": "string",
  "license": "string",
  "serverHost": "string",
  "serverTime": "2019-08-24T14:15:22Z",
  "clientAddress": "string",
  "activeTokens": 0,
  "maxTokens": 0,
  "activationTokens": 0,
  "floatingTokens": 0,
  "expiredTokens": 0,
  "totalLicenses": 0,
  "revokedLicenses": 0,
  "tracedLicenses": 0,
  "activationLicenses": 0,
  "floatingLicenses": 0,
  "fileLicenses": 0
}

Responses

Status	Meaning	Description
200	OK	The server information has been retrieved successfully. Example:
{
“Product”: “Babel Licensing Service”,
“Version”: “10.7.0"
"ServerHost”: “172.34.12.1"
"ServerTime”: “2022-01-01T00:00:00Z”,
…
}	Management.GetServerInfoResponse

Authentication: API key (x-api-key).

Settings and Server Info

GET/v1/settingsGET /v1/settings

Code samples

cURL

JavaScript

C#

Parameters

Responses

PUT/v1/settingsPUT /v1/settings

Code samples

cURL

JavaScript

C#

Parameters

Responses

GET/v1/infoGET /v1/info

Code samples

cURL

JavaScript

C#

Responses

GET`/v1/settings`GET /v1/settings

PUT`/v1/settings`PUT /v1/settings

GET`/v1/info`GET /v1/info