License Settings

Returns the current license settings.

Request

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

Request

bash

curl -X GET "{BASE_URL}/api/license/settings" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response Body

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

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)

Successful Response (200)

json

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

Error Response (4xx/5xx)

Parameter	Type	Description
`message`	string	Human-readable error message

json

{
  "message": "Error message"
}

Support Needed?

Create a free ticket and our support team will provide you necessary assistance.