https.request(options)

Method Description

Sends an HTTPS request.

Important:

If negotiating a connection to the destination server exceeds 5 seconds, a connection timeout occurs. If transferring a payload to the server exceeds 45 seconds, a request timeout occurs. This may result in the SSS_REQUEST_TIME_EXCEEDED error.

Returns

https.ClientResponse or https.ServerResponse

Supported Script Types

Client and server scripts

For more information, see SuiteScript 2.x Script Types.

Governance

10 units

Module

N/https Module

Since

2015.2

Parameters

Note:

The options parameter is a JavaScript object.

Parameter	Type	Required / Optional	Description	Since
`options.method`	enum	required	The HTTPS request method. Use https.Method to set this value.	2015.2
`options.url`	string	required	The HTTPS URL being requested.	2015.2
`options.body`	string \| Object	optional	The POST data if the method is `POST`. The PUT data if the method is `PUT`. Note: If the method is `DELETE`, this body data is ignored.	2015.2
`options.credentials`	string[]	optional	An array of string GUIDs. These GUIDS are searched for in the `options.body` of the request and are replaced by the decrypted passwords before they are sent to a third-party server.	2015.2
`options.headers`	Object	optional	The HTTPS headers. For more information, see HTTPS Header Information.	2015.2

Parameter

Type

Required / Optional

Description

Since

options.method

enum

required

The HTTPS request method. Use https.Method to set this value.

2015.2

options.url

string

required

The HTTPS URL being requested.

2015.2

options.body

string | Object

optional

The POST data if the method is POST. The PUT data if the method is PUT.

Note:

If the method is DELETE, this body data is ignored.

2015.2

options.credentials

string[]

optional

An array of string GUIDs. These GUIDS are searched for in the options.body of the request and are replaced by the decrypted passwords before they are sent to a third-party server.

2015.2

options.headers

Object

optional

The HTTPS headers.

For more information, see HTTPS Header Information.

2015.2

Errors

Error Code	Message	Thrown If
`SSS_INVALID_HOST_CERT`	An untrusted, unsupported, or invalid certificate was found for this host.	The client and server could not negotiate the desired level of security. The connection is no longer usable. You may also receive this error if the domain name in the `options.url` parameter is spelled incorrectly or does not use valid syntax. Verify that the domain name: Has 63 or fewer characters Contains alphanumeric characters (a-z, A-Z, 0-9) or hyphens Starts with a letter Ends with a letter or digit
`SSS_INVALID_URL`	The URL must be a fully qualified HTTP/HTTPS URL.	An invalid URL is specified in the `options.url` parameter.
`SSS_MISSING_REQD_ARGUMENT`	Missing a required argument: {param name}	The `options.method` or `options.url` parameter is not specified.
`SSS_REQUEST_LOOP_DETECTED`	This script executes a recursive function that has exceeded the limit for the number of times a script can call itself using an HTTP request. Please examine the script for a potential infinite recursion problem.	A script is calling back into itself recursively using an HTTP/HTTPS request.
`SSS_REQUEST_TIME_EXCEEDED`	The host you are trying to connect to has exceeded the maximum allowed response time.	If negotiating a connection to the destination server exceeds 5 seconds, a connection timeout occurs. If transferring a payload to the server exceeds 45 seconds, a request timeout occurs.

Error Code

Message

Thrown If

SSS_INVALID_HOST_CERT

An untrusted, unsupported, or invalid certificate was found for this host.

The client and server could not negotiate the desired level of security. The connection is no longer usable.

You may also receive this error if the domain name in the options.url parameter is spelled incorrectly or does not use valid syntax. Verify that the domain name:

Has 63 or fewer characters
Contains alphanumeric characters (a-z, A-Z, 0-9) or hyphens
Starts with a letter
Ends with a letter or digit

SSS_INVALID_URL

The URL must be a fully qualified HTTP/HTTPS URL.

An invalid URL is specified in the options.url parameter.

SSS_MISSING_REQD_ARGUMENT

Missing a required argument: {param name}

The options.method or options.url parameter is not specified.

SSS_REQUEST_LOOP_DETECTED

This script executes a recursive function that has exceeded the limit for the number of times a script can call itself using an HTTP request. Please examine the script for a potential infinite recursion problem.

A script is calling back into itself recursively using an HTTP/HTTPS request.

SSS_REQUEST_TIME_EXCEEDED

The host you are trying to connect to has exceeded the maximum allowed response time.

If negotiating a connection to the destination server exceeds 5 seconds, a connection timeout occurs. If transferring a payload to the server exceeds 45 seconds, a request timeout occurs.

Syntax

Important:

The following code sample shows the syntax for this member. It is not a functional example. For a complete script example, see N/https Module Script Samples.

          // Add additional code 
...
var headerObj = {
    name: 'Accept-Language',
    value: 'en-us'
};
var response = https.request({
    method: https.Method.GET,
    url: 'https://www.testwebsite.com',
    body: 'My REQUEST Data',
    headers: headerObj
});
...
// Add additional code

Parameters

Errors

Syntax

Related Topics