---
updatedAt: 2026-05-12T09:59:42.000Z
---

# Retrieve provisioning licenses

This operation returns an object containing provisioning licenses for the current user's client, including dummy licenses.

# OpenAPI definition

```json
{
  "components": {
    "schemas": {
      "ErrorMessage": {
        "description": "ErrorMessage describes the error",
        "properties": {
          "code": {
            "format": "int64",
            "type": "integer"
          },
          "reason": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "license": {
        "description": "license contains details about a license",
        "properties": {
          "available": {
            "format": "int64",
            "type": "integer"
          },
          "consumed": {
            "format": "int64",
            "type": "integer"
          },
          "purchased": {
            "format": "int64",
            "type": "integer"
          },
          "serviceLevel": {
            "type": "string"
          },
          "subtype": {
            "type": "string"
          },
          "type": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "licensesMessage": {
        "description": "licensesMessage contains a list of licenses, their capacities, and other details",
        "properties": {
          "collection": {
            "items": {
              "$ref": "#/components/schemas/license"
            },
            "type": "array"
          },
          "doNotProvisionFromParent": {
            "type": "boolean"
          },
          "page": {
            "$ref": "#/components/schemas/licensesPageData"
          }
        },
        "type": "object"
      },
      "licensesPageData": {
        "description": "licensesPageData contains page data for licenses requests",
        "properties": {
          "filteredCount": {
            "format": "int64",
            "type": "integer"
          },
          "totalCount": {
            "format": "int64",
            "type": "integer"
          }
        },
        "type": "object"
      }
    }
  },
  "info": {
    "license": {
      "name": "(c) Copyright 2020 WhiteHat Security"
    },
    "title": "Licenses API",
    "version": "2.0.0"
  },
  "openapi": "3.0.1",
  "paths": {
    "/api/provisioningLicenses": {
      "get": {
        "description": "This operation returns an object containing provisioning licenses for the current user's client, including dummy licenses.",
        "operationId": "provisioningLicensesReq",
        "parameters": [
          {
            "description": "Sort results based on the specified license property",
            "in": "query",
            "name": "sort",
            "schema": {
              "type": "string",
              "x-go-name": "Sort"
            },
            "x-go-name": "Sort"
          },
          {
            "description": "Filter results to licenses of the specified type (i.e. sast, dast, api, or mobile) <br><br>**NOTE:** Must be lower case.",
            "in": "query",
            "name": "type",
            "schema": {
              "type": "string",
              "x-go-name": "Type"
            },
            "x-go-name": "Type"
          },
          {
            "description": "Filter results to licenses of the specified subtype",
            "in": "query",
            "name": "subtype",
            "schema": {
              "type": "string",
              "x-go-name": "Subtype"
            },
            "x-go-name": "Subtype"
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/licensesMessage"
                }
              }
            },
            "description": "LicensesResponse provides a list of licenses and their capacities"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            },
            "description": "BadRequestResponse indicates a request with invalid parameters"
          },
          "401": {
            "description": "UnauthorizedResponse signals an unauthorized API access"
          }
        },
        "summary": "Retrieve provisioning licenses",
        "tags": [
          "Licenses API v2.0"
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://sentinel.whitehatsec.com/"
    }
  ],
  "tags": [
    {
      "name": "Licenses API v2.0"
    }
  ],
  "x-explorer-enabled": false,
  "x-readme": {
    "proxy-enabled": true
  }
}
```