GitHub Deployments API

The GitHub Deployments API lets you create and manage deployments and deployment statuses for repositories. Deployments are requests to deploy a specific ref (branch, SHA, tag) to an environment, and deployment statuses track the progress of that deployment. The API also supports managing deployment environments, environment protection rules, and deployment branch policies.

Documentation

API entry from apis.yml

apis.yml Raw ↑
aid: github:github-deployments-api
name: GitHub Deployments API
tags:
- Deployments
- Releases
baseURL: https://api.github.com
humanURL: https://docs.github.com/en/rest/deployments?apiVersion=2022-11-28
properties:
- url: https://docs.github.com/en/rest/deployments
  type: Documentation
description: The GitHub Deployments API lets you create and manage deployments and deployment statuses
  for repositories. Deployments are requests to deploy a specific ref (branch, SHA, tag) to an environment,
  and deployment statuses track the progress of that deployment. The API also supports managing deployment
  environments, environment protection rules, and deployment branch policies.