License Settings

Returns the current license settings.

Request

Property Value
Method GET
URL /api/license/settings
Content-Type application/json
Authentication Bearer Token

Response

Status Codes

Code Description
200 Success
400 Bad Request - Invalid parameters
401 Unauthorized - Invalid or missing token
429 Too Many Requests - Rate limit exceeded
500 Internal Server Error

Successful Response (200)

{
  "data": {
    "attributes": {
      "licenseKey": {
        "value": "developer",
        "editable": true,
        "masked": true
      }
    }
  },
  "meta": {
    "executionTime": 0,
    "generatedAt": 1764230177871
  }
}

Response Body

Parameter Type Description
data.attributes.licenseKey.value string The license key (masked if masked is true)
data.attributes.licenseKey.editable boolean Indicates if the license key can be modified via API
data.attributes.licenseKey.masked boolean Indicates if the license key value is masked
data.attributes.licenseKey.lockedBy string Identifier of the entity that locked this field (e.g., environment variable)
meta.executionTime integer Request processing time in milliseconds
meta.generatedAt integer Response generation timestamp (Unix timestamp in ms)

Error Response (4xx/5xx)

{
  "message": "Error message"
}

Error Response Body

Parameter Type Description
message string Human-readable error message