circleci-pipelines - Pinkfish - AI Agents & Workflows for Getting Work Done

Server path: /circleci-pipelines | Type: Application | PCID required: Yes

Tools

Tool	Description
`circleci_pipelines_approve_pending_approval_job_by_id`	Approve a job
`circleci_pipelines_cancel_job_by_job_id`	Cancel job by job ID
`circleci_pipelines_cancel_job_by_job_number`	Cancel job by job number
`circleci_pipelines_cancel_workflow`	Cancel a workflow
`circleci_pipelines_continue_pipeline`	Continue a pipeline
`circleci_pipelines_create_pipeline_definition`	Create pipeline definition
`circleci_pipelines_create_schedule`	Create a schedule
`circleci_pipelines_create_trigger`	Create trigger
`circleci_pipelines_delete_pipeline_definition`	Delete pipeline definition
`circleci_pipelines_delete_schedule_by_id`	Delete a schedule
`circleci_pipelines_delete_trigger`	Delete trigger
`circleci_pipelines_get_component`	Get Component
`circleci_pipelines_get_environment`	Get Environment
`circleci_pipelines_get_job`	Get a job
`circleci_pipelines_get_job_artifacts`	Get a job’s artifacts
`circleci_pipelines_get_job_details`	Get job details
`circleci_pipelines_get_pipeline_by_id`	Get a pipeline by ID
`circleci_pipelines_get_pipeline_by_number`	Get a pipeline by pipeline number
`circleci_pipelines_get_pipeline_config_by_id`	Get a pipeline’s configuration
`circleci_pipelines_get_pipeline_definition`	Get pipeline definition
`circleci_pipelines_get_pipeline_values_by_id`	Get pipeline values for a pipeline
`circleci_pipelines_get_schedule_by_id`	Get a schedule by ID. Available only on schedules associated with GitHub OAuth or Bitbucket Cloud pipeline definitions.
`circleci_pipelines_get_tests`	Get test metadata
`circleci_pipelines_get_trigger`	Get trigger
`circleci_pipelines_get_workflow_by_id`	Get a workflow
`circleci_pipelines_list_component_versions`	List Component Versions
`circleci_pipelines_list_components`	List Components
`circleci_pipelines_list_environments`	List Environments
`circleci_pipelines_list_my_pipelines`	Get your pipelines
`circleci_pipelines_list_pipeline_definition_triggers`	List pipeline definition triggers
`circleci_pipelines_list_pipeline_definitions`	List pipeline definitions
`circleci_pipelines_list_pipelines`	Get a list of pipelines
`circleci_pipelines_list_pipelines_for_project`	Get all pipelines
`circleci_pipelines_list_schedules_for_project`	List schedule triggers
`circleci_pipelines_list_workflow_jobs`	Get a workflow’s jobs
`circleci_pipelines_list_workflows_by_pipeline_id`	Get a pipeline’s workflows
`circleci_pipelines_rerun_workflow`	Rerun a workflow
`circleci_pipelines_rollback_project`	Rollback a project
`circleci_pipelines_trigger_pipeline`	Trigger a new pipeline
`circleci_pipelines_trigger_pipeline_run`	[Recommended] Trigger a new pipeline
`circleci_pipelines_update_pipeline_definition`	Update pipeline definition
`circleci_pipelines_update_schedule`	Update a schedule
`circleci_pipelines_update_trigger`	Update trigger

circleci_pipelines_approve_pending_approval_job_by_id

Approve a job Parameters:

Parameter	Type	Required	Default	Description
`approval_request_id`	string	Yes	—	The ID of the job being approved.
`id`	string	Yes	—	The unique ID of the workflow.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "approval_request_id": {
      "type": "string",
      "description": "The ID of the job being approved."
    },
    "id": {
      "type": "string",
      "description": "The unique ID of the workflow."
    }
  },
  "required": [
    "PCID",
    "approval_request_id",
    "id"
  ]
}

circleci_pipelines_cancel_job_by_job_id

Cancel job by job ID Parameters:

Parameter	Type	Required	Default	Description
`job-id`	string	Yes	—	The unique ID of the job.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "job-id": {
      "type": "string",
      "description": "The unique ID of the job."
    }
  },
  "required": [
    "PCID",
    "job-id"
  ]
}

circleci_pipelines_cancel_job_by_job_number

Cancel job by job number Parameters:

Parameter	Type	Required	Default	Description
`job-number`	object	Yes	—	The number of the job.
`project-slug`	string	Yes	—	Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings).

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "job-number": {
      "description": "The number of the job."
    },
    "project-slug": {
      "type": "string",
      "description": "Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)."
    }
  },
  "required": [
    "PCID",
    "job-number",
    "project-slug"
  ]
}

circleci_pipelines_cancel_workflow

Cancel a workflow Parameters:

Parameter	Type	Required	Default	Description
`id`	string	Yes	—	The unique ID of the workflow.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The unique ID of the workflow."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

circleci_pipelines_continue_pipeline

Continue a pipeline Parameters:

Parameter	Type	Required	Default	Description
`configuration`	string	Yes	—	A configuration string for the pipeline.
`continuation-key`	string	Yes	—	A pipeline continuation key.
`parameters`	object	No	—	An object containing pipeline parameters and their values. Pipeline parameters have the following size limits: 100 max entries, 128 maximum key length, 512 maximum value length.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "configuration": {
      "type": "string",
      "description": "A configuration string for the pipeline."
    },
    "continuation-key": {
      "type": "string",
      "description": "A pipeline continuation key."
    },
    "parameters": {
      "type": "object",
      "description": "An object containing pipeline parameters and their values. Pipeline parameters have the following size limits: 100 max entries, 128 maximum key length, 512 maximum value length."
    }
  },
  "required": [
    "PCID",
    "configuration",
    "continuation-key"
  ]
}

