SCscanopy
internal

Exchange online license key for entitlement

Changed on

Called by self-hosted Scanopy servers. The key is the credential, so the endpoint takes no session or API key. Every success records the check-in and returns an entitlement minted from the organization's current plan and paid-through date.

post/api/v1/licenses/entitlement

Request

  • Base URL
    https://app.scanopy.net
  • URL
    https://app.scanopy.net/api/v1/licenses/entitlement
  • Auth
    none declared

Request body

instance_idstring uuid nullable

The random id this server's database holds (server_instance), shared by every container on that database. Absent from servers older than instance counting; those share one instance slot.

keystring required

The online key configured via SCANOPY_LICENSE_KEY.

non_productionboolean nullable

Whether the server was started with SCANOPY_NON_PRODUCTION. Absent from servers older than the setting: they count as production, and the cloud never refuses them a slot.

Response

Entitlement for the key's organization

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

  • c9d9d46d1ae8Revision changes
    • info

      api tag billing removed

  • 29b77b6b0404Revision changes
    • info

      added the new optional request property

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status