GitHub Jobs API

openapi: 3.0.3
info:
  version: 1.1.4
  title: GitHub Application About Jobs API
  description: 'Use the REST API to retrieve information about GitHub Apps and GitHub App

    installations.'
  license:
    name: MIT
    url: https://spdx.org/licenses/MIT
  termsOfService: https://docs.github.com/articles/github-terms-of-service
  contact:
    name: Support
    url: https://support.github.com/contact?tags=dotcom-rest-api
  x-github-plan: ghes
  x-github-release: 3.9
servers:
- url: '{protocol}://{hostname}/api/v3'
  variables:
    hostname:
      description: Self-hosted Enterprise Server hostname
      default: HOSTNAME
    protocol:
      description: Self-hosted Enterprise Server protocol
      default: http
tags:
- name: Jobs
paths:
  /repos/{owner}/{repo}/actions/jobs/{job_id}:
    get:
      summary: GitHub Get Job for Workflow Run
      description: 'Gets a specific job in a workflow run.


        Anyone with read access to the repository can use this endpoint.


        If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.'
      tags:
      - Jobs
      operationId: getJobForWorkflowRun
      externalDocs:
        description: API method documentation
        url: https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run
      parameters:
      - $ref: '#/components/parameters/owner'
      - $ref: '#/components/parameters/repo'
      - $ref: '#/components/parameters/job-id'
      - in: header
        name: Authorization
        schema:
          type: string
        example: example_value
      - in: header
        name: X-GitHub-Api-Version
        schema:
          type: string
          default: '2022-11-28'
        example: example_value
      - in: header
        name: Accept
        schema:
          type: string
          default: application/vnd.github+json
        example: example_value
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/job'
              examples:
                default:
                  $ref: '#/components/examples/job'
      x-github:
        githubCloudOnly: false
        enabledForGitHubApps: true
        category: actions
        subcategory: workflow-jobs
      security:
      - bearerHttpAuthentication: []
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /repos/{owner}/{repo}/actions/jobs/{job_id}/logs:
    get:
      summary: GitHub Download Job Logs for Workflow Run
      description: 'Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look

        for `Location:` in the response header to find the URL for the download.


        Anyone with read access to the repository can use this endpoint.


        If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.'
      tags:
      - Jobs
      operationId: downloadJobLogsForWorkflowRun
      externalDocs:
        description: API method documentation
        url: https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run
      parameters:
      - $ref: '#/components/parameters/owner'
      - $ref: '#/components/parameters/repo'
      - $ref: '#/components/parameters/job-id'
      - in: header
        name: Authorization
        schema:
          type: string
        example: example_value
      - in: header
        name: X-GitHub-Api-Version
        schema:
          type: string
          default: '2022-11-28'
        example: example_value
      - in: header
        name: Accept
        schema:
          type: string
          default: application/vnd.github+json
        example: example_value
      responses:
        '302':
          description: Response
          headers:
            Location:
              example: https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/jobs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D
              schema:
                type: string
      x-github:
        githubCloudOnly: false
        enabledForGitHubApps: true
        category: actions
        subcategory: workflow-jobs
      security:
      - bearerHttpAuthentication: []
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /repos/{owner}/{repo}/actions/jobs/{job_id}/rerun:
    post:
      summary: GitHub Re-run Job from Workflow Run
      description: 'Re-run a job and its dependent jobs in a workflow run.


        OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.'
      tags:
      - Jobs
      operationId: rerunJobFromWorkflowRun
      externalDocs:
        description: API method documentation
        url: https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run
      parameters:
      - $ref: '#/components/parameters/owner'
      - $ref: '#/components/parameters/repo'
      - $ref: '#/components/parameters/job-id'
      - in: header
        name: Authorization
        schema:
          type: string
        example: example_value
      - in: header
        name: X-GitHub-Api-Version
        schema:
          type: string
          default: '2022-11-28'
        example: example_value
      - in: header
        name: Accept
        schema:
          type: string
          default: application/vnd.github+json
        example: example_value
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                enable_debug_logging:
                  type: boolean
                  default: false
                  description: Whether to enable debug logging for the re-run.
            examples:
              default:
                value: {}
      responses:
        '201':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/empty-object'
              examples:
                default:
                  value: {}
        '403':
          $ref: '#/components/responses/forbidden'
      x-github:
        githubCloudOnly: false
        enabledForGitHubApps: true
        category: actions
        subcategory: workflow-runs
      security:
      - bearerHttpAuthentication: []
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs:
    get:
      summary: GitHub List Jobs for Workflow Run Attempt
      description: 'Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information

        about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#parameters).


        Anyone with read access to the repository can use this endpoint.


        OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint  with a private repository.'
      tags:
      - Jobs
      operationId: listJobsForWorkflowRunAttempt
      externalDocs:
        description: API method documentation
        url: https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt
      parameters:
      - $ref: '#/components/parameters/owner'
      - $ref: '#/components/parameters/repo'
      - $ref: '#/components/parameters/run-id'
      - $ref: '#/components/parameters/attempt-number'
      - $ref: '#/components/parameters/per-page'
      - $ref: '#/components/parameters/page'
      - in: header
        name: Authorization
        schema:
          type: string
        example: example_value
      - in: header
        name: X-GitHub-Api-Version
        schema:
          type: string
          default: '2022-11-28'
        example: example_value
      - in: header
        name: Accept
        schema:
          type: string
          default: application/vnd.github+json
        example: example_value
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                type: object
                required:
                - total_count
                - jobs
                properties:
                  total_count:
                    type: integer
                  jobs:
                    type: array
                    items:
                      $ref: '#/components/schemas/job'
              examples:
                default:
                  $ref: '#/components/examples/job-paginated'
          headers:
            Link:
              $ref: '#/components/headers/link'
        '404':
          $ref: '#/components/responses/not_found'
      x-github:
        githubCloudOnly: false
        enabledForGitHubApps: true
        category: actions
        subcategory: workflow-jobs
      security:
      - bearerHttpAuthentication: []
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /repos/{owner}/{repo}/actions/runs/{run_id}/jobs:
    get:
      summary: GitHub List Jobs for Workflow Run
      description: 'Lists jobs for workflow run. You can use parameters to narrow the list of results. For more information

        about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#parameters).


        Anyone with read access to the repository can use this endpoint.


        OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private repository.'
      tags:
      - Jobs
      operationId: listJobsForWorkflowRun
      externalDocs:
        description: API method documentation
        url: https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run
      parameters:
      - $ref: '#/components/parameters/owner'
      - $ref: '#/components/parameters/repo'
      - $ref: '#/components/parameters/run-id'
      - name: filter
        description: Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all jobs for workflow run, including from old executions of the workflow run.
        in: query
        required: false
        schema:
          type: string
          enum:
          - latest
          - all
          default: latest
        example: latest
      - $ref: '#/components/parameters/per-page'
      - $ref: '#/components/parameters/page'
      - in: header
        name: Authorization
        schema:
          type: string
        example: example_value
      - in: header
        name: X-GitHub-Api-Version
        schema:
          type: string
          default: '2022-11-28'
        example: example_value
      - in: header
        name: Accept
        schema:
          type: string
          default: application/vnd.github+json
        example: example_value
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                type: object
                required:
                - total_count
                - jobs
                properties:
                  total_count:
                    type: integer
                  jobs:
                    type: array
                    items:
                      $ref: '#/components/schemas/job'
              examples:
                default:
                  $ref: '#/components/examples/job-paginated'
          headers:
            Link:
              $ref: '#/components/headers/link'
      x-github:
        githubCloudOnly: false
        enabledForGitHubApps: true
        category: actions
        subcategory: workflow-jobs
      security:
      - bearerHttpAuthentication: []
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs:
    post:
      summary: GitHub Re-run Failed Jobs from Workflow Run
      description: 'Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run.


        OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.'
      tags:
      - Jobs
      operationId: rerunFailedJobsFromWorkflowRun
      externalDocs:
        description: API method documentation
        url: https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run
      parameters:
      - $ref: '#/components/parameters/owner'
      - $ref: '#/components/parameters/repo'
      - $ref: '#/components/parameters/run-id'
      - in: header
        name: Authorization
        schema:
          type: string
        example: example_value
      - in: header
        name: X-GitHub-Api-Version
        schema:
          type: string
          default: '2022-11-28'
        example: example_value
      - in: header
        name: Accept
        schema:
          type: string
          default: application/vnd.github+json
        example: example_value
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                enable_debug_logging:
                  type: boolean
                  default: false
                  description: Whether to enable debug logging for the re-run.
            examples:
              default:
                value: {}
      responses:
        '201':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/empty-object'
              examples:
                default:
                  value: {}
      x-github:
        githubCloudOnly: false
        enabledForGitHubApps: true
        category: actions
        subcategory: workflow-runs
      security:
      - bearerHttpAuthentication: []
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  parameters:
    page:
      name: page
      description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
      in: query
      schema:
        type: integer
        default: 1
    repo:
      name: repo
      description: The name of the repository without the `.git` extension. The name is not case sensitive.
      in: path
      required: true
      schema:
        type: string
    owner:
      name: owner
      description: The account owner of the repository. The name is not case sensitive.
      in: path
      required: true
      schema:
        type: string
    job-id:
      name: job_id
      description: The unique identifier of the job.
      in: path
      required: true
      schema:
        type: integer
    per-page:
      name: per_page
      description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
      in: query
      schema:
        type: integer
        default: 30
    attempt-number:
      name: attempt_number
      description: The attempt number of the workflow run.
      in: path
      required: true
      schema:
        type: integer
    run-id:
      name: run_id
      description: The unique identifier of the workflow run.
      in: path
      required: true
      schema:
        type: integer
  schemas:
    basic-error:
      title: Basic Error
      description: Basic Error
      type: object
      properties:
        message:
          type: string
          example: Example body text
        documentation_url:
          type: string
          example: https://api.github.com/repos/octocat/Hello-World
        url:
          type: string
          example: https://api.github.com/repos/octocat/Hello-World
        status:
          type: string
          example: open
    job:
      title: Job
      description: Information of a job execution in a workflow run
      type: object
      properties:
        id:
          description: The id of the job.
          example: 21
          type: integer
        run_id:
          description: The id of the associated workflow run.
          example: 5
          type: integer
        run_url:
          type: string
          example: https://api.github.com/repos/github/hello-world/actions/runs/5
        run_attempt:
          type: integer
          description: Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run.
          example: 1
        node_id:
          type: string
          example: MDg6Q2hlY2tSdW40
        head_sha:
          description: The SHA of the commit that is being run.
          example: 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d
          type: string
        url:
          type: string
          example: https://api.github.com/repos/github/hello-world/actions/jobs/21
        html_url:
          type: string
          example: https://github.com/github/hello-world/runs/4
        status:
          description: The phase of the lifecycle that the job is currently in.
          example: queued
          type: string
          enum:
          - queued
          - in_progress
          - completed
          - waiting
          - requested
          - pending
        conclusion:
          description: The outcome of the job.
          example: success
          type: string
          enum:
          - success
          - failure
          - neutral
          - cancelled
          - skipped
          - timed_out
          - action_required
        created_at:
          description: The time that the job created, in ISO 8601 format.
          example: '2019-08-08T08:00:00-07:00'
          format: date-time
          type: string
        started_at:
          description: The time that the job started, in ISO 8601 format.
          example: '2019-08-08T08:00:00-07:00'
          format: date-time
          type: string
        completed_at:
          description: The time that the job finished, in ISO 8601 format.
          example: '2019-08-08T08:00:00-07:00'
          format: date-time
          type: string
        name:
          description: The name of the job.
          example: test-coverage
          type: string
        steps:
          description: Steps in this job.
          type: array
          items:
            type: object
            required:
            - name
            - status
            - conclusion
            - number
            properties:
              status:
                description: The phase of the lifecycle that the job is currently in.
                example: queued
                type: string
                enum:
                - queued
                - in_progress
                - completed
              conclusion:
                description: The outcome of the job.
                example: success
                type: string
              name:
                description: The name of the job.
                example: test-coverage
                type: string
              number:
                type: integer
                example: 1
              started_at:
                description: The time that the step started, in ISO 8601 format.
                example: '2019-08-08T08:00:00-07:00'
                format: date-time
                type: string
              completed_at:
                description: The time that the job finished, in ISO 8601 format.
                example: '2019-08-08T08:00:00-07:00'
                format: date-time
                type: string
        check_run_url:
          type: string
          example: https://api.github.com/repos/github/hello-world/check-runs/4
        labels:
          type: array
          items:
            type: string
          description: Labels for the workflow job. Specified by the "runs_on" attribute in the action's workflow file.
          example:
          - self-hosted
          - foo
          - bar
        runner_id:
          type: integer
          example: 1
          description: The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)
        runner_name:
          type: string
          example: my runner
          description: The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)
        runner_group_id:
          type: integer
          example: 2
          description: The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)
        runner_group_name:
          type: string
          example: my runner group
          description: The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)
        workflow_name:
          type: string
          description: The name of the workflow.
          example: Build
        head_branch:
          type: string
          description: The name of the current branch.
          example: main
      required:
      - id
      - node_id
      - run_id
      - run_url
      - head_sha
      - workflow_name
      - head_branch
      - name
      - url
      - html_url
      - status
      - conclusion
      - started_at
      - completed_at
      - check_run_url
      - labels
      - runner_id
      - runner_name
      - runner_group_id
      - runner_group_name
      - created_at
    empty-object:
      title: Empty Object
      description: An object without any properties.
      type: object
      additionalProperties: false
  responses:
    not_found:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/basic-error'
    forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/basic-error'
  examples:
    job-paginated:
      value:
        total_count: 1
        jobs:
        - id: 399444496
          run_id: 29679449
          run_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449
          node_id: MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==
          head_sha: f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0
          url: https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496
          html_url: https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496
          status: completed
          conclusion: success
          started_at: '2020-01-20T17:42:40Z'
          completed_at: '2020-01-20T17:44:39Z'
          created_at: '2020-01-20T17:44:39Z'
          name: build
          steps:
          - name: Set up job
            status: completed
            conclusion: success
            number: 1
            started_at: '2020-01-20T09:42:40.000-08:00'
            completed_at: '2020-01-20T09:42:41.000-08:00'
          - name: Run actions/checkout@v2
            status: completed
            conclusion: success
            number: 2
            started_at: '2020-01-20T09:42:41.000-08:00'
            completed_at: '2020-01-20T09:42:45.000-08:00'
          - name: Set up Ruby
            status: completed
            conclusion: success
            number: 3
            started_at: '2020-01-20T09:42:45.000-08:00'
            completed_at: '2020-01-20T09:42:45.000-08:00'
          - name: Run actions/cache@v3
            status: completed
            conclusion: success
            number: 4
            started_at: '2020-01-20T09:42:45.000-08:00'
            completed_at: '2020-01-20T09:42:48.000-08:00'
          - name: Install Bundler
            status: completed
            conclusion: success
            number: 5
            started_at: '2020-01-20T09:42:48.000-08:00'
            completed_at: '2020-01-20T09:42:52.000-08:00'
          - name: Install Gems
            status: completed
            conclusion: success
            number: 6
            started_at: '2020-01-20T09:42:52.000-08:00'
            completed_at: '2020-01-20T09:42:53.000-08:00'
          - name: Run Tests
            status: completed
            conclusion: success
            number: 7
            started_at: '2020-01-20T09:42:53.000-08:00'
            completed_at: '2020-01-20T09:42:59.000-08:00'
          - name: Deploy to Heroku
            status: completed
            conclusion: success
            number: 8
            started_at: '2020-01-20T09:42:59.000-08:00'
            completed_at: '2020-01-20T09:44:39.000-08:00'
          - name: Post actions/cache@v3
            status: completed
            conclusion: success
            number: 16
            started_at: '2020-01-20T09:44:39.000-08:00'
            completed_at: '2020-01-20T09:44:39.000-08:00'
          - name: Complete job
            status: completed
            conclusion: success
            number: 17
            started_at: '2020-01-20T09:44:39.000-08:00'
            completed_at: '2020-01-20T09:44:39.000-08:00'
          check_run_url: https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496
          labels:
          - self-hosted
          - foo
          - bar
          runner_id: 1
          runner_name: my runner
          runner_group_id: 2
          runner_group_name: my runner group
          workflow_name: CI
          head_branch: main
    job:
      value:
        id: 399444496
        run_id: 29679449
        run_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449
        node_id: MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==
        head_sha: f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0
        url: https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496
        html_url: https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496
        status: completed
        conclusion: success
        started_at: '2020-01-20T17:42:40Z'
        completed_at: '2020-01-20T17:44:39Z'
        created_at: '2020-01-20T17:44:39Z'
        name: build
        steps:
        - name: Set up job
          status: completed
          conclusion: success
          number: 1
          started_at: '2020-01-20T09:42:40.000-08:00'
          completed_at: '2020-01-20T09:42:41.000-08:00'
        - name: Run actions/checkout@v2
          status: completed
          conclusion: success
          number: 2
          started_at: '2020-01-20T09:42:41.000-08:00'
          completed_at: '2020-01-20T09:42:45.000-08:00'
        - name: Set up Ruby
          status: completed
          conclusion: success
          number: 3
          started_at: '2020-01-20T09:42:45.000-08:00'
          completed_at: '2020-01-20T09:42:45.000-08:00'
        - name: Run actions/cache@v3
          status: completed
          conclusion: success
          number: 4
          started_at: '2020-01-20T09:42:45.000-08:00'
          completed_at: '2020-01-20T09:42:48.000-08:00'
        - name: Install Bundler
          status: completed
          conclusion: success
          number: 5
          started_at: '2020-01-20T09:42:48.000-08:00'
          completed_at: '2020-01-20T09:42:52.000-08:00'
        - name: Install Gems
          status: completed
          conclusion: success
          number: 6
          started_at: '2020-01-20T09:42:52.000-08:00'
          completed_at: '2020-01-20T09:42:53.000-08:00'
        - name: Run Tests
          status: completed
          conclusion: success
          number: 7
          started_at: '2020-01-20T09:42:53.000-08:00'
          completed_at: '2020-01-20T09:42:59.000-08:00'
        - name: Deploy to Heroku
          status: completed
          conclusion: success
          number: 8
          started_at: '2020-01-20T09:42:59.000-08:00'
          completed_at: '2020-01-20T09:44:39.000-08:00'
        - name: Post actions/cache@v3
          status: completed
          conclusion: success
          number: 16
          started_at: '2020-01-20T09:44:39.000-08:00'
          completed_at: '2020-01-20T09:44:39.000-08:00'
        - name: Complete job
          status: completed
          conclusion: success
          number: 17
          started_at: '2020-01-20T09:44:39.000-08:00'
          completed_at: '2020-01-20T09:44:39.000-08:00'
        check_run_url: https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496
        labels:
        - self-hosted
        - foo
        - bar
        runner_id: 1
        runner_name: my runner
        runner_group_id: 2
        runner_group_name: my runner group
        workflow_name: CI
        head_branch: main
  headers:
    link:
      example: <https://api.github.com/resource?page=2>; rel="next", <https://api.github.com/resource?page=5>; rel="last"
      schema:
        type: string
  securitySchemes:
    bearerHttpAuthentication:
      description: Bearer Token
      type: http
      scheme: Bearer
