---
title: "POST /api/v1/licenses"
method: POST
path: "/api/v1/licenses"
tags: ["Licenses"]
---

# POST /api/v1/licenses

`POST /api/v1/licenses`

## Request

- Base URL: `https://api.immy.bot` (the document declares no server; this is the origin it was published from)
- URL: `https://api.immy.bot/api/v1/licenses`
- Auth: none declared

## Request body

- CreateLicenseRequestBody
  - `name` string, nullable, required
  - `licenseValue` string, nullable, required
  - `softwareType` 'GlobalSoftware' | 'LocalSoftware' | 'WindowsUpdate' | 'Chocolatey' | 'Ninite': The string or integer value may be used. GlobalSoftware = 0, LocalSoftware = 1, WindowsUpdate = 2, Chocolatey = 3, Ninite = 4
  - `softwareIdentifier` string, nullable, required
  - `softwareName` string, nullable: Set in controller, not by the frontend
  - `semanticVersion` SemanticVersion
    - `major` integer
    - `minor` integer
    - `patch` integer
    - `releaseLabels` string[], nullable
    - `release` string, nullable
    - `isPrerelease` boolean
    - `hasMetadata` boolean
    - `metadata` string, nullable
  - `tenantId` integer, nullable
  - `restrictToMajorVersion` boolean

## Response `200`

OK

- GetLicenseResponse
  - `id` integer
  - `name` string, nullable, required
  - `licenseValue` string, nullable
  - `softwareType` 'GlobalSoftware' | 'LocalSoftware' | 'WindowsUpdate' | 'Chocolatey' | 'Ninite': The string or integer value may be used. GlobalSoftware = 0, LocalSoftware = 1, WindowsUpdate = 2, Chocolatey = 3, Ninite = 4
  - `softwareIdentifier` string, nullable, required
  - `softwareName` string, nullable, required
  - `semanticVersion` SemanticVersion
    - `major` integer
    - `minor` integer
    - `patch` integer
    - `releaseLabels` string[], nullable
    - `release` string, nullable
    - `isPrerelease` boolean
    - `hasMetadata` boolean
    - `metadata` string, nullable
  - `restrictToMajorVersion` boolean
  - `tenantId` integer, nullable
  - `tenantName` string, nullable
  - `updatedBy` string, nullable
  - `updatedDate` string, date-time
  - `createdDate` string, date-time

---

[API](https://skmtc.dev/immy/apis/immy-bot-api.md) · [All operations](https://skmtc.dev/immy/apis/immy-bot-api/llms.txt) · [OpenAPI document](https://skmtc.dev/immy/apis/immy-bot-api/revisions/559d0e4b39d3?raw)
