Get merge readiness for a change (repo_id addressing)

curl --request GET \
  --url https://aws-us-east-2.api.entire.io/api/v1/repos/{repo_id}/changes/{number}/mergeability \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://aws-us-east-2.api.entire.io/api/v1/repos/{repo_id}/changes/{number}/mergeability"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://aws-us-east-2.api.entire.io/api/v1/repos/{repo_id}/changes/{number}/mergeability', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://aws-us-east-2.api.entire.io/api/v1/repos/{repo_id}/changes/{number}/mergeability",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://aws-us-east-2.api.entire.io/api/v1/repos/{repo_id}/changes/{number}/mergeability"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://aws-us-east-2.api.entire.io/api/v1/repos/{repo_id}/changes/{number}/mergeability")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "behind_by": 123,
  "bypass_policy": "<string>",
  "checks": {
    "availability": "available",
    "runs": [
      {
        "app_name": "<string>",
        "completed_at": "2023-11-07T05:31:56Z",
        "conclusion": "<string>",
        "details_url": "<string>",
        "name": "<string>",
        "started_at": "2023-11-07T05:31:56Z",
        "status": "<string>",
        "source": "<string>",
        "steps": [
          {
            "conclusion": "<string>",
            "id": "<string>",
            "name": "<string>",
            "status": "<string>",
            "exit_status": 123
          }
        ]
      }
    ]
  },
  "comparison_status": "<string>",
  "conflict_status": "clean",
  "delete_branch_on_merge": true,
  "forge_merge_block": {
    "reason": "<string>",
    "required_approving_review_count": 123
  },
  "gates": [
    {
      "blocking": true,
      "completed_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "evaluated_at_sha": "<string>",
      "finding_count": 123,
      "gate_definition_id": "<string>",
      "gate_key": "<string>",
      "gate_type": "<string>",
      "head_sha": "<string>",
      "id": "<string>",
      "outcome": "<string>",
      "rationale": "<string>",
      "reviewers": [
        {
          "login": "<string>",
          "reason": "<string>",
          "reviewed_head_sha": "<string>",
          "state": "pending",
          "actor_account_id": "<string>"
        }
      ],
      "runner_ids": [
        "<string>"
      ],
      "stale_reason": "<string>",
      "status": "<string>",
      "value": "<unknown>",
      "not_applicable_reason": "no_changes",
      "state": "<string>"
    }
  ],
  "head_sha": "<string>",
  "mergeable": true,
  "$schema": "/api/v1/schemas/TrailMergeabilityResponse.json"
}

{
  "error": "<string>",
  "$schema": "/api/v1/schemas/ApiError.json",
  "code": "<string>",
  "detail": "<string>"
}

{
  "error": "<string>",
  "$schema": "/api/v1/schemas/ApiError.json",
  "code": "<string>",
  "detail": "<string>"
}

{
  "error": "<string>",
  "$schema": "/api/v1/schemas/ApiError.json",
  "code": "<string>",
  "detail": "<string>"
}

{
  "error": "<string>",
  "$schema": "/api/v1/schemas/ApiError.json",
  "code": "<string>",
  "detail": "<string>"
}

{
  "error": "<string>",
  "$schema": "/api/v1/schemas/ApiError.json",
  "code": "<string>",
  "detail": "<string>"
}

{
  "error": "<string>",
  "$schema": "/api/v1/schemas/ApiError.json",
  "code": "<string>",
  "detail": "<string>"
}

{
  "error": "<string>",
  "$schema": "/api/v1/schemas/ApiError.json",
  "code": "<string>",
  "detail": "<string>"
}

Approvals

Get merge readiness for a change (repo_id addressing)

Users Plugins

Accepted credentials: User token, Plugin installation token.

Use an own-account bearer token (including supported service accounts) or a Core-issued plugin installation bearer token, subject to the permissions and restrictions below. Plugin assertion JWTs and plugin OAuth user-delegation tokens are not accepted here.

Requires live repository pull permission (contents:read for plugin installations). Other authorized automation principals can also use this operation. Trails must be enabled. Send requests to the repository’s primary API region.

GET

repos

{repo_id}

changes

{number}

mergeability

Get merge readiness for a change (repo_id addressing)

