---
updatedAt: 2026-05-12T09:57:27.000Z
---

# Create a new appliance

This operation allows you to request a new appliance. <br><br>**NOTE:** Hardware appliances are no longer supported.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Appliance API (Legacy)",
    "license": {
      "name": "(c) Copyright 2020 WhiteHat Security"
    },
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://sentinel.whitehatsec.com"
    }
  ],
  "paths": {
    "/api/appliance": {
      "post": {
        "tags": [
          "Appliance API v1.0"
        ],
        "summary": "Create a new appliance",
        "description": "This operation allows you to request a new appliance. <br><br>**NOTE:** Hardware appliances are no longer supported.",
        "operationId": "createApplianceRequest",
        "parameters": [],
        "requestBody": {
          "description": "Holds the information to create new appliance.",
          "content": {
            "application/json": {
              "encoding": {},
              "schema": {
                "$ref": "#/components/schemas/ApplianceRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "Provides information of appliance.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Appliance"
                }
              },
              "application/xml": {
                "example": "XML preview is currently not supported."
              }
            }
          },
          "400": {
            "description": "BadRequestResponse indicates a request with invalid parameters.",
            "content": {}
          },
          "401": {
            "description": "UnauthorizedResponse signals an unauthorized API access.",
            "content": {}
          },
          "403": {
            "description": "ForbiddenResponse signals a request for a resource that does not exist or is not authorized.",
            "content": {}
          },
          "404": {
            "description": "NotFound The requested resource could not be found.",
            "content": {}
          },
          "500": {
            "description": "GenericError generic error.",
            "content": {}
          }
        },
        "deprecated": false
      }
    }
  },
  "components": {
    "schemas": {
      "VM": {
        "properties": {
          "md5sig": {
            "type": "string"
          },
          "filename": {
            "type": "string"
          },
          "href": {
            "type": "string"
          },
          "size": {
            "type": "number"
          }
        }
      },
      "Appliance": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "hardware_shipped": {
            "type": "boolean"
          },
          "client": {
            "type": "number"
          },
          "type": {
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "appliance_name": {
            "type": "string"
          },
          "satellite_id": {
            "type": "number"
          },
          "hardware": {
            "type": "boolean"
          },
          "label": {
            "type": "string"
          },
          "cloud_request_progress": {
            "type": "number",
            "nullable": true
          },
          "last_connected_t": {
            "type": "string",
            "nullable": true
          },
          "migration_status_value": {
            "type": "string",
            "nullable": true
          },
          "parent_appliance_id": {
            "type": "string",
            "nullable": true
          },
          "vm": {
            "$ref": "#/components/schemas/VM"
          }
        }
      },
      "ApplianceRequest": {
        "type": "object",
        "properties": {
          "label": {
            "type": "string",
            "description": "New appliance's label."
          },
          "type": {
            "type": "string",
            "description": "New appliance's type (It can be \"sast\" or \"dast\").",
            "enum": [
              "sast",
              "dast"
            ]
          },
          "hardware": {
            "type": "boolean",
            "description": "Hardware appliances are no longer supported, so this should always be set to ''false''.",
            "enum": [
              false
            ]
          }
        }
      }
    }
  },
  "x-explorer-enabled": false,
  "x-readme": {
    "proxy-enabled": true
  }
}
```