circleci_pipelines_create_pipeline_definition

Create pipeline definition Parameters:

Parameter	Type	Required	Default	Description
`project_id`	string	Yes	—	An opaque identifier of a project.
`checkout_source`	object	Yes	—	The resource to be used when running the `checkout` command.
`config_source`	object	Yes	—	Config Source
`description`	string	No	—	The description of the pipeline definition.
`name`	string	Yes	—	The name of the pipeline definition.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "project_id": {
      "type": "string",
      "description": "An opaque identifier of a project."
    },
    "checkout_source": {
      "type": "object",
      "description": "The resource to be used when running the `checkout` command.",
      "properties": {
        "provider": {
          "type": "string",
          "description": "The integration provider for this resource. Supported values are `github_app` and `github_server`.",
          "enum": [
            "github_app",
            "github_server"
          ]
        },
        "repo": {
          "type": "object",
          "description": "The repo value"
        }
      },
      "required": [
        "provider",
        "repo"
      ]
    },
    "config_source": {
      "description": "Config Source"
    },
    "description": {
      "type": "string",
      "description": "The description of the pipeline definition."
    },
    "name": {
      "type": "string",
      "description": "The name of the pipeline definition."
    }
  },
  "required": [
    "PCID",
    "project_id",
    "checkout_source",
    "config_source",
    "name"
  ]
}

circleci_pipelines_create_schedule

Create a schedule Parameters:

Parameter	Type	Required	Default	Description
`project-slug`	string	Yes	—	Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings).
`attribution-actor`	string	Yes	—	The attribution-actor of the scheduled pipeline.
`description`	string	No	—	Description of the schedule.
`name`	string	Yes	—	Name of the schedule.
`parameters`	object	Yes	—	Pipeline parameters represented as key-value pairs. Must contain branch or tag.
`timetable`	object	Yes	—	Timetable that specifies when a schedule triggers.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "project-slug": {
      "type": "string",
      "description": "Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)."
    },
    "attribution-actor": {
      "type": "string",
      "description": "The attribution-actor of the scheduled pipeline.",
      "enum": [
        "current",
        "system"
      ]
    },
    "description": {
      "type": "string",
      "description": "Description of the schedule."
    },
    "name": {
      "type": "string",
      "description": "Name of the schedule."
    },
    "parameters": {
      "type": "object",
      "description": "Pipeline parameters represented as key-value pairs. Must contain branch or tag."
    },
    "timetable": {
      "description": "Timetable that specifies when a schedule triggers."
    }
  },
  "required": [
    "PCID",
    "project-slug",
    "attribution-actor",
    "name",
    "parameters",
    "timetable"
  ]
}

circleci_pipelines_create_trigger

Create trigger Parameters:

Parameter	Type	Required	Default	Description
`project_id`	string	Yes	—	An opaque identifier of a project.
`pipeline_definition_id`	string	Yes	—	An opaque identifier of a pipeline definition.
`checkout_ref`	string	No	—	The ref to use when checking out code for pipeline runs created from this trigger. Always required when `event_source.provider` is `webhook` or `schedule`. When `event_source.provider` is `github_app` or `github_server`, only expected if the event source repository (identified by `event_source.repo.external_id`) is different to the checkout source repository of the associated Pipeline Definition. Otherwise, must be omitted.
`config_ref`	string	No	—	The ref to use when fetching config for pipeline runs created from this trigger. Always required when `event_source.provider` is `webhook` or `schedule`. When `event_source.provider` is `github_app` or `github_server`, only expected if the event source repository (identified by `event_source.repo.external_id`) is different to the config source repository of the associated Pipeline Definition. Otherwise, must be omitted.
`disabled`	boolean	No	—	Whether the trigger should be disabled upon creation. Not supported for triggers where `event_source.provider` is `github_oauth`.
`event_name`	string	No	—	The name of the triggering event. Required when `provider` is `webhook` or `schedule`. Should not be set for other providers.
`event_preset`	string	No	—	The name of the event preset to use when filtering events for this trigger. Only applicable when `event_source.provider` is `github_app` or `github_server`.
`event_source`	object	Yes	—	The source of events to use for this trigger. The `repo` object must be specified when `provider` is `github_app`, `github_server`, or `github_oauth`, the `webhook` object may only be specified when `provider` is `webhook`, and the `schedule` object must be specified when `provider` is `schedule`.
`parameters`	object	No	—	Pipeline parameters to pass when running pipelines from this trigger. Currently only supported for triggers where `event_source.provider` is `schedule`.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "project_id": {
      "type": "string",
      "description": "An opaque identifier of a project."
    },
    "pipeline_definition_id": {
      "type": "string",
      "description": "An opaque identifier of a pipeline definition."
    },
    "checkout_ref": {
      "type": "string",
      "description": "The ref to use when checking out code for pipeline runs created from this trigger. Always required when `event_source.provider` is `webhook` or `schedule`. When `event_source.provider` is `github_app` or `github_server`, only expected if the event source repository (identified by `event_source.repo.external_id`) is different to the checkout source repository of the associated Pipeline Definition. Otherwise, must be omitted."
    },
    "config_ref": {
      "type": "string",
      "description": "The ref to use when fetching config for pipeline runs created from this trigger. Always required when `event_source.provider` is `webhook` or `schedule`. When `event_source.provider` is `github_app` or `github_server`, only expected if the event source repository (identified by `event_source.repo.external_id`) is different to the config source repository of the associated Pipeline Definition. Otherwise, must be omitted."
    },
    "disabled": {
      "type": "boolean",
      "description": "Whether the trigger should be disabled upon creation. Not supported for triggers where `event_source.provider` is `github_oauth`."
    },
    "event_name": {
      "type": "string",
      "description": "The name of the triggering event. Required when `provider` is `webhook` or `schedule`. Should not be set for other providers."
    },
    "event_preset": {
      "type": "string",
      "description": "The name of the event preset to use when filtering events for this trigger. Only applicable when `event_source.provider` is `github_app` or `github_server`.",
      "enum": [
        "all-pushes",
        "only-tags",
        "default-branch-pushes",
        "only-build-prs",
        "only-open-prs",
        "only-labeled-prs",
        "only-merged-prs",
        "only-ready-for-review-prs",
        "only-branch-delete",
        "only-build-pushes-to-non-draft-prs",
        "only-merged-or-closed-prs",
        "pr-comment-equals-run-ci",
        "non-draft-pr-opened",
        "pushes-to-merge-queues"
      ]
    },
    "event_source": {
      "type": "object",
      "description": "The source of events to use for this trigger. The `repo` object must be specified when `provider` is `github_app`, `github_server`, or `github_oauth`, the `webhook` object may only be specified when `provider` is `webhook`, and the `schedule` object must be specified when `provider` is `schedule`.",
      "properties": {
        "provider": {
          "type": "string",
          "description": "The integration provider for this resource. Currently `github_app`, `github_server`, `github_oauth`, `webhook`, and `schedule` are the only supported values."
        },
        "repo": {
          "type": "object",
          "description": "Information pertaining to the repository used as a source of events for this trigger, if applicable."
        },
        "schedule": {
          "type": "object",
          "description": "Schedule configuration for this trigger. Only applicable when `provider` is `schedule`."
        },
        "webhook": {
          "type": "object",
          "description": "Information pertaining to the custom webhook being used as a source of events for this trigger, if applicable."
        }
      },
      "required": [
        "provider"
      ]
    },
    "parameters": {
      "type": "object",
      "description": "Pipeline parameters to pass when running pipelines from this trigger. Currently only supported for triggers where `event_source.provider` is `schedule`."
    }
  },
  "required": [
    "PCID",
    "project_id",
    "pipeline_definition_id",
    "event_source"
  ]
}

