nodes/generated

Interface HttpRequestV1NodeParameters

Source
interface HttpRequestV1NodeParameters {
    allowUnauthorizedCerts?: boolean;
    authentication?:
        | "oAuth2"
        | "none"
        | "basicAuth"
        | "digestAuth"
        | "headerAuth"
        | "queryAuth"
        | "oAuth1";
    binaryPropertyName?: string;
    bodyParametersJson?: string;
    bodyParametersUi?: {
        parameter: { name?: string; value?: string }[];
    };
    dataPropertyName?: string;
    headerParametersJson?: string;
    headerParametersUi?: {
        parameter: { name?: string; value?: string }[];
    };
    jsonParameters?: boolean;
    options?: {
        batchInterval?: number;
        batchSize?: number;
        bodyContentCustomMimeType?: string;
        bodyContentType?: | "json"
        | "raw"
        | "multipart-form-data"
        | "form-urlencoded";
        followAllRedirects?: boolean;
        followRedirect?: boolean;
        fullResponse?: boolean;
        ignoreResponseCode?: boolean;
        proxy?: string;
        splitIntoItems?: boolean;
        timeout?: number;
        useQueryString?: boolean;
    };
    queryParametersJson?: string;
    queryParametersUi?: {
        parameter: { name?: string; value?: string }[];
    };
    requestMethod?: | "GET"
    | "POST"
    | "DELETE"
    | "HEAD"
    | "OPTIONS"
    | "PATCH"
    | "PUT";
    responseFormat?: "string"
    | "json"
    | "file";
    sendBinaryData?: boolean;
    url?: string;
}

Properties§

§readonly allowUnauthorizedCerts?: boolean

Whether to download the response even if SSL certificate validation is not possible

§readonly authentication?:
    | "oAuth2"
    | "none"
    | "basicAuth"
    | "digestAuth"
    | "headerAuth"
    | "queryAuth"
    | "oAuth1"

The way to authenticate Default: "none"

§readonly binaryPropertyName?: string

For Form-Data Multipart, they can be provided in the format: "sendKey1:binaryProperty1,sendKey2:binaryProperty2 Default: "data"

§readonly bodyParametersJson?: string

Body parameters as JSON or RAW

§readonly bodyParametersUi?: { ... }

The body parameter to send Default: {} Type options: {"multipleValues":true}

§readonly dataPropertyName?: string

Name of the property to which to write the response data Default: "data"

§readonly headerParametersJson?: string

Header parameters as JSON or RAW

§readonly headerParametersUi?: { ... }

The headers to send Default: {} Type options: {"multipleValues":true}

§readonly jsonParameters?: boolean

Whether the query and/or body parameter should be set via the value-key pair UI or JSON/RAW

§readonly options?: { ... }

Default: {}

§readonly queryParametersJson?: string

Query parameters as JSON (flat object)

§readonly queryParametersUi?: { ... }

The query parameter to send Default: {} Type options: {"multipleValues":true}

§readonly requestMethod?:
    | "GET"
    | "POST"
    | "DELETE"
    | "HEAD"
    | "OPTIONS"
    | "PATCH"
    | "PUT"

The request method to use Default: "GET"

§readonly responseFormat?: "string" | "json" | "file"

The format in which the data gets returned from the URL Default: "json"

§readonly sendBinaryData?: boolean

Whether binary data should be send as body

§readonly url?: string

The URL to make the request to