HTTP Request
App Vendor: Cyware
App Category: Cyware Product
Connector Version: 2.1.1
API Version: 1.0.0
About App
The HTTP request app provides the ability to make GET, POST, PUT, PATCH, and DELETE requests.
The HTTP Request app is configured with the Orchestrate application to perform the following actions:
Action Name | Description |
---|---|
GET Request | This action creates a GET request to the specified endpoint. |
POST Request | This action creates a POST request to the specified endpoint. |
PUT Request | This action creates a PUT request to the specified endpoint. |
POST Request (String Data) | This action creates a POST request to the specified endpoint. |
PATCH Request | This action creates a PATCH request to the specified endpoint. |
DELETE Request | This action creates a DELETE request to the specified endpoint. |
HEAD Request | This action creates a HEAD request to the specified endpoint. |
Configuration Parameters
You can create an instance without any configuration parameter.
Action: GET Request
This action creates a GET request to the specified endpoint.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
---|---|---|---|---|
URL | Enter the URL to create a GET request. Example: https://www.example.com | Text | Required | |
Headers | Enter the header value in the form of key-value pairs. Example: "authorization": "bearer token" | Key Value | Optional | |
Query Parameters | Enter the query parameters in the form of key-value pairs. | Key Value | Optional | |
Auth Type | Enter the authentication type. Example: BASIC | Text | Optional | Allowed values:
|
Auth Values | Enter the authentication values in the form of key-value pairs. | Key Value | Optional | |
Username | Enter the username for auth values. | Text | Optional | |
Password | Enter the password for auth values. | Password | Optional | |
Content Type | Enter the content type. Example: JSON | Text | Optional | Allowed values:
|
Data Type | Enter the data type that needs to be passed in the GET request. Example: key-value, text, list, any, etc | Text | Optional | |
Data | Enter the data that needs to be passed in the GET request. | Any | Optional | |
Timeout | Enter the timeout value (in seconds) for the API request. | Integer | Optional | Default value: 60 |
Example Request
[ { "url": "https://www.example.com", "headers": { "authorization": "bearer token" } "auth_type": "BASIC", "username": "john.doe", "password": "strongpassword", "content_type": "JSON", } ]
Action: POST Request
This action creates a POST request to the specified endpoint.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
---|---|---|---|---|
URL | Enter the URL to create a POST request. Example: https://www.example.com | Text | Required | |
Headers | Enter the header value in the form of key-value pairs. Example: {"authorization": "bearer token"} | Key Value | Optional | |
Query Parameters | Enter the query parameters in the form of key-value pairs. | Key Value | Optional | |
Auth Type | Enter the authentication type. Example: BASIC | Text | Optional | Allowed values:
|
Auth Values | Enter the authentication values in the form of key-value pairs. | Key Value | Optional | |
Username | Enter the username for auth values. | Text | Optional | |
Password | Enter the password for auth values. | Password | Optional | |
Content Type | Enter the content type. Example: JSON | Text | Optional | Allowed values:
|
Data Type | Enter the data type. | Text | Optional | |
Data | Enter the data that needs to be passed in the POST request. | Any | Optional | |
Timeout | Enter the timeout value (in seconds) for the API request. | Integer | Optional | Default value: 60 |
Example Request
[ { "url": "https://www.example.com", "headers": { "authorization": "bearer token" } "auth_type": "BASIC", "username": "john.doe", "password": "strongpassword", "content_type": "JSON", } ]
Action: PUT Request
This action creates a PUT request to the specified endpoint.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
---|---|---|---|---|
URL | Enter the URL to create a PUT request. Example: https://www.example.com | Text | Required | |
Headers | Enter the header value in the form of key-value pairs. Example: {"authorization": "bearer token"} | Key Value | Optional | |
Query Parameters | Enter the query parameters in the form of key-value pairs. | Key Value | Optional | |
Auth Type | Enter the authentication type. Example: BASIC | Text | Optional | Allowed values:
|
Username | Enter the username for auth values. | Text | Optional | |
Password | Enter the password for auth values. | Password | Optional | |
Auth Values | Enter the authentication values in the form of key-value parameters. | Key Value | Optional | |
Content Type | Enter the content type. Example: JSON | Text | Optional | Allowed values:
|
Data Type | Enter the data type. | Text | Optional | |
Data | Enter the data that needs to be passed in the put request. | Any | Optional | |
Timeout | Enter the timeout value (in seconds) for the API request. | Integer | Optional | Default value: 60 |
Example Request
[ { "url": "https://www.example.com", "headers": { "authorization": "bearer token" } "auth_type": "BASIC", "username": "john.doe", "password": "strongpassword", "content_type": "JSON", } ]
Action: POST Request (String Data)
This action creates a POST request to the specified endpoint.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
---|---|---|---|---|
URL | Enter the URL to create a POST request. Example: https://www.example.com | Text | Required | |
Data | Enter the data that needs to be passed in the POST request. | Text | Optional | |
Headers | Enter the header value in the form of key-value pairs. Example: {"authorization": "bearer token"} | Key Value | Optional | |
Username | Enter the username to authenticate. | Text | Optional | |
Password | Enter the password to authenticate. | Password | Optional | |
Timeout | Enter the timeout value (in seconds) for the API request. | Integer | Optional | Default value: 60 |
Example Request
[ { "url": "https://www.example.com", "headers": { "authorization": "bearer token" }, "username": "john.doe", "password": "strongpassword" } ]
Action: PATCH Request
This action creates a PATCH request to the specified endpoint.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
---|---|---|---|---|
URL | Enter the URL to create a PATCH request. Example: https://www.example.com | Text | Required | |
Headers | Enter the header value in the form of key-value pairs. Example: {"authorization": "bearer token"} | Key Value | Optional | |
Query Parameters | Enter the query parameters in the form of key-value pairs. | Key Value | Optional | |
Auth Type | Enter the authentication type for your request. Example: BASIC | Text | Optional | Allowed values:
|
Auth Values | Enter the authentication values in the form of key-value pairs. | Key Value | Optional | |
Username | Enter the username for auth values. | Text | Optional | |
Password | Enter the username for auth values. | Password | Optional | |
Content Type | Enter the content type. Example: JSON | Text | Optional | Allowed values:
|
Data Type | Enter the data type. | Text | Optional | |
Data | Enter the data that needs to be passed in the PATCH request. | Any | Optional | |
Timeout | Enter the timeout value (in seconds) for the API request. | Integer | Optional | Default value: 60 |
Example Request
[ { "url": "https://www.example.com", "headers": { "authorization": "bearer token" } "auth_type": "BASIC", "username": "john.doe", "password": "strongpassword", "content_type": "JSON", } ]
Action: DELETE Request
This action creates a DELETE request to the specified endpoint.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
---|---|---|---|---|
URL | Enter the URL to create a DELETE request. Example: https://www.example.com | Text | Required | |
Headers | Enter the header value in the form of key-value pairs. Example: {"authorization": "bearer token"} | Key Value | Optional | |
Query Parameters | Enter the query parameters in the form of key-value pairs. | Key Value | Optional | |
Auth Type | Enter the authentication type. Example: BASIC | Text | Optional | Allowed values:
|
Auth Values | Enter the authentication values in the form of key-value pairs. | Key Value | Optional | |
Username | Enter the username for auth values. | Text | Optional | |
Password | Enter the password for auth values. | Password | Optional | |
Content Type | Enter the content type. Example: JSON | Text | Optional | Allowed values:
|
Data Type | Enter the data type. | Text | Optional | |
Data | Enter the data that needs to be passed in the DELETE request. | Any | Optional | |
Timeout | Enter the timeout value (in seconds) for the API request. | Default value: 60 |
Example Request
[ { "url": "https://www.example.com", "headers": { "authorization": "bearer token" } "auth_type": "BASIC", "username": "john.doe", "password": "strongpassword", "content_type": "JSON", } ]