circleci_pipelines_delete_pipeline_definition

Delete pipeline definition Parameters:

Parameter	Type	Required	Default	Description
`project_id`	string	Yes	—	An opaque identifier of a project.
`pipeline_definition_id`	string	Yes	—	An opaque identifier of a pipeline definition.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "project_id": {
      "type": "string",
      "description": "An opaque identifier of a project."
    },
    "pipeline_definition_id": {
      "type": "string",
      "description": "An opaque identifier of a pipeline definition."
    }
  },
  "required": [
    "PCID",
    "project_id",
    "pipeline_definition_id"
  ]
}

circleci_pipelines_delete_schedule_by_id

Delete a schedule Parameters:

Parameter	Type	Required	Default	Description
`schedule-id`	string	Yes	—	The unique ID of the schedule.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "schedule-id": {
      "type": "string",
      "description": "The unique ID of the schedule."
    }
  },
  "required": [
    "PCID",
    "schedule-id"
  ]
}

circleci_pipelines_delete_trigger

Delete trigger Parameters:

Parameter	Type	Required	Default	Description
`project_id`	string	Yes	—	An opaque identifier of a project.
`trigger_id`	string	Yes	—	An opaque identifier of a trigger.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "project_id": {
      "type": "string",
      "description": "An opaque identifier of a project."
    },
    "trigger_id": {
      "type": "string",
      "description": "An opaque identifier of a trigger."
    }
  },
  "required": [
    "PCID",
    "project_id",
    "trigger_id"
  ]
}

circleci_pipelines_get_component

Get Component Parameters:

Parameter	Type	Required	Default	Description
`component_id`	string	Yes	—	An opaque identifier of a component.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "component_id": {
      "type": "string",
      "description": "An opaque identifier of a component."
    }
  },
  "required": [
    "PCID",
    "component_id"
  ]
}

circleci_pipelines_get_environment

Get Environment Parameters:

Parameter	Type	Required	Default	Description
`environment_id`	string	Yes	—	An opaque identifier of an environment.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "environment_id": {
      "type": "string",
      "description": "An opaque identifier of an environment."
    }
  },
  "required": [
    "PCID",
    "environment_id"
  ]
}

circleci_pipelines_get_job

Get a job Parameters:

Parameter	Type	Required	Default	Description
`job_id`	string	Yes	—	An opaque identifier of a job.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "job_id": {
      "type": "string",
      "description": "An opaque identifier of a job."
    }
  },
  "required": [
    "PCID",
    "job_id"
  ]
}

circleci_pipelines_get_job_artifacts

Get a job’s artifacts Parameters:

Parameter	Type	Required	Default	Description
`job-number`	object	Yes	—	The number of the job.
`project-slug`	string	Yes	—	Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings).

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "job-number": {
      "description": "The number of the job."
    },
    "project-slug": {
      "type": "string",
      "description": "Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)."
    }
  },
  "required": [
    "PCID",
    "job-number",
    "project-slug"
  ]
}

circleci_pipelines_get_job_details

Get job details Parameters:

Parameter	Type	Required	Default	Description
`job-number`	object	Yes	—	The number of the job.
`project-slug`	string	Yes	—	Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings).

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "job-number": {
      "description": "The number of the job."
    },
    "project-slug": {
      "type": "string",
      "description": "Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)."
    }
  },
  "required": [
    "PCID",
    "job-number",
    "project-slug"
  ]
}

circleci_pipelines_get_pipeline_by_id

Get a pipeline by ID Parameters:

Parameter	Type	Required	Default	Description
`pipeline-id`	string	Yes	—	The unique ID of the pipeline.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pipeline-id": {
      "type": "string",
      "description": "The unique ID of the pipeline."
    }
  },
  "required": [
    "PCID",
    "pipeline-id"
  ]
}

