Create pipeline

post

https://cloud-api.calyptia.com/v1/aggregators/{aggregatorID}/pipelines

Create pipeline within an aggregator.
The pipeline name must be unique within the aggregator.
The resource profile must exist already. If you don't provide one, it will default to "best-effort-low-resource".
Use them to easily deploy configured agents to the aggregator.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

aggregatorID

uuid

required

Body Params

Create pipeline request body.

name

string

required

DNS label format as of defined on RFC1123

kind

string

enum

Defaults to deployment

Kind of deployment used when deploying this pipeline

Allowed:

replicasCount

integer

required

≥ 0

rawConfig

string

required

configFormat

string

enum

Allowed:

secrets

array of objects | null

required

secrets*

files

array of objects | null

required

files*

resourceProfile

string

required

noAutoCreateChecksFromConfig

boolean

Defaults to false

If true, no Pipeline checks will be auto-generated from
the configuration.

autoCreateChecksFromConfig

boolean

Defaults to false

deprecated

If true, this will automatically create a set of Pipeline checks
to validate that the configured output services are reachable.

waitForChecksBeforeDeploying

boolean

Defaults to false

If set to true:

If all checks associated with the pipeline run successfully, the status of
the pipeline will be switched to CHECKS_OK and the deployment will be executed.

If any of the checks associated with the pipeline fails, the status of
the pipeline will be switched to CHECKS_FAILED and the deployment of the pipeline
will be blocked.

If set to false (default):

If all checks associated with the pipeline run successfully, the status of
the pipeline will be switched to CHECKS_OK and the deployment will be executed.

If any of the checks associated with the pipeline fails, the status of
the pipeline will be switched to CHECKS_FAILED and the deployment of the pipeline
will be executed.

noAutoCreateEndpointsFromConfig

boolean

Defaults to false

if true, no ports will be automatically generated from the configuration.

autoCreatePortsFromConfig

boolean

Defaults to false

deprecated

skipConfigValidation

boolean

required

metadata

object | null

Response

201Created