externalDocs:
  description: GitHub Enterprise Developer Docs
  url: https://docs.github.com/enterprise-server@3.9/rest/
x-webhooks:
  branch-protection-rule-created:
    post:
      summary: 'This event occurs when there is activity relating to branch protection rules. For more information, see "[About protected branches](https://docs.github.com/enterprise-server@3.9/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#branchprotectionrule) or "[Branch protection](https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection)" in the REST API documentation.


        To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission.'
      description: A branch protection rule was created.
      operationId: branch-protection-rule/created
      externalDocs:
        url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#branch_protection_rule
      parameters:
      - name: User-Agent
        in: header
        example: GitHub-Hookshot/123abc
        schema:
          type: string
      - name: X-Github-Hook-Id
        in: header
        example: 12312312
        schema:
          type: string
      - name: X-Github-Event
        in: header
        example: issues
        schema:
          type: string
      - name: X-Github-Hook-Installation-Target-Id
        in: header
        example: 123123
        schema:
          type: string
      - name: X-Github-Hook-Installation-Target-Type
        in: header
        example: repository
        schema:
          type: string
      - name: X-GitHub-Delivery
        in: header
        example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
        schema:
          type: string
      - name: X-Hub-Signature-256
        in: header
        example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
        schema:
          type: string
      - name: X-GitHub-Enterprise-Version
        in: header
        example: 3.1.9
        schema:
          type: string
      - name: X-GitHub-Enterprise-Host
        in: header
        example: ghes.github.com
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/webhook-branch-protection-rule-created'
      responses:
        '200':
          description: Return a 200 status to indicate that the data was received successfully
      x-github:
        githubCloudOnly: false
        category: webhooks
        subcategory: branch_protection_rule
        supported-webhook-types:
        - repository
        - organization
        - app
  branch-protection-rule-deleted:
    post:
      summary: 'This event occurs when there is activity relating to branch protection rules. For more information, see "[About protected branches](https://docs.github.com/ente

# --- truncated at 32 KB (630 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/github/refs/heads/main/openapi/github-jobs-api-openapi.yml