circleci_pipelines_get_pipeline_by_number

Get a pipeline by pipeline number Parameters:

Parameter	Type	Required	Default	Description
`project-slug`	string	Yes	—	Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings).
`pipeline-number`	object	Yes	—	The number of the pipeline.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "project-slug": {
      "type": "string",
      "description": "Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)."
    },
    "pipeline-number": {
      "description": "The number of the pipeline."
    }
  },
  "required": [
    "PCID",
    "project-slug",
    "pipeline-number"
  ]
}

circleci_pipelines_get_pipeline_config_by_id

Get a pipeline’s configuration Parameters:

Parameter	Type	Required	Default	Description
`pipeline-id`	string	Yes	—	The unique ID of the pipeline.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pipeline-id": {
      "type": "string",
      "description": "The unique ID of the pipeline."
    }
  },
  "required": [
    "PCID",
    "pipeline-id"
  ]
}

circleci_pipelines_get_pipeline_definition

Get pipeline definition Parameters:

Parameter	Type	Required	Default	Description
`project_id`	string	Yes	—	An opaque identifier of a project.
`pipeline_definition_id`	string	Yes	—	An opaque identifier of a pipeline definition.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "project_id": {
      "type": "string",
      "description": "An opaque identifier of a project."
    },
    "pipeline_definition_id": {
      "type": "string",
      "description": "An opaque identifier of a pipeline definition."
    }
  },
  "required": [
    "PCID",
    "project_id",
    "pipeline_definition_id"
  ]
}

circleci_pipelines_get_pipeline_values_by_id

Get pipeline values for a pipeline Parameters:

Parameter	Type	Required	Default	Description
`pipeline_id`	string	Yes	—	An opaque identifier of a pipeline.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pipeline_id": {
      "type": "string",
      "description": "An opaque identifier of a pipeline."
    }
  },
  "required": [
    "PCID",
    "pipeline_id"
  ]
}

circleci_pipelines_get_schedule_by_id

Get a schedule by ID. Available only on schedules associated with GitHub OAuth or Bitbucket Cloud pipeline definitions. Parameters:

Parameter	Type	Required	Default	Description
`schedule-id`	string	Yes	—	The unique ID of the schedule.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "schedule-id": {
      "type": "string",
      "description": "The unique ID of the schedule."
    }
  },
  "required": [
    "PCID",
    "schedule-id"
  ]
}

circleci_pipelines_get_tests

Get test metadata Parameters:

Parameter	Type	Required	Default	Description
`job-number`	object	Yes	—	The number of the job.
`project-slug`	string	Yes	—	Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings).

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "job-number": {
      "description": "The number of the job."
    },
    "project-slug": {
      "type": "string",
      "description": "Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)."
    }
  },
  "required": [
    "PCID",
    "job-number",
    "project-slug"
  ]
}

circleci_pipelines_get_trigger

Get trigger Parameters:

Parameter	Type	Required	Default	Description
`project_id`	string	Yes	—	An opaque identifier of a project.
`trigger_id`	string	Yes	—	An opaque identifier of a trigger.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "project_id": {
      "type": "string",
      "description": "An opaque identifier of a project."
    },
    "trigger_id": {
      "type": "string",
      "description": "An opaque identifier of a trigger."
    }
  },
  "required": [
    "PCID",
    "project_id",
    "trigger_id"
  ]
}

circleci_pipelines_get_workflow_by_id

Get a workflow Parameters:

Parameter	Type	Required	Default	Description
`id`	string	Yes	—	The unique ID of the workflow.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The unique ID of the workflow."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

circleci_pipelines_list_component_versions

List Component Versions Parameters:

Parameter	Type	Required	Default	Description
`component_id`	string	Yes	—	An opaque identifier of a component.
`environment-id`	string	No	—	An opaque identifier of an environment used in query parameters.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "component_id": {
      "type": "string",
      "description": "An opaque identifier of a component."
    },
    "environment-id": {
      "type": "string",
      "description": "An opaque identifier of an environment used in query parameters."
    }
  },
  "required": [
    "PCID",
    "component_id"
  ]
}

circleci_pipelines_list_components

List Components Parameters:

Parameter	Type	Required	Default	Description
`org-id`	string	Yes	—	An opaque identifier of an organization used in query parameters.
`project-id`	string	No	—	An opaque identifier of an project used in query parameters.
`page-size`	integer	Yes	—	The number of results per page.
`page-token`	string	No	—	A token to specify which page of results to fetch.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "org-id": {
      "type": "string",
      "description": "An opaque identifier of an organization used in query parameters."
    },
    "project-id": {
      "type": "string",
      "description": "An opaque identifier of an project used in query parameters."
    },
    "page-size": {
      "type": "integer",
      "description": "The number of results per page."
    },
    "page-token": {
      "type": "string",
      "description": "A token to specify which page of results to fetch."
    }
  },
  "required": [
    "PCID",
    "org-id",
    "page-size"
  ]
}

circleci_pipelines_list_environments

List Environments Parameters:

Parameter	Type	Required	Default	Description
`org-id`	string	Yes	—	An opaque identifier of an organization used in query parameters.
`page-size`	integer	Yes	—	The number of results per page.
`page-token`	string	No	—	A token to specify which page of results to fetch.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "org-id": {
      "type": "string",
      "description": "An opaque identifier of an organization used in query parameters."
    },
    "page-size": {
      "type": "integer",
      "description": "The number of results per page."
    },
    "page-token": {
      "type": "string",
      "description": "A token to specify which page of results to fetch."
    }
  },
  "required": [
    "PCID",
    "org-id",
    "page-size"
  ]
}

circleci_pipelines_list_my_pipelines

Get your pipelines Parameters:

