SCscanopy
internal

Create license key

Changed on

Mints a license key for this organization's self-hosted servers. Online keys work on any plan with a self-hosted license. Offline keys need a plan with air-gapped deployment.

post/api/v1/licenses/keys

Request

  • Base URL
    https://app.scanopy.net
  • URL
    https://app.scanopy.net/api/v1/licenses/keys
  • Auth
    • API key in header Authorization
    • or API key in cookie session_id

Request body

key_type'Online' | 'Offline' required

The two keys an org owner can copy for a self-hosted server. An organization has one of these issued at a time, stored on the org row.

Serde keeps the API spelling ("Online" / "Offline"); strum supplies the snake_case text the column is stored as, the way PlanStatus does.

Response

Signed license key

errorstring nullable

Not sent on a successful response. Failure messages arrive in an ApiErrorResponse.

successboolean required

Always true on a successful response.

Example response

{
  "meta": {
    "api_version": 1,
    "server_version": "0.19.4"
  }
}

Changes