Sign in
latestOpenAPI 3.0.02026-08-10221235717.8 KB

e21ad140ec3c

public
Pipelines

Create a new trigger matching criteria for this Pipeline.

Create a new trigger matching criteria for this Pipeline. This must not conflict with an existing criteria for the same trigger on this or any other Pipeline that applies to this Application.

post/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/criteria

Path parameters

orgIdstring required

The Organization ID

appIdstring required

The Application ID

pipelineIdstring required

The Pipeline ID

Request body

triggerstring required

The trigger to call

env_typestring

The Environment Type that this criteria will match. If defined, this criteria will only apply to Environments that have this type.

app_idstring

The id of the Application for which this criteria matches. If this Pipeline is defined in an Application, then this value can only be null or the id of the Application.

env_idstring

The exact id of the Environment which this criteria will match.

deployment_typestring

The type of deployment that this criteria will match. Valid values are "deploy" and "redeploy". "redeploy" applies only to deployment request to redeploy a previous deployment id while "deploy" will apply to all other requests that include a Delta or Deployment Set. If not defined, all deployment types will match.

Example request

{
  "trigger": "deployment_request",
  "env_type": "development",
  "app_id": "my-application",
  "env_id": "my-environment",
  "deployment_type": "deploy"
}

Response

The criteria was successfully added.

triggerstring required

The trigger to call

idstring required

The unique id of the criteria within this Pipeline.

pipeline_idstring required

The id of the Pipeline tied to this deployment request criteria.

pipeline_namestring required

The current display name of the Pipeline.

env_typestring

The Environment Type that this criteria will match. If defined, this criteria will only apply to Environments that have this type.

app_idstring

The id of the Application for which this criteria matches. If this Pipeline is defined in an Application, then this value can only be null or the id of the Application.

env_idstring

The exact id of the Environment which this criteria will match.

deployment_typestring

The type of deployment that this criteria will match. Valid values are "deploy" and "redeploy". "redeploy" applies only to deployment request to redeploy a previous deployment id while "deploy" will apply to all other requests that include a Delta or Deployment Set. If not defined, all deployment types will match.

Example response

{
  "trigger": "deployment_request",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "pipeline_id": "sample-pipeline",
  "pipeline_name": "Sample Pipeline",
  "env_type": "development",
  "app_id": "my-application",
  "env_id": "my-environment",
  "deployment_type": "deploy"
}