Parameter	Type	Required	Default	Description
`project-slug`	string	Yes	—	Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings).
`page-token`	string	No	—	A token to retrieve the next page of results.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "project-slug": {
      "type": "string",
      "description": "Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)."
    },
    "page-token": {
      "type": "string",
      "description": "A token to retrieve the next page of results."
    }
  },
  "required": [
    "PCID",
    "project-slug"
  ]
}

circleci_pipelines_list_pipeline_definition_triggers

List pipeline definition triggers Parameters:

Parameter	Type	Required	Default	Description
`project_id`	string	Yes	—	An opaque identifier of a project.
`pipeline_definition_id`	string	Yes	—	An opaque identifier of a pipeline definition.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "project_id": {
      "type": "string",
      "description": "An opaque identifier of a project."
    },
    "pipeline_definition_id": {
      "type": "string",
      "description": "An opaque identifier of a pipeline definition."
    }
  },
  "required": [
    "PCID",
    "project_id",
    "pipeline_definition_id"
  ]
}

circleci_pipelines_list_pipeline_definitions

List pipeline definitions Parameters:

Parameter	Type	Required	Default	Description
`project_id`	string	Yes	—	An opaque identifier of a project.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "project_id": {
      "type": "string",
      "description": "An opaque identifier of a project."
    }
  },
  "required": [
    "PCID",
    "project_id"
  ]
}

circleci_pipelines_list_pipelines

Get a list of pipelines Parameters:

Parameter	Type	Required	Default	Description
`org-slug`	string	No	—	Org slug in the form `vcs-slug/org-name`. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug` and replace the `org-name` with the organization ID (found in Organization Settings).
`page-token`	string	No	—	A token to retrieve the next page of results.
`mine`	boolean	No	—	Only include entries created by your user.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "org-slug": {
      "type": "string",
      "description": "Org slug in the form `vcs-slug/org-name`. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug` and replace the `org-name` with the organization ID (found in Organization Settings)."
    },
    "page-token": {
      "type": "string",
      "description": "A token to retrieve the next page of results."
    },
    "mine": {
      "type": "boolean",
      "description": "Only include entries created by your user."
    }
  },
  "required": [
    "PCID"
  ]
}

circleci_pipelines_list_pipelines_for_project

Get all pipelines Parameters:

Parameter	Type	Required	Default	Description
`project-slug`	string	Yes	—	Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings).
`branch`	string	No	—	The name of a vcs branch.
`page-token`	string	No	—	A token to retrieve the next page of results.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "project-slug": {
      "type": "string",
      "description": "Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)."
    },
    "branch": {
      "type": "string",
      "description": "The name of a vcs branch."
    },
    "page-token": {
      "type": "string",
      "description": "A token to retrieve the next page of results."
    }
  },
  "required": [
    "PCID",
    "project-slug"
  ]
}

circleci_pipelines_list_schedules_for_project

List schedule triggers Parameters:

Parameter	Type	Required	Default	Description
`project-slug`	string	Yes	—	Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings).
`page-token`	string	No	—	A token to retrieve the next page of results.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "project-slug": {
      "type": "string",
      "description": "Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)."
    },
    "page-token": {
      "type": "string",
      "description": "A token to retrieve the next page of results."
    }
  },
  "required": [
    "PCID",
    "project-slug"
  ]
}

circleci_pipelines_list_workflow_jobs

Get a workflow’s jobs Parameters:

Parameter	Type	Required	Default	Description
`id`	string	Yes	—	The unique ID of the workflow.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The unique ID of the workflow."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

circleci_pipelines_list_workflows_by_pipeline_id

Get a pipeline’s workflows Parameters:

Parameter	Type	Required	Default	Description
`pipeline-id`	string	Yes	—	The unique ID of the pipeline.
`page-token`	string	No	—	A token to retrieve the next page of results.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pipeline-id": {
      "type": "string",
      "description": "The unique ID of the pipeline."
    },
    "page-token": {
      "type": "string",
      "description": "A token to retrieve the next page of results."
    }
  },
  "required": [
    "PCID",
    "pipeline-id"
  ]
}

circleci_pipelines_rerun_workflow

Rerun a workflow Parameters:

Parameter	Type	Required	Default	Description
`id`	string	Yes	—	The unique ID of the workflow.
`enable_ssh`	boolean	No	—	Whether to enable SSH access for the triggering user on the newly-rerun job. Requires the jobs parameter to be used and so is mutually exclusive with the from_failed parameter.
`from_failed`	boolean	No	—	Whether to rerun the workflow from the failed job. Mutually exclusive with the jobs parameter.
`jobs`	string[]	No	—	A list of job IDs to rerun.
`sparse_tree`	boolean	No	—	Completes rerun using sparse trees logic, an optimization for workflows that have disconnected subgraphs. Requires jobs parameter and so is mutually exclusive with the from_failed parameter.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The unique ID of the workflow."
    },
    "enable_ssh": {
      "type": "boolean",
      "description": "Whether to enable SSH access for the triggering user on the newly-rerun job. Requires the jobs parameter to be used and so is mutually exclusive with the from_failed parameter."
    },
    "from_failed": {
      "type": "boolean",
      "description": "Whether to rerun the workflow from the failed job. Mutually exclusive with the jobs parameter."
    },
    "jobs": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "A list of job IDs to rerun."
    },
    "sparse_tree": {
      "type": "boolean",
      "description": "Completes rerun using sparse trees logic, an optimization for workflows that have disconnected subgraphs. Requires jobs parameter and so is mutually exclusive with the from_failed parameter."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

circleci_pipelines_rollback_project

Rollback a project Parameters:

Parameter	Type	Required	Default	Description
`project_id`	string	Yes	—	An opaque identifier of a project.
`component_name`	string	Yes	—	The component name
`current_version`	string	Yes	—	The current version
`environment_name`	string	Yes	—	The environment name
`namespace`	string	No	—	The namespace
`parameters`	object	No	—	The extra parameters for the rollback pipeline
`reason`	string	No	—	The reason for the rollback
`target_version`	string	Yes	—	The target version

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "project_id": {
      "type": "string",
      "description": "An opaque identifier of a project."
    },
    "component_name": {
      "type": "string",
      "description": "The component name"
    },
    "current_version": {
      "type": "string",
      "description": "The current version"
    },
    "environment_name": {
      "type": "string",
      "description": "The environment name"
    },
    "namespace": {
      "type": "string",
      "description": "The namespace"
    },
    "parameters": {
      "type": "object",
      "description": "The extra parameters for the rollback pipeline"
    },
    "reason": {
      "type": "string",
      "description": "The reason for the rollback"
    },
    "target_version": {
      "type": "string",
      "description": "The target version"
    }
  },
  "required": [
    "PCID",
    "project_id",
    "component_name",
    "current_version",
    "environment_name",
    "target_version"
  ]
}

