1. Packages
  2. Zscaler Internet Access (ZIA)
  3. API Docs
  4. SandboxSubmission
Viewing docs for pulumi-resource-zia v1.3.8
published on Friday, Mar 13, 2026 by Zscaler
Schema (JSON)
zscaler/pulumi-zia

zia.SandboxSubmission

zia logo
Viewing docs for pulumi-resource-zia v1.3.8
published on Friday, Mar 13, 2026 by Zscaler
Schema (JSON)
zscaler/pulumi-zia

    The zia_sandbox_submission resource submits files to the Zscaler cloud sandbox for analysis. Files can be submitted for full analysis or a quick discan (distributed scan). This resource is create-only; there is no remote GET API, and delete is a no-op.

    For more information, see the ZIA Cloud Sandbox Submission documentation.

    Import is not supported for this resource.

    Example Usage

    Submit a File for Sandbox Analysis

    Example coming soon!

    Example coming soon!

    Example coming soon!

    import * as zia from "@bdzscaler/pulumi-zia";

const example = new zia.SandboxSubmission("example", {
    filePath: "/tmp/suspicious-file.exe",
    submissionMethod: "submit",
    force: true,
});

    import zscaler_pulumi_zia as zia

example = zia.SandboxSubmission("example",
    file_path="/tmp/suspicious-file.exe",
    submission_method="submit",
    force=True,
)

    resources:
  example:
    type: zia:SandboxSubmission
    properties:
      filePath: /tmp/suspicious-file.exe
      submissionMethod: submit
      force: true

    Create SandboxSubmission Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new SandboxSubmission(name: string, args: SandboxSubmissionArgs, opts?: CustomResourceOptions);
    @overload
