---
updatedAt: 2026-05-12T09:58:52.000Z
---

# Create scan instance

This operation enables you to create a source application scan instance for the specified cloud upload application.

# OpenAPI definition

```json
{
  "components": {
    "schemas": {
      "CloudApplicationScanParamsBody": {
        "properties": {
          "binaryExclusion": {
            "description": "Package exclusions\n\nValid characters: AlphaNumeric and special characters \"_\" \"-\" \".\"",
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "excludeFiles": {
            "description": "File and directory exclusions",
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "fileName": {
            "description": "Name of the file uploaded",
            "type": "string"
          },
          "scanTag": {
            "description": "Tag for the scan instance",
            "type": "string"
          },
          "uploadID": {
            "description": "ID of the file uploaded",
            "type": "string"
          }
        },
        "required": [
          "fileName",
          "scanTag",
          "uploadID"
        ],
        "type": "object"
      },
      "ErrorMessage": {
        "description": "ErrorMessage describes the error",
        "properties": {
          "code": {
            "format": "int64",
            "type": "integer"
          },
          "reason": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "ProvisionedCloudScan": {
        "description": "CloudScan holds the response of a cloud scan instance created",
        "properties": {
          "appID": {
            "description": "ID of the application for which scan instance has been created",
            "format": "int64",
            "type": "integer"
          },
          "fileName": {
            "description": "File name of the artifact used for instance",
            "type": "string"
          },
          "id": {
            "description": "ID of the cloud scan instance",
            "format": "int64",
            "type": "integer"
          },
          "instanceID": {
            "description": "ID of the scan instance",
            "format": "int64",
            "type": "integer"
          },
          "requestedBy": {
            "description": "User requesting the scan",
            "format": "int64",
            "type": "integer"
          },
          "tag": {
            "description": "Tag of the application",
            "type": "string"
          },
          "uploadedOn": {
            "description": "Time the artifact uploaded",
            "format": "date-time",
            "type": "string"
          }
        },
        "type": "object"
      }
    }
  },
  "info": {
    "license": {
      "name": "(c) Copyright 2020 WhiteHat Security"
    },
    "title": "Source Applications API",
    "version": "2.0.0"
  },
  "openapi": "3.0.1",
  "paths": {
    "/api/sourceApplications/{cloudAppID}/scans": {
      "post": {
        "description": "This operation enables you to create a source application scan instance for the specified cloud upload application.",
        "operationId": "CloudApplicationScanParams",
        "parameters": [
          {
            "description": "Cloud upload application ID",
            "in": "path",
            "name": "cloudAppID",
            "required": true,
            "schema": {
              "format": "int64",
              "type": "integer",
              "x-go-name": "ID"
            },
            "x-go-name": "ID"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CloudApplicationScanParamsBody"
              }
            }
          },
          "description": "Body of the request holds the data to input when creating an application scan instance",
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProvisionedCloudScan"
                }
              }
            },
            "description": "Response from creating an application scan instance"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            },
            "description": "BadRequestResponse indicates a request with invalid parameters"
          },
          "403": {
            "description": "ForbiddenResponse signals a request for a resource that does not exist or is not authorized"
          },
          "404": {
            "description": "NotFoundResponse indicates a request for a resource that does not exist"
          },
          "409": {
            "description": "ScanConflictResponse is returned when a new scan is requested while a scan is already in progress for the given application"
          },
          "500": {
            "description": "GenericError generic error"
          }
        },
        "summary": "Create scan instance",
        "tags": [
          "Source Applications API v2.0"
        ],
        "x-codegen-request-body-name": "body"
      }
    }
  },
  "servers": [
    {
      "url": "https://sentinel.whitehatsec.com/"
    }
  ],
  "tags": [
    {
      "name": "Source Applications API v2.0"
    }
  ],
  "x-explorer-enabled": false,
  "x-readme": {
    "proxy-enabled": true
  }
}
```