Skip to main content

Cyware Orchestrate

Simple HTTP Request

App Vendor: Simple HTTP Request

App Category: IT Services

Connector Version: 1.0.2

API Version: v1.0

About App

This app makes simple HTTP requests.

The Simple HTTP Request app is configured with the Orchestrate application to perform the following actions:

Action Name

Description

Make Request

This action makes a simple HTTP request.

Configuration Parameters

The Simple HTTP Request app does not require any configuration parameter.

Action: Make Request

This action makes a simple HTTP request.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

HTTP method

Enter the HTTP method.

Examples:

  • GET

  • POST

  • PATCH

  • PUT

  • DELETE

Text

Required

URL

Enter the complete URL to make a request.

Example:

"https://www.cyware.com/users"

Text

Required

Headers

Enter the request headers.

Example:

{'accept':'application/json'}

Key Value

Optional

Query Parameters

Enter the query parameters to send with the request.

Example:

$JSON[{"username": "bob", "password": "password"}]

JSON

Optional

JSON Payload

Enter the payload in JSON format to send with the request body.

Example:

$JSON[{"ticket_id":1234}]

JSON

Optional

Payload

Enter the additional payload to send with the request.

Example:

$LIST[1234,3421]

Any

Optional

Timeout

Enter the request timeout in seconds.

Example:

120

Integer

Optional

Default value:

60

Verify SSL

Choose to verify the SSL certificates for HTTPS connections.

Example:

true

Boolean

Optional

Allowed values:

  • true

  • false

Default value:

false

Basic Authentication

Enter the user credential to perform basic authentication.

Any

Optional

Files

Enter the files that you want to upload.

Example:

{'file': 'file_path'}

Key Value

Optional

Downloads

Choose to download the response data.

Example:

true

Boolean

Optional

Allowed values:

  • true

  • false

Default value:

false

Filename

Enter the filename.

Example:

"temp_file"

Text

Optional

Default value:

"temp_file"

Custom Success Message

Enter the message that you want to display after a successful HTTP request.

Example:

"Successfully completed the request."

Any

Optional

Custom error message

Enter the message that you want to display after an unsuccessful HTTP request.

"Failed to complete the request."

Any

Optional

Example Request

[
   {
      "http_method":"put",
      "url":"https://www.cyware.com/users",
      "headers":{
         "accept":"application/json"
      },
      "query_parameters":{
         "username":"bob",
         "password":"password"
      },
      "json_payload":{
         "ticket_id":1234
      },
      "data_payload":[
         1234,
         3421
      ],
      "timeout":120,
      "verify_ssl":true,
      "files":{
         "file":"file_path"
      },
      "download":true,
      "filename":"temp_file",
      "custom_output":"Successfully completed the request.",
      "error_msg":"Failed to complete the request."
   }
]