---
title: "実行する Pipeline"
url: https://docs.catalyst.zoho.com/ja/api/code-reference/pipelines/execute-pipeline/
description: "このAPIを使用すると、CatalystコンソールからCatalyst Pipelineを実行できます。"
last_updated: 2026-03-05T06:13:24Z
service: Pipelines
type: api
---

# Pipelineの実行

このAPIを使用すると、Gitリポジトリ内の特定のブランチでパイプラインをトリガーできます。これは、リクエストボディでパラメータとしてブランチ名を渡すことで行えます。手動パイプラインをトリガーする場合は、リクエストJSONのブランチ名パラメータを省略できます。

このAPIをトリガーすると、パイプラインが実行され、実行のステータスがレスポンスとして返されます。

# Pipeline詳細の取得

このAPIを使用すると、Catalystコンソールで作成されたパイプラインの詳細を取得できます。これは、リクエストURLに`pipeline_id`と`project_id`を渡すことで行えます。APIは、パイプラインが作成されたプロジェクトの詳細とパイプラインの詳細を取得します。
 
### リクエスト詳細

#### リクエストURL

`POST` {api-domain}/baas/v1/project/{project_id}/pipeline/{pipeline_id}/run

- **api-domain** (URL): DCのドメインURL

- **project_id** (Numerical): パイプラインが作成されたプロジェクトの[一意のID](https://docs.catalyst.zoho.com/ja/getting-started/set-up-a-catalyst-project/general-settings/)

- **pipeline_id** (Numerical): 詳細を取得するパイプラインの[一意のID](https://docs.catalyst.zoho.com/ja/pipelines/help/triggers/monitor-execution-status)

#### リクエストJSONプロパティ

- **BRANCH_NAME** (string, mandatory): Gitブランチの名前を指定します 

- **EVENT** (string, optional): イベントの詳細を指定します 

- **URL** (url, optional): 必要な追加パラメータ 

> **注意:**

1. 手動のCatalyst Pipelineをトリガーする場合、`BRANCH_NAME`は任意です。
2. EVENTおよびURLキーは環境変数として追加されています。パイプラインの実行に必要なキーをイベントJSONで渡すことができます。

#### スコープ

pipeline.execution.CREATE

### レスポンス詳細

パイプライン作成履歴の詳細を含むオブジェクトがレスポンスとして返されます。オブジェクトには、`history_id`、`event_time`、`history_status`などの詳細が含まれます。

**リクエスト例**

```bash
curl -X POST \
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/pipeline/29810101101/run 
-H "Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57" \
-d '{
"BRANCH_NAME" : "main", \
 "EVENT": "push", \ 
 "URL": "https://www.google.com" \
}

```

**レスポンス例**

```json
{
 "status": "success",
 "data": {
 "history_id": "5000000021007",
 "pipeline_id": "29810101101",
 "event_time": "Mar 20, 2024 02:02 PM",
 "event_details": {
 "BRANCH_NAME": "main",
 "EVENT": "push",
 "URL": "https://www.google.com"
 },
 "history_status": "Queued"
 }
}

```

### SDK Documentation

[Execute Pipeline - Java SDK](https://docs.catalyst.zoho.com/ja/sdk/java/v1/pipelines/execute-pipeline/)

[Execute Pipeline - Node.js SDK](https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/pipelines/execute-pipeline/)

[Execute Pipeline  - Python SDK](https://docs.catalyst.zoho.com/ja/sdk/python/v1/pipelines/execute-pipeline/)