• 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': [ { 'key': 'Content-Type', 'value': 'application/json' } ], 'environment': '' } ]

The profiles configured for this resource in an environment

Environment Profile

Propprofiles[]
Typeobject

A profile of this resource for an environment

Base URL

Propprofiles[].baseURL
Typestring

The base URL for all requests on this resource.

Default Headers

Propprofiles[].headers
Typearray

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

Header

Propprofiles[].headers[]
Typeobject

A header key-value pair to attach to the request

Header key

Propprofiles[].headers[].key
Typestring

The header key

Header value

Propprofiles[].headers[].value
Typestring

The value of the specified header

Environment

Propprofiles[].environment
Typestring

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")GET
bodyTypeCodeEditorInputFieldBodyTypes ("text/plain" | "application/json")application/json
Last updated on November 1, 2022