circleci_pipelines_trigger_pipeline

Trigger a new pipeline Parameters:

Parameter	Type	Required	Default	Description
`project-slug`	string	Yes	—	Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings).
`branch`	string	No	—	The branch where the pipeline ran. The HEAD commit on this branch was used for the pipeline. Note that `branch` and `tag` are mutually exclusive. To trigger a pipeline for a PR by number use `pull/<number>/head` for the PR ref or `pull/<number>/merge` for the merge ref (GitHub only).
`parameters`	object	No	—	An object containing pipeline parameters and their values. Pipeline parameters have the following size limits: 100 max entries, 128 maximum key length, 512 maximum value length.
`tag`	string	No	—	The tag used by the pipeline. The commit that this tag points to was used for the pipeline. Note that `branch` and `tag` are mutually exclusive.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "project-slug": {
      "type": "string",
      "description": "Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` with the organization ID (found in Organization Settings), and replace `repo-name` with the project ID (found in Project Settings)."
    },
    "branch": {
      "type": "string",
      "description": "The branch where the pipeline ran. The HEAD commit on this branch was used for the pipeline. Note that `branch` and `tag` are mutually exclusive. To trigger a pipeline for a PR by number use `pull/<number>/head` for the PR ref or `pull/<number>/merge` for the merge ref (GitHub only)."
    },
    "parameters": {
      "type": "object",
      "description": "An object containing pipeline parameters and their values. Pipeline parameters have the following size limits: 100 max entries, 128 maximum key length, 512 maximum value length."
    },
    "tag": {
      "type": "string",
      "description": "The tag used by the pipeline. The commit that this tag points to was used for the pipeline. Note that `branch` and `tag` are mutually exclusive."
    }
  },
  "required": [
    "PCID",
    "project-slug"
  ]
}

circleci_pipelines_trigger_pipeline_run

[Recommended] Trigger a new pipeline Parameters:

Parameter	Type	Required	Default	Description
`provider`	string	Yes	—	The first segment of the slash-separated project slug, as shown in Project Settings > Overview.
`organization`	string	Yes	—	The second segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the org name (e.g. `my-org`) or an ID (e.g. `43G3lM5RtfFE7v5sa4nWAU`).
`project`	string	Yes	—	The third segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the project name (e.g. `my-project`) or an ID (e.g. `44n9wujWcTnVZ2b5S8Fnat`).
`checkout`	object	No	—	The checkout value
`config`	object	No	—	The config value
`definition_id`	string	No	—	The unique id for the pipeline definition. This can be found in the page Project Settings > Pipelines.
`parameters`	object	No	—	An object containing pipeline parameters and their values. Pipeline parameters have the following size limits: 100 max entries, 128 maximum key length, 512 maximum value length.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "provider": {
      "type": "string",
      "description": "The first segment of the slash-separated project slug, as shown in Project Settings > Overview.",
      "enum": [
        "github",
        "gh",
        "bitbucket",
        "bb",
        "circleci"
      ]
    },
    "organization": {
      "type": "string",
      "description": "The second segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the org name (e.g. `my-org`) or an ID (e.g. `43G3lM5RtfFE7v5sa4nWAU`)."
    },
    "project": {
      "type": "string",
      "description": "The third segment of the slash-separated project slug, as shown in Project Settings > Overview. Depending on the organization type, this may be the project name (e.g. `my-project`) or an ID (e.g. `44n9wujWcTnVZ2b5S8Fnat`)."
    },
    "checkout": {
      "type": "object",
      "description": "The checkout value",
      "properties": {
        "branch": {
          "type": "string",
          "description": "The branch that should be used to check out code on a checkout step. Note that branch and tag are mutually exclusive. To trigger a pipeline for a PR by number use pull/<number>/head for the PR ref or pull/<number>/merge for the merge ref (GitHub only)"
        },
        "tag": {
          "type": "string",
          "description": "The tag that should be used to check out code on a checkout step. The commit that this tag points to is used for the pipeline. Note that branch and tag are mutually exclusive."
        }
      }
    },
    "config": {
      "type": "object",
      "description": "The config value",
      "properties": {
        "branch": {
          "type": "string",
          "description": "The branch that should be used to fetch the config file. Note that branch and tag are mutually exclusive. To trigger a pipeline for a PR by number use pull/<number>/head for the PR ref or pull/<number>/merge for the merge ref (GitHub only)"
        },
        "tag": {
          "type": "string",
          "description": "The tag that should be used to fetch the config file. The commit that this tag points to is used for the pipeline. Note that branch and tag are mutually exclusive."
        }
      }
    },
    "definition_id": {
      "type": "string",
      "description": "The unique id for the pipeline definition. This can be found in the page Project Settings > Pipelines."
    },
    "parameters": {
      "type": "object",
      "description": "An object containing pipeline parameters and their values. Pipeline parameters have the following size limits: 100 max entries, 128 maximum key length, 512 maximum value length."
    }
  },
  "required": [
    "PCID",
    "provider",
    "organization",
    "project"
  ]
}