curl --request GET \
  --url https://aws-us-east-2.api.entire.io/api/v1/repos/{repo_id}/changes/{number}/mergeability \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://aws-us-east-2.api.entire.io/api/v1/repos/{repo_id}/changes/{number}/mergeability"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://aws-us-east-2.api.entire.io/api/v1/repos/{repo_id}/changes/{number}/mergeability', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://aws-us-east-2.api.entire.io/api/v1/repos/{repo_id}/changes/{number}/mergeability",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://aws-us-east-2.api.entire.io/api/v1/repos/{repo_id}/changes/{number}/mergeability"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://aws-us-east-2.api.entire.io/api/v1/repos/{repo_id}/changes/{number}/mergeability")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "behind_by": 123,
  "bypass_policy": "<string>",
  "checks": {
    "availability": "available",
    "runs": [
      {
        "app_name": "<string>",
        "completed_at": "2023-11-07T05:31:56Z",
        "conclusion": "<string>",
        "details_url": "<string>",
        "name": "<string>",
        "started_at": "2023-11-07T05:31:56Z",
        "status": "<string>",
        "source": "<string>",
        "steps": [
          {
            "conclusion": "<string>",
            "id": "<string>",
            "name": "<string>",
            "status": "<string>",
            "exit_status": 123
          }
        ]
      }
    ]
  },
  "comparison_status": "<string>",
  "conflict_status": "clean",
  "delete_branch_on_merge": true,
  "forge_merge_block": {
    "reason": "<string>",
    "required_approving_review_count": 123
  },
  "gates": [
    {
      "blocking": true,
      "completed_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "evaluated_at_sha": "<string>",
      "finding_count": 123,
      "gate_definition_id": "<string>",
      "gate_key": "<string>",
      "gate_type": "<string>",
      "head_sha": "<string>",
      "id": "<string>",
      "outcome": "<string>",
      "rationale": "<string>",
      "reviewers": [
        {
          "login": "<string>",
          "reason": "<string>",
          "reviewed_head_sha": "<string>",
          "state": "pending",
          "actor_account_id": "<string>"
        }
      ],
      "runner_ids": [
        "<string>"
      ],
      "stale_reason": "<string>",
      "status": "<string>",
      "value": "<unknown>",
      "not_applicable_reason": "no_changes",
      "state": "<string>"
    }
  ],
  "head_sha": "<string>",
  "mergeable": true,
  "$schema": "/api/v1/schemas/TrailMergeabilityResponse.json"
}

{
  "error": "<string>",
  "$schema": "/api/v1/schemas/ApiError.json",
  "code": "<string>",
  "detail": "<string>"
}

{
  "error": "<string>",
  "$schema": "/api/v1/schemas/ApiError.json",
  "code": "<string>",
  "detail": "<string>"
}

{
  "error": "<string>",
  "$schema": "/api/v1/schemas/ApiError.json",
  "code": "<string>",
  "detail": "<string>"
}

{
  "error": "<string>",
  "$schema": "/api/v1/schemas/ApiError.json",
  "code": "<string>",
  "detail": "<string>"
}

{
  "error": "<string>",
  "$schema": "/api/v1/schemas/ApiError.json",
  "code": "<string>",
  "detail": "<string>"
}

{
  "error": "<string>",
  "$schema": "/api/v1/schemas/ApiError.json",
  "code": "<string>",
  "detail": "<string>"
}

{
  "error": "<string>",
  "$schema": "/api/v1/schemas/ApiError.json",
  "code": "<string>",
  "detail": "<string>"
}

Authorizations

Authorization

string

header

required

OAuth 2.0 authorization code flow.

Path Parameters

repo_id

string

required

Repo id: placement ULID or public repo_

number

string

required

Trail number

Response

behind_by

integer<int64>

required

bypass_policy

string

required

Effective bypass policy for this response. When readiness is unavailable, nobody is a fail-closed fallback, not the saved repository setting; merge actions remain unavailable.

checks

object

required

Third-party CI runs for headSha from the same read that evaluated the checks gate; Entire's own gate rollup is excluded. On an open native trail whose checks gate is pending, each required name with no report is also listed, with status queued and no started_at, whatever checks.availability says. Reported runs are meaningful only when checks.availability is available.

Show child attributes

comparison_status

string

required

conflict_status

enum<string>

required

Provider conflict verdict for headSha; mergeable requires clean, independently of gates and CI evidence. The merge action is blocked only by conflicting: an unknown verdict leaves conflicts to the forge's merge.

Available options:

clean,

conflicting,

unknown

delete_branch_on_merge

boolean | null

required

Default for the merge request's deleteBranch option, i.e. the repository's delete-branch-on-merge setting; false means the setting is off. Null for a GitHub-backed repository, where entire-api never deletes the branch, and when readiness is unavailable.

forge_merge_block

object

required

Set when the forge's own branch rules (GitHub branch protection or rulesets) refuse the merge at headSha, independent of Entire's gates. Read under the GitHub App's credential, so it does not reflect a viewer's ability to bypass. Null when not blocked or unknown, and when GitHub waits only on Entire's own gates check run, which the gates already report.

Show child attributes

gates

object[] | null

required

Show child attributes

head_sha

string | null

required

mergeable

boolean

required

$schema

string<uri>

read-only

A URL to the JSON Schema for this object.

Example:

"/api/v1/schemas/TrailMergeabilityResponse.json"

Documentation

Accounts and projects

Git

Trails

Sessions and checkpoints

Webhooks

Get merge readiness for a change (repo_id addressing)

Authorizations

Path Parameters

Response