Reference
Nodes
Resources
REST API

REST API Resource

The HTTP Request Resource provides an efficient way to communicate with RESTful HTTP APIs, such as your own server's backend.

Properties

Environment Profiles

Propprofiles
Typearray
Default[ { 'baseURL': '', 'headers': [], 'authentication': { 'authenticationType': 'None' }, 'environment': '' } ]

The profiles configured for this resource in an environment

Environment Profile

Propprofiles[]
Typeobject
Defaultundefined

A profile of this resource for an environment

Base URL

Propprofiles[].baseURL
Typestring
Defaultundefined

The base URL for all requests on this resource.

Default Headers

Propprofiles[].headers
Typearray
Defaultundefined

The default header values to be used for all requests from this resource.

Header

Propprofiles[].headers[]
Typeobject
Defaultundefined

A header key-value pair to attach to the request

Header key

Propprofiles[].headers[].key
Typestring
Defaultundefined

The header key

Header value

Propprofiles[].headers[].value
Typestring
Defaultundefined

The value of the specified header

Description

Propprofiles[].headers[].description
Typestring
Defaultundefined

The description of the specified header

Authentication

Propprofiles[].authentication
Typeobject
Defaultundefined

Authentication headers for the resource.

Authentication Type

Propprofiles[].authentication.authenticationType
TypeAuthentication Type ('None' | 'Basic' | 'Bearer' | 'API Key')
Defaultundefined

Authentication type

Username

Propprofiles[].authentication.username
Typestring
Defaultundefined

Username for basic auth

Password

Propprofiles[].authentication.password
Type({ ref: string } | undefined)
Defaultundefined

Password for basic auth

Bearer Token

Propprofiles[].authentication.token
Type({ ref: string } | undefined)
Defaultundefined

Bearer token

Header

Propprofiles[].authentication.apiKeyHeader
Type({ ref: string } | undefined)
Defaultundefined

API Key Header

Value

Propprofiles[].authentication.apiKeyValue
Type({ ref: string } | undefined)
Defaultundefined

API Key Value

Environment

Propprofiles[].environment
Typestring
Defaultundefined

The name of the environment with which this profile is associated

Actions

Perform HTTP Request

Makes an HTTP request and returns the response body.

ParameterTypeDefault
pathstringundefined
bodystringundefined
headersarrayundefined
methodHTTPMethodTypes ("GET" | "POST" | "PUT" | "DELETE" | "OPTIONS" | "PATCH")GET
bodyTypeCodeEditorInputFieldBodyTypes ("text/plain" | "application/json" | "multipart/form-data")application/json
responseBodyTypeHTTPResponseBodyTypes ("auto" | "text" | "json" | "data" | "base64")auto
queryParamsarrayundefined