PowerKeys Scripting API
    Preparing search index...

    Interface HttpUploadFileOptions

    Options for a streamed script-workspace file upload.

    interface HttpUploadFileOptions {
        url: string;
        path: string;
        method?: "POST" | "PUT" | "PATCH";
        headers?: Record<string, string>;
        maxBytes?: number;
    }
    Index
    url path method? headers? maxBytes?
    url: string

    Absolute http or https URL.

    path: string

    Workspace-relative path using forward or backward slashes. Rejected when absolute, drive- or UNC-prefixed, containing .., longer than 512 bytes, deeper than 16 components, or crossing a link or reparse point.

    method?: "POST" | "PUT" | "PATCH"

    Upload method. Defaults to PUT. Any other method is rejected; use HTTP.SendRequest for methods without a file body.

    headers?: Record<string, string>

    Request headers. Client-owned framing headers are rejected exactly as in HTTP.SendRequest.

    maxBytes?: number

    Optional caller safety limit in bytes. Must be a non-negative integer up to Number.MAX_SAFE_INTEGER; exceeding it rejects with limit_exceeded. Omit for no product file-size cap.

    Settings
    Member Visibility

    On This Page
    Properties