---
title: "POST /vendor-api/get-licenses"
method: POST
path: "/vendor-api/get-licenses"
---

# POST /vendor-api/get-licenses

`POST /vendor-api/get-licenses`

## Request

- Base URL: `http://localhost:2000`
- URL: `http://localhost:2000/vendor-api/get-licenses`
- Auth: none declared
- TypeScript: <https://skmtc.dev/synopsys/apis/synopsys-cloud-openlink-api-specification/docs/vendor-api/get-licenses/post.ts> (a function with typed inputs; its response is checked against the schema)

## Headers

- `x-api-key` string

## Request body

- ProvideLicenseRequestDto
  - `customer` Customer, required
    - `name` string, required: Customer Name
    - `dunsNumber` string, required: Customer DUNS Number
    - `synopsysCustomerId` string, required: Synopsys Customer Id
    - `vendorCustomerInfo` object: Vendor Specific Customer Details
  - `licenseRequests` LicenseRequestItem[]: List of requested licenses
    - `title` string, required: Title of the entitlement
    - `aux` object: Internal identification of the entitlement
    - `qty` number: Maximum available quantity
  - `host` LicenseHostInfo, required
    - `id` string, required: Host Id
    - `name` string, required: Host name

## Response `200`

- ProvideLicenseResponse
  - `files` union[], required
    - union
      - ProvideSyncDataItemResponse
        - `fileName` string, required: Filename
        - `fileType` string, required: Filetype
        - `data` string, byte, required: The base64 encoded file data
        - `downloadType` 'Sync', required: Sync
      - ProvideAsyncDataItemResponse
        - `fileName` string, required: Filename
        - `fileType` string, required: Filetype
        - `downloadApi` ApiBase, required
          - `url` string, required: Remote Url (POST) to trigger item action
          - `header` object: Fixed header to be send on item url request
          - `staticBody` object: Fixed body parameters merged into the body to be send on item url request
        - `pollStartDateTime` string: ISO date-time string from which the URL can be tried to download from
        - `pollIntervalSec` number: Seconds between poll intervals
        - `downloadType` 'Sync', required: Async download

## Other responses

- `400`

---

[API](https://skmtc.dev/synopsys/apis/synopsys-cloud-openlink-api-specification.md) - [All operations](https://skmtc.dev/synopsys/apis/synopsys-cloud-openlink-api-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/synopsys/apis/synopsys-cloud-openlink-api-specification/revisions/20d9e4dbf0ed?raw)