Script API - v1.20.60
    Preparing search index...

    Main object for structuring a request.

    Index

    Constructors

    Properties

    body: string

    Content of the body of the HTTP request.

    This property can't be edited in read-only mode.

    headers: HttpHeader[]

    A collection of HTTP headers to add to the outbound request.

    This property can't be edited in read-only mode.

    HTTP method (e.g., GET or PUT or PATCH) to use for making the request.

    This property can't be edited in read-only mode.

    timeout: number

    Amount of time, in seconds, before the request times out and is abandoned.

    This property can't be edited in read-only mode.

    uri: string

    The HTTP resource to access.

    This property can't be edited in read-only mode.

    Methods

    • Beta

      Parameters

      Returns HttpRequest

      Adds an additional header to the overall list of headers used in the corresponding HTTP request.

      This function can't be called in read-only mode.

    • Beta

      Parameters

      • body: string

      Returns HttpRequest

      Updates the content of the body of the HTTP request.

      This function can't be called in read-only mode.

    • Beta

      Parameters

      Returns HttpRequest

      Replaces and applies a set of HTTP Headers for the request.

      This function can't be called in read-only mode.

    • Beta

      Parameters

      • timeout: number

      Returns HttpRequest

      This function can't be called in read-only mode.