エージェントマージの REST API エンドポイント

Get Agent Merge configuration for a pull request

Gets the Agent Merge configuration for a pull request.

You must have write access to the repository.

OAuth app tokens and personal access tokens (classic) need the repo scope for private or internal repositories, or the public_repo scope for public repositories.

"Get Agent Merge configuration for a pull request" のパラメーター

ヘッダー
名前, タイプ, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.

パスパラメーター
名前, タイプ, 説明
`owner` string 必須 The account owner of the repository. The name is not case sensitive.
`repo` string 必須 The name of the repository. The name is not case sensitive.
`pull_number` integer 必須 The number that identifies the pull request.

"Get Agent Merge configuration for a pull request" の HTTP 応答状態コード

状態コード	説明
`200`	Stored configuration retrieved successfully
`401`	Authentication required
`403`	Caller is not permitted to read this enrollment
`404`	Resource or enrollment is absent, enrollment is disabled, or access is masked as not found
`422`	Invalid request parameters
`429`	Rate limit exceeded
`503`	Enrollment storage or an authorization dependency is unavailable

"Get Agent Merge configuration for a pull request" のコードサンプル

要求の例

get/agents/repos/{owner}/{repo}/pulls/{pull_number}/agent-merge

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/agents/repos/OWNER/REPO/pulls/PULL_NUMBER/agent-merge

Agent Merge configuration for an enrolled pull request

Status: 200

{
  "allowed_actions": [
    "fix_ci",
    "resolve_merge_conflicts"
  ],
  "created_at": "2026-09-09T12:00:00Z",
  "updated_at": "2026-09-09T12:00:00Z",
  "user": {
    "id": 9876
  }
}

Update Agent Merge configuration for a pull request

Updates the Agent Merge configuration for a pull request, enabling Agent Merge or changing the allowed actions that Copilot is allowed to take on the pull request.

If Agent Merge is currently enabled for the pull request, only the user who most recently enabled it may change its allowed actions.

If enrollment eligibility cannot be determined, the operation returns 503.

This endpoint is only available to users with a Copilot subscription, excluding Copilot Free users. You must have write access to the repository, the pull request must not be from a fork or part of a stack, and the repository must have the "Allow automations" setting enabled.

OAuth app tokens and personal access tokens (classic) need the repo scope for private or internal repositories, or the public_repo scope for public repositories.

"Update Agent Merge configuration for a pull request" のパラメーター

ヘッダー
名前, タイプ, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.

パスパラメーター
名前, タイプ, 説明
`owner` string 必須 The account owner of the repository. The name is not case sensitive.
`repo` string 必須 The name of the repository. The name is not case sensitive.
`pull_number` integer 必須 The number that identifies the pull request.

ボディパラメータ
名前, タイプ, 説明
`allowed_actions` array of strings 必須 The set of actions that Copilot may perform on the pull request. Supported values are: `fix_ci`, `resolve_merge_conflicts`

"Update Agent Merge configuration for a pull request" の HTTP 応答状態コード

状態コード	説明
`200`	Existing Agent Merge enrollment updated
`201`	Pull request enrolled for Agent Merge
`400`	Malformed JSON request body
`401`	Authentication required
`403`	Caller lacks the permissions or eligibility to enroll the pull request for Agent Merge
`404`	Resource is absent or masked as not found
`409`	Enrollment changed during the write; no replacement was committed
`422`	Ineligible pull request, invalid action selection, or unknown body properties
`429`	Rate limit exceeded
`503`	Enrollment storage or an authorization dependency is unavailable, or eligibility is unknown

"Update Agent Merge configuration for a pull request" のコードサンプル

リクエスト例

Select the example type

put/agents/repos/{owner}/{repo}/pulls/{pull_number}/agent-merge

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/agents/repos/OWNER/REPO/pulls/PULL_NUMBER/agent-merge \
  -d '{"allowed_actions":["fix_ci"]}'

Pull request enrolled for Agent Merge

Status: 201

{
  "allowed_actions": [
    "fix_ci"
  ],
  "created_at": "2026-09-09T12:00:00Z",
  "updated_at": "2026-09-09T12:00:00Z",
  "user": {
    "id": 9876
  }
}

Disable Agent Merge for a pull request

Disables Agent Merge for a pull request.

You must have write access to the repository. Disabling does not require enrollment eligibility: your Copilot subscription, coding-agent and Automations policies, the Agent Merge execution flag, pull request state, stack membership, and repository archive state do not prevent cleanup. Authentication, token repository selection, and "Agent tasks" write permission remain required.

OAuth app tokens and personal access tokens (classic) need the repo scope for private or internal repositories, or the public_repo scope for public repositories.

"Disable Agent Merge for a pull request" のパラメーター

ヘッダー
名前, タイプ, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.

パスパラメーター
名前, タイプ, 説明
`owner` string 必須 The account owner of the repository. The name is not case sensitive.
`repo` string 必須 The name of the repository. The name is not case sensitive.
`pull_number` integer 必須 The number that identifies the pull request.

"Disable Agent Merge for a pull request" の HTTP 応答状態コード

状態コード	説明
`204`	Agent Merge successfully disabled for the pull request
`401`	Authentication required
`403`	Caller lacks write permission
`404`	Resource or enrollment is absent or masked as not found
`409`	Enrollment changed during the write; no replacement was committed
`422`	Invalid request parameters
`429`	Rate limit exceeded
`503`	Enrollment storage, authorization, or required publication is unavailable

"Disable Agent Merge for a pull request" のコードサンプル

要求の例

delete/agents/repos/{owner}/{repo}/pulls/{pull_number}/agent-merge

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/agents/repos/OWNER/REPO/pulls/PULL_NUMBER/agent-merge

Agent Merge successfully disabled for the pull request

Status: 204

エージェントマージの REST API エンドポイント

Get Agent Merge configuration for a pull request

"Get Agent Merge configuration for a pull request" のパラメーター

"Get Agent Merge configuration for a pull request" の HTTP 応答状態コード

"Get Agent Merge configuration for a pull request" のコードサンプル

要求の例

Agent Merge configuration for an enrolled pull request

Update Agent Merge configuration for a pull request

"Update Agent Merge configuration for a pull request" のパラメーター

"Update Agent Merge configuration for a pull request" の HTTP 応答状態コード

"Update Agent Merge configuration for a pull request" のコードサンプル

リクエスト例

Pull request enrolled for Agent Merge

Disable Agent Merge for a pull request

"Disable Agent Merge for a pull request" のパラメーター

"Disable Agent Merge for a pull request" の HTTP 応答状態コード

"Disable Agent Merge for a pull request" のコードサンプル

要求の例

Agent Merge successfully disabled for the pull request

このドキュメントは役に立ちましたか?

まだ助けが必要ですか？

エージェント マージの REST API エンドポイント

要求の例

Agent Merge configuration for an enrolled pull request

リクエスト例

Pull request enrolled for Agent Merge

要求の例

Agent Merge successfully disabled for the pull request

エージェントマージの REST API エンドポイント