HTTPRequest

A node with the ability to send HTTP(S) requests.

A node with the ability to send HTTP requests. Uses internally.

Can be used to make HTTP requests, i.e. download or upload files or web content via HTTP.

Warning: See the notes and warnings on HTTPClient for limitations, especially regarding SSL security.

Example of contacting a REST API and printing one of its returned fields:

Example of loading and displaying an image using HTTPRequest:

    # Create an HTTP request node and connect its completion signal.
    var http_request = HTTPRequest.new()
    add_child(http_request)
    http_request.connect("request_completed", self, "_http_request_completed")
    # Perform the HTTP request. The URL below returns a PNG image as of writing.
    var error = http_request.request("https://via.placeholder.com/512")
    if error != OK:
        push_error("An error occurred in the HTTP request.")
func _http_request_completed(result, response_code, headers, body):
    var image = Image.new()
    var error = image.load_png_from_buffer(body)
    if error != OK:
    var texture = ImageTexture.new()
    texture.create_from_image(image)
    # Display the image in a TextureRect node.
    var texture_rect = TextureRect.new()
    add_child(texture_rect)
    texture_rect.texture = texture

Tutorials

• Making HTTP requests

Methods

• request_completed ( int result, response_code, PoolStringArray headers, body )

Emitted when a request is completed.

Enumerations

enum Result:

• RESULT_SUCCESS = 0 —- Request successful.

• RESULT_CHUNKED_BODY_SIZE_MISMATCH = 1

• RESULT_CANT_CONNECT = 2 —- Request failed while connecting.

• RESULT_CANT_RESOLVE = 3 —- Request failed while resolving.

• RESULT_SSL_HANDSHAKE_ERROR = 5 —- Request failed on SSL handshake.

• RESULT_NO_RESPONSE = 6 —- Request does not have a response (yet).

• RESULT_BODY_SIZE_LIMIT_EXCEEDED = 7 —- Request exceeded its maximum size limit, see .

• RESULT_REQUEST_FAILED = 8 —- Request failed (currently unused).

• RESULT_DOWNLOAD_FILE_CANT_OPEN = 9 —- HTTPRequest couldn’t open the download file.

• RESULT_DOWNLOAD_FILE_WRITE_ERROR = 10 —- HTTPRequest couldn’t write to the download file.

• RESULT_REDIRECT_LIMIT_REACHED = 11 —- Request reached its maximum redirect limit, see max_redirects.

• RESULT_TIMEOUT = 12

• int body_size_limit

Maximum allowed size for response bodies (-1 means no limit). When only small files are expected, this can be used to prevent disallow receiving files that are too large, preventing potential denial of service attacks.

• download_chunk_size

The size of the buffer used and maximum bytes to read per iteration. See HTTPClient.read_chunk_size.

Set this to a lower value (e.g. 4096 for 4 KiB) when downloading small files to decrease memory usage at the cost of download speeds.

• download_file

The file to download into. If set to a non-empty string, the request output will be written to the file located at the path. If a file already exists at the specified location, it will be overwritten as soon as body data begins to be received.

Note: Folders are not automatically created when the file is created. If download_file points to a subfolder, it’s recommended to create the necessary folders beforehand using to ensure the file can be written.

• int max_redirects

Maximum number of allowed redirects. This is used to prevent endless redirect loops.

• timeout

If set to a value greater than 0.0 before the request starts, the HTTP request will time out after timeout seconds have passed and the request is not completed yet. For small HTTP requests such as REST API usage, set timeout to a value between 10.0 and 30.0 to prevent the application from getting stuck if the request fails to get a response in a timely manner. For file downloads, leave this to 0.0 to prevent the download from failing if it takes too much time.

• use_threads

If true, multithreading is used to improve performance.

Method Descriptions

• void cancel_request ( )

Cancels the current request.

• get_body_size ( ) const

Returns the response body length.

Note: Some Web servers may not send a body length. In this case, the value returned will be -1. If using chunked transfer encoding, the body length will also be -1.

• int get_downloaded_bytes ( ) const

Returns the amount of bytes this HTTPRequest downloaded.

• get_http_client_status ( ) const

Returns the current status of the underlying HTTPClient. See .

• Error request ( url, PoolStringArray custom_headers=PoolStringArray( ), ssl_validate_domain=true, Method method=0, request_data=”” )

Creates request on the underlying HTTPClient. If there is no configuration errors, it tries to connect using and passes parameters onto HTTPClient.request.

Returns if request is successfully created. (Does not imply that the server has responded), @GlobalScope.ERR_UNCONFIGURED if not in the tree, if still processing previous request, @GlobalScope.ERR_INVALID_PARAMETER if given string is not a valid URL format, or if not using thread and the HTTPClient cannot connect to host.

Note: When method is , the payload sent via request_data might be ignored by the server or even cause the server to reject the request (check RFC 7231 section 4.3.1 for more details). As a workaround, you can send data as a query string in the URL. See for an example.

• Error request_raw ( url, PoolStringArray custom_headers=PoolStringArray( ), ssl_validate_domain=true, Method method=0, request_data_raw=PoolByteArray( ) )

Creates request on the underlying HTTPClient using a raw array of bytes for the request body. If there is no configuration errors, it tries to connect using and passes parameters onto HTTPClient.request.

Returns if request is successfully created. (Does not imply that the server has responded), @GlobalScope.ERR_UNCONFIGURED if not in the tree, if still processing previous request, @GlobalScope.ERR_INVALID_PARAMETER if given string is not a valid URL format, or if not using thread and the HTTPClient cannot connect to host.

Sets the proxy server for HTTP requests.

The proxy server is unset if host is empty or port is -1.

• void set_https_proxy ( host, int port )

The proxy server is unset if is empty or port is -1.