def SandboxSubmission(resource_name: str,
                      args: SandboxSubmissionArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def SandboxSubmission(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      file_path: Optional[str] = None,
                      submission_method: Optional[str] = None,
                      force: Optional[bool] = None)
    func NewSandboxSubmission(ctx *Context, name string, args SandboxSubmissionArgs, opts ...ResourceOption) (*SandboxSubmission, error)
    public SandboxSubmission(string name, SandboxSubmissionArgs args, CustomResourceOptions? opts = null)
    public SandboxSubmission(String name, SandboxSubmissionArgs args)
public SandboxSubmission(String name, SandboxSubmissionArgs args, CustomResourceOptions options)

    type: zia:SandboxSubmission
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args SandboxSubmissionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SandboxSubmissionArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SandboxSubmissionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SandboxSubmissionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SandboxSubmissionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var sandboxSubmissionResource = new Zia.SandboxSubmission("sandboxSubmissionResource", new()
{
    FilePath = "string",
    SubmissionMethod = "string",
    Force = false,
});

    example, err := zia.NewSandboxSubmission(ctx, "sandboxSubmissionResource", &zia.SandboxSubmissionArgs{
	FilePath:         pulumi.String("string"),
	SubmissionMethod: pulumi.String("string"),
	Force:            pulumi.Bool(false),
})

    var sandboxSubmissionResource = new SandboxSubmission("sandboxSubmissionResource", SandboxSubmissionArgs.builder()
    .filePath("string")
    .submissionMethod("string")
    .force(false)
    .build());

    sandbox_submission_resource = zia.SandboxSubmission("sandboxSubmissionResource",
    file_path="string",
    submission_method="string",
    force=False)

    const sandboxSubmissionResource = new zia.SandboxSubmission("sandboxSubmissionResource", {
    filePath: "string",
    submissionMethod: "string",
    force: false,
});

    type: zia:SandboxSubmission
properties:
    filePath: string
    force: false
    submissionMethod: string

    SandboxSubmission Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The SandboxSubmission resource accepts the following input properties:

    FilePath string
    The local file path of the file to submit for sandbox analysis.
    SubmissionMethod string
    The submission method. Valid values: submit (full analysis) or discan (distributed scan).
    Force bool
    Force re-analysis of a previously submitted file. Only applicable for 'submit' method. Not applicable for 'discan'.
    FilePath string
    The local file path of the file to submit for sandbox analysis.
    SubmissionMethod string
    The submission method. Valid values: submit (full analysis) or discan (distributed scan).
    Force bool
    Force re-analysis of a previously submitted file. Only applicable for 'submit' method. Not applicable for 'discan'.
    filePath String
    The local file path of the file to submit for sandbox analysis.
    submissionMethod String
    The submission method. Valid values: submit (full analysis) or discan (distributed scan).
    force Boolean
    Force re-analysis of a previously submitted file. Only applicable for 'submit' method. Not applicable for 'discan'.
    filePath string
    The local file path of the file to submit for sandbox analysis.
    submissionMethod string
    The submission method. Valid values: submit (full analysis) or discan (distributed scan).
    force boolean
    Force re-analysis of a previously submitted file. Only applicable for 'submit' method. Not applicable for 'discan'.
    file_path str
    The local file path of the file to submit for sandbox analysis.
    submission_method str
    The submission method. Valid values: submit (full analysis) or discan (distributed scan).
    force bool
    Force re-analysis of a previously submitted file. Only applicable for 'submit' method. Not applicable for 'discan'.
    filePath String
    The local file path of the file to submit for sandbox analysis.
    submissionMethod String
    The submission method. Valid values: submit (full analysis) or discan (distributed scan).
    force Boolean
    Force re-analysis of a previously submitted file. Only applicable for 'submit' method. Not applicable for 'discan'.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SandboxSubmission resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Code int
    The response status code from the sandbox submission.
    FileType string
    The detected file type of the submitted file.
    Md5 string
    The MD5 hash of the submitted file.
    Message string
    The response message from the sandbox submission.
    SubmissionResult string
    The sandbox submission result string.
    VirusName string
    The virus name if the file is detected as malicious.
    VirusType string
    The virus type if the file is detected as malicious.
    Id string
    The provider-assigned unique ID for this managed resource.
    Code int
    The response status code from the sandbox submission.
    FileType string
    The detected file type of the submitted file.
    Md5 string
    The MD5 hash of the submitted file.
    Message string
    The response message from the sandbox submission.
    SubmissionResult string
    The sandbox submission result string.
    VirusName string
    The virus name if the file is detected as malicious.
    VirusType string
    The virus type if the file is detected as malicious.
    id String
    The provider-assigned unique ID for this managed resource.
    code Integer
    The response status code from the sandbox submission.
    fileType String
    The detected file type of the submitted file.
    md5 String
    The MD5 hash of the submitted file.
    message String
    The response message from the sandbox submission.
    submissionResult String
    The sandbox submission result string.
    virusName String
    The virus name if the file is detected as malicious.
    virusType String
    The virus type if the file is detected as malicious.
    id string
    The provider-assigned unique ID for this managed resource.
    code number
    The response status code from the sandbox submission.
    fileType string
    The detected file type of the submitted file.
    md5 string
    The MD5 hash of the submitted file.
    message string
    The response message from the sandbox submission.
    submissionResult string
    The sandbox submission result string.
    virusName string
    The virus name if the file is detected as malicious.
    virusType string
    The virus type if the file is detected as malicious.
    id str
    The provider-assigned unique ID for this managed resource.
    code int
    The response status code from the sandbox submission.
    file_type str
    The detected file type of the submitted file.
    md5 str
    The MD5 hash of the submitted file.
    message str
    The response message from the sandbox submission.
    submission_result str
    The sandbox submission result string.
    virus_name str
    The virus name if the file is detected as malicious.
    virus_type str
    The virus type if the file is detected as malicious.
    id String
    The provider-assigned unique ID for this managed resource.
    code Number
    The response status code from the sandbox submission.
    fileType String
    The detected file type of the submitted file.
    md5 String
    The MD5 hash of the submitted file.
    message String
    The response message from the sandbox submission.
    submissionResult String
    The sandbox submission result string.
    virusName String
    The virus name if the file is detected as malicious.
    virusType String
    The virus type if the file is detected as malicious.

    Package Details

    Repository
    zia zscaler/pulumi-zia
    License
    zia logo
    Viewing docs for pulumi-resource-zia v1.3.8
    published on Friday, Mar 13, 2026 by Zscaler
    Schema (JSON)
    zscaler/pulumi-zia
      Try Pulumi Cloud free. Your team will thank you.