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
| Prop | profiles |
|---|---|
| Type | array |
| Default | [ { 'baseURL': '', 'headers': [], 'authentication': { 'authenticationType': 'None' }, 'environment': '' } ] |
The profiles configured for this resource in an environment
Environment Profile
| Prop | profiles[] |
|---|---|
| Type | object |
| Default | undefined |
A profile of this resource for an environment
Base URL
| Prop | profiles[].baseURL |
|---|---|
| Type | string |
| Default | undefined |
The base URL for all requests on this resource.
Default Headers
| Prop | profiles[].headers |
|---|---|
| Type | array |
| Default | undefined |
The default header values to be used for all requests from this resource.
Header
| Prop | profiles[].headers[] |
|---|---|
| Type | object |
| Default | undefined |
A header key-value pair to attach to the request
Header key
| Prop | profiles[].headers[].key |
|---|---|
| Type | string |
| Default | undefined |
The header key
Header value
| Prop | profiles[].headers[].value |
|---|---|
| Type | string |
| Default | undefined |
The value of the specified header
Description
| Prop | profiles[].headers[].description |
|---|---|
| Type | string |
| Default | undefined |
The description of the specified header
Authentication
| Prop | profiles[].authentication |
|---|---|
| Type | object |
| Default | undefined |
Authentication headers for the resource.
Authentication Type
| Prop | profiles[].authentication.authenticationType |
|---|---|
| Type | Authentication Type ('None' | 'Basic' | 'Bearer' | 'API Key') |
| Default | undefined |
Authentication type
Username
| Prop | profiles[].authentication.username |
|---|---|
| Type | string |
| Default | undefined |
Username for basic auth
Password
| Prop | profiles[].authentication.password |
|---|---|
| Type | ({ ref: string } | undefined) |
| Default | undefined |
Password for basic auth
Bearer Token
| Prop | profiles[].authentication.token |
|---|---|
| Type | ({ ref: string } | undefined) |
| Default | undefined |
Bearer token
Header
| Prop | profiles[].authentication.apiKeyHeader |
|---|---|
| Type | ({ ref: string } | undefined) |
| Default | undefined |
API Key Header
Value
| Prop | profiles[].authentication.apiKeyValue |
|---|---|
| Type | ({ ref: string } | undefined) |
| Default | undefined |
API Key Value
Environment
| Prop | profiles[].environment |
|---|---|
| Type | string |
| Default | undefined |
The name of the environment with which this profile is associated
Actions
Perform HTTP Request
Makes an HTTP request and returns the response body.
| Parameter | Type | Default |
|---|---|---|
path | string | undefined |
body | string | undefined |
headers | array | undefined |
method | HTTPMethodTypes ("GET" | "POST" | "PUT" | "DELETE" | "OPTIONS" | "PATCH") | GET |
bodyType | CodeEditorInputFieldBodyTypes ("text/plain" | "application/json" | "multipart/form-data") | application/json |
responseBodyType | HTTPResponseBodyTypes ("auto" | "text" | "json" | "data" | "base64") | auto |
queryParams | array | undefined |