branch protection rule

The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.9/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.

APIs.ioEngineeringPlatform

Properties

Name Type Description
admin_enforced boolean
allow_deletions_enforcement_level string
allow_force_pushes_enforcement_level string
authorized_actor_names array
authorized_actors_only boolean
authorized_dismissal_actors_only boolean
create_protected boolean
created_at string
dismiss_stale_reviews_on_push boolean
id integer
ignore_approvals_from_contributors boolean
linear_history_requirement_enforcement_level string
merge_queue_enforcement_level string
name string
pull_request_reviews_enforcement_level string
repository_id integer
require_code_owner_review boolean
required_approving_review_count integer
required_conversation_resolution_level string
required_deployments_enforcement_level string
required_status_checks array
required_status_checks_enforcement_level string
signature_requirement_enforcement_level string
strict_required_status_checks_policy boolean
updated_at string
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-webhooks-rule-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/webhooks_rule",
  "title": "branch protection rule",
  "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.9/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.",
  "type": "object",
  "properties": {
    "admin_enforced": {
      "type": "boolean"
    },
    "allow_deletions_enforcement_level": {
      "type": "string",
      "enum": [
        "off",
        "non_admins",
        "everyone"
      ]
    },
    "allow_force_pushes_enforcement_level": {
      "type": "string",
      "enum": [
        "off",
        "non_admins",
        "everyone"
      ]
    },
    "authorized_actor_names": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "authorized_actors_only": {
      "type": "boolean"
    },
    "authorized_dismissal_actors_only": {
      "type": "boolean"
    },
    "create_protected": {
      "type": "boolean"
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "dismiss_stale_reviews_on_push": {
      "type": "boolean"
    },
    "id": {
      "type": "integer"
    },
    "ignore_approvals_from_contributors": {
      "type": "boolean"
    },
    "linear_history_requirement_enforcement_level": {
      "type": "string",
      "enum": [
        "off",
        "non_admins",
        "everyone"
      ]
    },
    "merge_queue_enforcement_level": {
      "type": "string",
      "enum": [
        "off",
        "non_admins",
        "everyone"
      ]
    },
    "name": {
      "type": "string"
    },
    "pull_request_reviews_enforcement_level": {
      "type": "string",
      "enum": [
        "off",
        "non_admins",
        "everyone"
      ]
    },
    "repository_id": {
      "type": "integer"
    },
    "require_code_owner_review": {
      "type": "boolean"
    },
    "required_approving_review_count": {
      "type": "integer"
    },
    "required_conversation_resolution_level": {
      "type": "string",
      "enum": [
        "off",
        "non_admins",
        "everyone"
      ]
    },
    "required_deployments_enforcement_level": {
      "type": "string",
      "enum": [
        "off",
        "non_admins",
        "everyone"
      ]
    },
    "required_status_checks": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "required_status_checks_enforcement_level": {
      "type": "string",
      "enum": [
        "off",
        "non_admins",
        "everyone"
      ]
    },
    "signature_requirement_enforcement_level": {
      "type": "string",
      "enum": [
        "off",
        "non_admins",
        "everyone"
      ]
    },
    "strict_required_status_checks_policy": {
      "type": "boolean"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    }
  },
  "required": [
    "id",
    "repository_id",
    "name",
    "created_at",
    "updated_at",
    "pull_request_reviews_enforcement_level",
    "required_approving_review_count",
    "dismiss_stale_reviews_on_push",
    "require_code_owner_review",
    "authorized_dismissal_actors_only",
    "ignore_approvals_from_contributors",
    "required_status_checks",
    "required_status_checks_enforcement_level",
    "strict_required_status_checks_policy",
    "signature_requirement_enforcement_level",
    "linear_history_requirement_enforcement_level",
    "lock_branch_enforcement_level",
    "admin_enforced",
    "allow_force_pushes_enforcement_level",
    "allow_deletions_enforcement_level",
    "merge_queue_enforcement_level",
    "required_deployments_enforcement_level",
    "required_conversation_resolution_level",
    "authorized_actors_only",
    "authorized_actor_names"
  ]
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/apis-io-engineering-platform-webhooks-rule"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.