REST Options

Reference documentation for using the REST API REST Options action

Written By Support Channel

Last updated 8 months ago

Overview of the REST Options action

The REST Options action allows a workflow to send an HTTP OPTIONS request to a RESTful API endpoint. This method is primarily used to determine the HTTP methods and capabilities supported by a resource, without initiating a data transfer.

Purpose	To retrieve metadata about a target URL and the HTTP methods allowed.
Parameters	Headers 1 URL
Output	Status, OK, Error, Client Error, Server Error, Accepted, No Content, Bad Request, Not Authorised, Not Acceptable, Not Found, Forbidden, Text, Body, Type, Char Set

Understanding the REST Options action

The REST Options action sends an HTTP OPTIONS request to a specified API endpoint and is primarily used to determine what HTTP methods (such as REST Get, REST Post, etc.) are supported by that resource.

Headers

A list of header names and values for the API request. For example:

Content-Type: “application/json”
Authorisation: “rest_api_key=1234”

URL

Specify the endpoint where the OPTIONS request should be sent.

Working with REST Options action

This action is especially useful for pre-flight checks in cross-origin requests or for confirming available operations before proceeding with other REST actions.

This action does not return a message body. This action’s purpose is to retrieve metadata about the endpoint’s communication capabilities without transferring resource content.

It's ideal for workflows that need to validate method availability or integration compatibility before executing further steps.

Output Variables

Output	Code	Type	Description
Status	—	Text	Shows the HTTP Status Code of request.
OK	200	Boolean	The request was successful, and the response contains the expected data.
Accepted	202	Boolean	The request was accepted for processing, but the processing has not been completed.
No Content	204	Boolean	The request was successful, but there is no content in the response.
Bad Request	400	Boolean	The server could not understand the request due to invalid syntax or parameters.
Not Authorised	401	Boolean	The request was denied due to invalid or missing authentication credentials.
Forbidden	403	Boolean	The request is valid, but the server is refusing to fulfil it.
Not Found	404	Boolean	The resource requested could not be found on the server.
Not Acceptable	406	Boolean	The requested format is not supported by the server.
Client Error	4xx	Boolean	Any status in the 400–499 range indicating a client-side error.
Server Error	5xx	Boolean	Any status in the 500–599 range indicating a server-side error.
Error	—	Text	A general error occurred, such as connection failure or timeout.
Text	—	Text	Plain text of the body of the the request
Body	—	Text	Data received in response to request sent
Type	—	Text	Media type of the response body. For example `application/json`
Char Set	—	Text	The character encoding used in the response.For example `UTF-8`

Create and manage REST Options actions

Add a REST Options action

Add the action

Use the following steps to add the action to your workflow.

Configure the action

Use the following steps to configure the action.

Click Add Header to create a new header entry. This reveals the Header popup.
Select Header and type the name of the header.
Select Value and input the value of the header
Click OK to complete setup of your new field value.
Repeat the above steps for any addition additional headers needed.
Set a value for the URL.
Click back in the main view to hide the slide-over.

Edit the action

Use the following steps to make changes to the action.

Edit an existing Header entry by clicking on it. This displays the Edit Header popup and allows you to make changes.
Remove an unwanted entry by clicking the red cross toward its right-side.
Click back in the main view to hide the slide-over.

Delete a REST Options action

Use the following steps to remove the action from your workflow:

Take care when deleting an action to also remove any logic using its outputs: workflow steps may function incorrectly or break if they attempt to evaluate an output of a deleted action.