circleci_pipelines_update_pipeline_definition

Update pipeline definition Parameters:

Parameter	Type	Required	Default	Description
`project_id`	string	Yes	—	An opaque identifier of a project.
`pipeline_definition_id`	string	Yes	—	An opaque identifier of a pipeline definition.
`checkout_source`	object	No	—	The resource to be used when running the `checkout` command.
`config_source`	object	No	—	The resource that stores the CircleCI config YAML used for this pipeline definition.
`description`	string	No	—	The description of the pipeline definition.
`name`	string	No	—	The name of the pipeline definition.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "project_id": {
      "type": "string",
      "description": "An opaque identifier of a project."
    },
    "pipeline_definition_id": {
      "type": "string",
      "description": "An opaque identifier of a pipeline definition."
    },
    "checkout_source": {
      "type": "object",
      "description": "The resource to be used when running the `checkout` command.",
      "properties": {
        "provider": {
          "type": "string",
          "description": "The integration provider for this resource. Supported values include `github_app` and `github_server`."
        },
        "repo": {
          "type": "object",
          "description": "The repo value"
        }
      }
    },
    "config_source": {
      "type": "object",
      "description": "The resource that stores the CircleCI config YAML used for this pipeline definition.",
      "properties": {
        "file_path": {
          "type": "string",
          "description": "Path to CircleCI config YAML file to use for this pipeline definition."
        }
      }
    },
    "description": {
      "type": "string",
      "description": "The description of the pipeline definition."
    },
    "name": {
      "type": "string",
      "description": "The name of the pipeline definition."
    }
  },
  "required": [
    "PCID",
    "project_id",
    "pipeline_definition_id"
  ]
}

circleci_pipelines_update_schedule

Update a schedule Parameters:

Parameter	Type	Required	Default	Description
`schedule-id`	string	Yes	—	The unique ID of the schedule.
`attribution-actor`	string	No	—	The attribution-actor of the scheduled pipeline.
`description`	string	No	—	Description of the schedule.
`name`	string	No	—	Name of the schedule.
`parameters`	object	No	—	Pipeline parameters represented as key-value pairs. Must contain branch or tag.
`timetable`	object	No	—	Timetable that specifies when a schedule triggers.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "schedule-id": {
      "type": "string",
      "description": "The unique ID of the schedule."
    },
    "attribution-actor": {
      "type": "string",
      "description": "The attribution-actor of the scheduled pipeline.",
      "enum": [
        "current",
        "system"
      ]
    },
    "description": {
      "type": "string",
      "description": "Description of the schedule."
    },
    "name": {
      "type": "string",
      "description": "Name of the schedule."
    },
    "parameters": {
      "type": "object",
      "description": "Pipeline parameters represented as key-value pairs. Must contain branch or tag."
    },
    "timetable": {
      "type": "object",
      "description": "Timetable that specifies when a schedule triggers.",
      "properties": {
        "days-of-month": {
          "type": "array",
          "items": {
            "type": "integer",
            "format": "integer"
          },
          "description": "Days in a month in which the schedule triggers. This is mutually exclusive with days in a week."
        },
        "days-of-week": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "TUE",
              "SAT",
              "SUN",
              "MON",
              "THU",
              "WED",
              "FRI"
            ]
          },
          "description": "Days in a week in which the schedule triggers."
        },
        "hours-of-day": {
          "type": "array",
          "items": {
            "type": "integer",
            "format": "integer"
          },
          "description": "Hours in a day in which the schedule triggers."
        },
        "months": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "MAR",
              "NOV",
              "DEC",
              "JUN",
              "MAY",
              "OCT",
              "FEB",
              "APR",
              "SEP",
              "AUG",
              "JAN",
              "JUL"
            ]
          },
          "description": "Months in which the schedule triggers."
        },
        "per-hour": {
          "type": "integer",
          "description": "Number of times a schedule triggers per hour, value must be between 1 and 60"
        }
      }
    }
  },
  "required": [
    "PCID",
    "schedule-id"
  ]
}

circleci_pipelines_update_trigger

Update trigger Parameters:

Parameter	Type	Required	Default	Description
`project_id`	string	Yes	—	An opaque identifier of a project.
`trigger_id`	string	Yes	—	An opaque identifier of a trigger.
`checkout_ref`	string	No	—	The ref to use when checking out code for pipeline runs created from this trigger.
`config_ref`	string	No	—	The ref to use when fetching config for pipeline runs created from this trigger.
`disabled`	boolean	No	—	A flag indicating whether the trigger is disabled or not. Not supported for triggers where `event_source.provider` is `github_oauth`.
`event_name`	string	No	—	The name of the triggering event. Required when `provider` is `webhook` or `schedule`. Should not be set for other providers.
`event_preset`	string	No	—	The name of the event preset to use when filtering events for this trigger. Only applicable when `event_source.provider` is `github_app` or `github_server`.
`event_source`	object	No	—	Event Source
`parameters`	object	No	—	Pipeline parameters to pass when running pipelines from this trigger. Currently only supported for triggers where `event_source.provider` is `schedule`.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "project_id": {
      "type": "string",
      "description": "An opaque identifier of a project."
    },
    "trigger_id": {
      "type": "string",
      "description": "An opaque identifier of a trigger."
    },
    "checkout_ref": {
      "type": "string",
      "description": "The ref to use when checking out code for pipeline runs created from this trigger."
    },
    "config_ref": {
      "type": "string",
      "description": "The ref to use when fetching config for pipeline runs created from this trigger."
    },
    "disabled": {
      "type": "boolean",
      "description": "A flag indicating whether the trigger is disabled or not. Not supported for triggers where `event_source.provider` is `github_oauth`."
    },
    "event_name": {
      "type": "string",
      "description": "The name of the triggering event. Required when `provider` is `webhook` or `schedule`. Should not be set for other providers."
    },
    "event_preset": {
      "type": "string",
      "description": "The name of the event preset to use when filtering events for this trigger. Only applicable when `event_source.provider` is `github_app` or `github_server`.",
      "enum": [
        "all-pushes",
        "only-tags",
        "default-branch-pushes",
        "only-build-prs",
        "only-open-prs",
        "only-labeled-prs",
        "only-merged-prs",
        "only-ready-for-review-prs",
        "only-branch-delete",
        "only-build-pushes-to-non-draft-prs",
        "only-merged-or-closed-prs",
        "pr-comment-equals-run-ci",
        "non-draft-pr-opened",
        "pushes-to-merge-queues"
      ]
    },
    "event_source": {
      "type": "object",
      "description": "Event Source",
      "properties": {
        "schedule": {
          "type": "object",
          "description": "Schedule configuration to update for this trigger. Only applicable when `provider` is `schedule`."
        },
        "webhook": {
          "type": "object",
          "description": "The webhook value"
        }
      }
    },
    "parameters": {
      "type": "object",
      "description": "Pipeline parameters to pass when running pipelines from this trigger. Currently only supported for triggers where `event_source.provider` is `schedule`."
    }
  },
  "required": [
    "PCID",
    "project_id",
    "trigger_id"
  ]
}

circleci-admin circleci-projects

⌘I

​Tools

​circleci_pipelines_approve_pending_approval_job_by_id

​circleci_pipelines_cancel_job_by_job_id

​circleci_pipelines_cancel_job_by_job_number

​circleci_pipelines_cancel_workflow

​circleci_pipelines_continue_pipeline

​circleci_pipelines_create_pipeline_definition

​circleci_pipelines_create_schedule

​circleci_pipelines_create_trigger

​circleci_pipelines_delete_pipeline_definition

​circleci_pipelines_delete_schedule_by_id

​circleci_pipelines_delete_trigger

​circleci_pipelines_get_component

​circleci_pipelines_get_environment

​circleci_pipelines_get_job

​circleci_pipelines_get_job_artifacts

​circleci_pipelines_get_job_details

​circleci_pipelines_get_pipeline_by_id

​circleci_pipelines_get_pipeline_by_number

​circleci_pipelines_get_pipeline_config_by_id

​circleci_pipelines_get_pipeline_definition

​circleci_pipelines_get_pipeline_values_by_id

​circleci_pipelines_get_schedule_by_id

​circleci_pipelines_get_tests

​circleci_pipelines_get_trigger

​circleci_pipelines_get_workflow_by_id

​circleci_pipelines_list_component_versions

​circleci_pipelines_list_components

​circleci_pipelines_list_environments

​circleci_pipelines_list_my_pipelines

​circleci_pipelines_list_pipeline_definition_triggers

​circleci_pipelines_list_pipeline_definitions

​circleci_pipelines_list_pipelines

​circleci_pipelines_list_pipelines_for_project

​circleci_pipelines_list_schedules_for_project

​circleci_pipelines_list_workflow_jobs

​circleci_pipelines_list_workflows_by_pipeline_id

​circleci_pipelines_rerun_workflow

​circleci_pipelines_rollback_project

​circleci_pipelines_trigger_pipeline

​circleci_pipelines_trigger_pipeline_run

​circleci_pipelines_update_pipeline_definition

​circleci_pipelines_update_schedule

​circleci_pipelines_update_trigger

Tools

circleci_pipelines_approve_pending_approval_job_by_id

circleci_pipelines_cancel_job_by_job_id

circleci_pipelines_cancel_job_by_job_number

circleci_pipelines_cancel_workflow

circleci_pipelines_continue_pipeline

circleci_pipelines_create_pipeline_definition

circleci_pipelines_create_schedule

circleci_pipelines_create_trigger

circleci_pipelines_delete_pipeline_definition

circleci_pipelines_delete_schedule_by_id

circleci_pipelines_delete_trigger

circleci_pipelines_get_component

circleci_pipelines_get_environment

circleci_pipelines_get_job

circleci_pipelines_get_job_artifacts

circleci_pipelines_get_job_details

circleci_pipelines_get_pipeline_by_id

circleci_pipelines_get_pipeline_by_number

circleci_pipelines_get_pipeline_config_by_id

circleci_pipelines_get_pipeline_definition

circleci_pipelines_get_pipeline_values_by_id

circleci_pipelines_get_schedule_by_id

circleci_pipelines_get_tests

circleci_pipelines_get_trigger

circleci_pipelines_get_workflow_by_id

circleci_pipelines_list_component_versions

circleci_pipelines_list_components

circleci_pipelines_list_environments

circleci_pipelines_list_my_pipelines

circleci_pipelines_list_pipeline_definition_triggers

circleci_pipelines_list_pipeline_definitions

circleci_pipelines_list_pipelines

circleci_pipelines_list_pipelines_for_project

circleci_pipelines_list_schedules_for_project

circleci_pipelines_list_workflow_jobs

circleci_pipelines_list_workflows_by_pipeline_id

circleci_pipelines_rerun_workflow

circleci_pipelines_rollback_project

circleci_pipelines_trigger_pipeline

circleci_pipelines_trigger_pipeline_run

circleci_pipelines_update_pipeline_definition

circleci_pipelines_update_schedule

circleci_pipelines_update_trigger