Setup

Generate a signed local license request

Changed on Jun 19, 2026

post/license-request/generate

Request

Base URL
https://api.example.com/api/platform/setup/v1
Auth
none required
TypeScript
https://skmtc.dev/sphereon-opensource/apis/platform-setup-api/docs/license-request/generate/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

algorithmstring nullable

usestring nullable

serialNumberinteger nullable

Example request

{
  "deployment": {
    "deployment": {
      "baseDomains": [
        "edk.example.com"
      ]
    }
  }
}

Response

Signed license request to deliver manually to the license issuer.

requestJsonstring required

artifactDigeststring nullable

Example response

{
  "request": {
    "deployment": {
      "baseDomains": [
        "edk.example.com"
      ]
    },
    "localPublicKey": {
      "providerId": "license"
    }
  }
}

Changes

Jun 19, 2026ef25767f07be Revision changes
- breaking
  added the new required request property /
- breaking
  added the new required request property /
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
Jun 15, 20262dff14597aa9 Revision changes
- breaking
  added the new required request property /
- breaking
  added the new required request property /
- breaking
  the request property / became required
- breaking
  request property / list-of-types was narrowed by removing types null from media type application/json
- breaking
  removed the required property // from the response with the status
- warning
  removed the request property
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property
- info
  added the optional property to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status

Operation history (3 revisions)