logo

Pipelines

Endpoints related to pipelines, used for integrating with CI/CD solutions and automating deployments or other tasks.

List Pipelines

Requires the pipelines-view capability.

SecuritybearerAuth and hubAuth
Request
query Parameters
include
Array of strings

A comma separated list of include values. Included resources will show up under the root document's include field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.

Items Enum: "creators" "name" "components"
object

Filter Field

The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.

sort
Array of strings

An array of sort values. To sort descending, put a - in front of the value, e.g. -id.

object

In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be page[size]=20&page[number]=2

Responses
200

Returns a list of Pipelines.

default

General error response from the platform

get/v1/pipelines
Response samples
application/json
{
  • "data": [
    ],
  • "includes": {
    }
}

Create Pipeline

Requires the pipelines-manage capability.

SecuritybearerAuth and hubAuth
Request
Request Body schema: application/json

Parameters for creating a new Pipeline.

name
required
string

A name for the Pipeline.

identifier
string (Identifier)

A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient. The identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named "My Container" will have the identifier of my-container and is automatically created by the platform.

The identifier does not have to be unique.

dynamic
boolean

Setting to true enables variable and other advanced logic support on this Pipeline. This is a one-way toggle. Once set to true, it cannot be set back to false.

Array of objects (PipelineStage)

An array of stages.

ACL (object) or null
disable
boolean

A boolean where true signifies the Pipeline is disabled.

Responses
201

Returns a Pipeline.

default

General error response from the platform

post/v1/pipelines
Request samples
application/json
{
  • "name": "string",
  • "identifier": "string",
  • "dynamic": true,
  • "stages": [
    ],
  • "acl": {
    },
  • "disable": true
}
Response samples
application/json
{
  • "data": {
    }
}

Get Pipeline

Requires the pipelines-view capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
pipelineId
required
string

The ID of the Pipeline.

query Parameters
include
Array of strings

A comma separated list of include values. Included resources will show up under the root document's include field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.

Items Enum: "creators" "name" "components"
Responses
200

Returns a Pipeline.

default

General error response from the platform

get/v1/pipelines/{pipelineId}
Response samples
application/json
{
  • "data": {
    },
  • "includes": {
    }
}

Update Pipeline

Requires the pipelines-manage capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
pipelineId
required
string

The ID of the Pipeline.

Request Body schema: application/json

Parameters for updating a Pipeline.

name
string

A name for the Pipeline.

dynamic
boolean

Setting to true enables variable and other advanced logic support on this Pipeline. This is a one-way toggle. Once set to true, it cannot be set back to false.

Array of objects (PipelineStage)

An array of stages.

disable
boolean

A boolean where true signifies the Pipeline is disabled.

Responses
200

Returns a Pipeline resource.

default

General error response from the platform

patch/v1/pipelines/{pipelineId}
Request samples
application/json
{
  • "name": "string",
  • "dynamic": true,
  • "stages": [
    ],
  • "disable": true
}
Response samples
application/json
{
  • "data": {
    }
}

Delete Pipeline

Requires the pipelines-manage capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
pipelineId
required
string

The ID of the Pipeline.

Responses
200

Returns a Job Descriptor.

default

General error response from the platform

delete/v1/pipelines/{pipelineId}
Response samples
application/json
{
  • "data": {
    }
}

Update Pipeline Access

Requires the pipelines-manage capability. If an ACL is present, requires the manage privilege.

SecuritybearerAuth and hubAuth
Request
path Parameters
pipelineId
required
string

The ID of the pipeline.

Request Body schema: application/json

Parameters for updating a pipeline.

ACL (object) or null
Responses
200

Returns a pipeline resource.

default

General error response from the platform

patch/v1/pipelines/{pipelineId}/access
Request samples
application/json
{
  • "acl": {
    }
}
Response samples
application/json
{
  • "data": {
    }
}

List Pipeline Runs

List information about times this Pipeline has run.

Requires the pipelines-view capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
pipelineId
required
string

The ID of the pipeline.

query Parameters
sort
Array of strings

An array of sort values. To sort descending, put a - in front of the value, e.g. -id.

include
Array of strings

A comma separated list of include values. Included resources will show up under the root document's include field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.

Items Value: "creators"
Responses
200

Returns a list of Pipeline runs.

default

General error response from the platform

get/v1/pipelines/{pipelineId}/runs
Response samples
application/json
{
  • "data": [
    ],
  • "includes": {
    }
}

Get Pipeline Run

Requires the pipelines-view capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
pipelineId
required
string

The ID of the Pipeline.

runId
required
string

The ID for the pipeline run.

query Parameters
include
Array of strings

A comma separated list of include values. Included resources will show up under the root document's include field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.

Items Value: "creators"
Responses
200

Returns a Pipeline Run.

default

General error response from the platform

get/v1/pipelines/{pipelineId}/runs/{runId}
Response samples
application/json
{
  • "data": {
    },
  • "includes": {
    }
}

Create Pipeline Job

Requires the pipelines-manage capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
pipelineId
required
string

The ID of the Pipeline.

Request Body schema: application/json

Parameters for creating a new Pipeline job.

action
required
string

The requested action to perform.

object
Responses
202

Returns a Job Descriptor.

default

General error response from the platform

post/v1/pipelines/{pipelineId}/tasks
Request samples
application/json
{
  • "action": "trigger",
  • "contents": {
    }
}
Response samples
application/json
{
  • "data": {
    }
}

Clone Pipeline

Requires the pipelines-manage capability.

SecuritybearerAuth and hubAuth
Request
Request Body schema: application/json

Parameters for creating a new Pipeline job.

name
required
string

The name of the cloned pipeline.

identifier
required
string (Identifier)

A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient. The identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named "My Container" will have the identifier of my-container and is automatically created by the platform.

The identifier does not have to be unique.

pipeline_id
required
string <objectid> (ID)

A 24 character hex string used to identify a unique resource.

Responses
201

Returns a Pipeline.

default

General error response from the platform

post/v1/pipelines/clone
Request samples
application/json
{
  • "name": "string",
  • "identifier": "string",
  • "pipeline_id": "651586fca6078e98982dbd90"
}
Response samples
application/json
{
  • "data": {
    }
}

Trigger Pipeline

SecuritybearerAuth and hubAuth
Request
path Parameters
pipelineId
required
string

The ID of the Pipeline.

Request Body schema: application/json

Parameters for triggering a pipeline.

secret
required
string

The trigger key secret.

required
object

A map of variables to pass into the pipeline when it runs.

object
Responses
201

Returns a Pipeline.

default

General error response from the platform

post/v1/pipelines/{pipelineId}/trigger
Request samples
application/json
{
  • "secret": "string",
  • "variables": {
    },
  • "advanced": {
    }
}
Response samples
application/json
{
  • "data": {
    }
}

Update Trigger Key

Requires the pipelines-manage capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
pipelineId
required
string

The ID of the Pipeline.

triggerKeyId
required
string

The ID of the Trigger Key.

Request Body schema: application/json
name
string

Set name of Trigger Key

ips
Array of strings

List of IP Restrictions

Responses
200

Returns a Job Descriptor.

default

General error response from the platform

patch/v1/pipelines/{pipelineId}/keys/{triggerKeyId}
Request samples
application/json
{
  • "name": "string",
  • "ips": [
    ]
}
Response samples
application/json
{
  • "data": {
    }
}
➔ Next to Trigger Keys