CircleCI · Schema

TriggerPipelineRequest

CI/CDContinuous IntegrationContinuous DeploymentDevOpsPipelinesWorkflows

Properties

Name Type Description
branch string The branch to build
tag string The tag to build
parameters object Pipeline parameters as key-value pairs
View JSON Schema on GitHub

JSON Schema

circleci-triggerpipelinerequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TriggerPipelineRequest",
  "title": "TriggerPipelineRequest",
  "type": "object",
  "properties": {
    "branch": {
      "type": "string",
      "description": "The branch to build"
    },
    "tag": {
      "type": "string",
      "description": "The tag to build"
    },
    "parameters": {
      "type": "object",
      "additionalProperties": true,
      "description": "Pipeline parameters as key-value pairs"
    }
  }
}