HTTP Step Reference
You can use the HTTP step to run HTTP methods containing URLs, methods, headers, assertions, and variables.
This topic describes the settings for the HTTP step.
In this topic:
- Name
- Timeout
- URL
- Method
- Request Body
- Assertion
- Headers
- Output
- Step Execution Inputs and Outputs
- Advanced Settings
- Header Capability Check
- See Also
Name
The name of the step. You'll use this name when you reference this step's settings.
For example, if the step name is HTTP and you want to reference the URL entered in its URL setting, you would use:
<+pipeline.stages.tooltips.spec.execution.steps.HTTP.spec.url>
Timeout
The timeout for this step. You can use:
wfor weeksdfor dayshfor hoursmfor minutessfor secondsmsfor milliseconds
The maximum is 53w.
Timeouts can be set at the Pipeline level also.
URL
The URL for the HTTP call.
Method
The HTTP method to use in the step.
Request Body
The message body of the HTTP message.
Assertion
The assertion is used to validate the incoming response. For example, if you wanted to check the health of an HTTP connection, you could use the assertion <+httpResponseCode> == 200.
The expression <+httpResponseCode> == 200 will evaluate to true if the HTTP call returns a 200 code.
Expressions can use the following aliases to refer to the HTTP responses, URL, and method:
<+httpResponseCode><+httpUrl><+httpMethod><+httpResponseBody>
Headers
Enter the media type for the message. For example, if you are using the GET method, the headers are used to specify the GET response body message type Harness will check for.
For example, in Key, enter Token .
In Value, enter <+secrets.getValue("aws-playground_AWS_secret_key")>.
Another example:
- Key:
variable: - Value:
var1,var2:var3
Output
Create output variables to be used by other steps in the stage. The Value setting can contain any HTTP step input, output, or response information.
You can also use JSON and XML functors in the values for the output variable. For example, <+json.select("data.attributes.version_pins.mvn-service://new-construction-api", httpResponseBody)>.
Step Execution Inputs and Outputs
Once you execute your Pipeline, the step displays its inputs and outputs and their values.
You can reference these anywhere in your Pipeline.
Inputs
Input Name | Input Reference Example Step name: HTTP | Input Value Example |
identifier |
| check_response |
name |
| check response |
timeout |
| 10s |
type |
| Http |
url |
| https://www.google.com/search?q= |
method |
| GET |
requestBody |
| current+date |
assertion |
|
|
Outputs
Output | Output Reference Example Step Name: HTTP | Output Value Example |
httpUrl |
|
|
httpMethod |
|
|
httpResponseCode |
|
|
httpResponseBody |
|
|
status |
|
|
Advanced Settings
In Advanced, you can use the following options:
Header Capability Check
When Harness runs an HTTP step and connects to a service, it checks to make sure that an HTTP connection can be established.
Some services require that HTTP headers are included in connections. Without the headers, the HTTP connections fail and simple HTTP verification cannot be performed.
Harness performs an HTTP header capability check for any header requirements on the target service.
If the target host server requires headers and you do not include headers in the Headers setting of the HTTP step, the Harness Delegate will fail the deployment with the error No eligible Delegates could perform this task (error 400).
Simply add the required headers in Headers, and then run the deployment. Adding the headers will prevent the 400 error.