HTTP File

An HTTP file artifact is a reference to a file stored in plaintext and reachable via HTTP.

These artifacts are generally consumed by stages that read configuration from text files, such as a Deploy Manifest stage.

A file represented by an HTTP file artifact can be downloaded using HTTP Basic authentication.

HTTP file artifact in the UI

The pipeline UI exposes the following fields for the HTTP file artifact:

FieldExplanation
AccountAn HTTP artifact account.
URLThe fully-qualified URL from which the file can be read.

In a trigger

When configuring certain triggers, you can use an HTTP file as an expected artifact.

Configuring HTTP file fields in a pipeline trigger’s expected artifact settings.

Configuring HTTP file fields in a pipeline trigger’s expected artifact settings.

In a pipeline stage

When configuring a “Deploy (Manifest)” or “Deploy” stage, you can use an HTTP file as a manifest or application artifact. You can either use a previously-defined artifact (for example, an artifact defined in a trigger) or define an artifact inline.

Configuring a Deploy (Manifest) stage to use an HTTP file as a manifest source.

Configuring a Deploy (Manifest) stage to use an HTTP file as a manifest source.

HTTP file artifact in a pipeline definition

The following are the fields that make up an HTTP file artifact:

FieldExplanation
typeAlways http/file.
referenceThe fully-qualified URL from which the file can be read.
nameAn optional identifier used for future references to the artifact.
versionN/A
locationN/A

The following is an example JSON representation of an HTTP file artifact, as it would appear in a pipeline definition:

  1. {
  2. "type": "http/file",
  3. "reference": "https://raw.githubusercontent.com/....",
  4. "name": "My manifest stored in GitHub",
  5. }

Last modified July 1, 2021: docs(fix): fix internal links (#98) (d74c3a4)