HTTP

Sends an HTTP request.

Object Representation (YAML)

id: String
name: String
depends: [String]
tags: [String]
condition: String
ignore_errors: Boolean
properties:
  credential: Credential
  url: String
  method: String
  headers:
    - key: String
      value: String
  status_code: Number
  timeout: Number
  validate_certs: Boolean
  dest: String

Fields

PropertyDetails
id *

String

A unique identifier for the step.

Can contain hyphens and underscores, but not spaces.

name *

String

A friendly name for the step. This name will appear in the pipeline designer and run output.

depends[]

[String]

A list of dependencies of this step.

This step will not be executed until all steps with ids in this list are finished executing.

tags[]

[String]

Tags are used to group related steps. Steps with the same tag can be retrieved using the findStepsByTag() helper function.

Can contain hyphens and underscores, but not spaces.

condition

String

An expression which is evaluated before the step executes. If it evaluates to false, the step will be skipped. The step.result.status field will be "Skipped".

ignore_errors

Boolean

If true, errors in the step module will not halt pipeline execution, and subsequent steps will still be executed. The step.result.status field will be "Failed" if the step encounters an error.

properties.credential

Credential

The ID of a credential to use for HTTP authentication. Supported credential types are Username/Password (for Basic authentication) and Bearer Token.

properties.url *

String

URL of the web endpoint, including path and query params.

properties.method *

String

HTTP request method. One of GET, PUT, POST, PATCH, DELETE, HEAD.

properties.headers[]

[Object]

A list of HTTP headers.

properties.headers[].key

String

The header key/name.

properties.headers[].value

String

The header value.

properties.status_code

Number

Status code indicating success. Throws an error if the response status code does not match this value. Defaults to 200.

properties.timeout

Number

Request timeout. Throws an error if the request does not complete within this number of seconds.

properties.validate_certs

Boolean

Whether to ignore HTTPS certificate validation errors.

properties.dest

String

If provided, the HTTP response body will be written to a file at this path.

Result Fields

The following are the step execution result fields available at step.result after a step executes.

KeyDetails
result.status

String

A string indicating the step execution status. Can be Succeeded, Failed, or Skipped.

result.status_code

Number

The HTTP response status code.

result.status_text

String

The HTTP response status text, such as OK or Forbidden.

result.headers

Object

The HTTP response headers as an object.

result.body

Mixed

HTTP response body. If the response Content-Type is a variant of application/json, this value will be an object. Otherwise it will be a string.