Sign in

v56

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-08-011,21696712.2 MB
repos

List custom deployment rule integrations available for an environment

Gets all custom deployment protection rule integrations that are available for an environment.

The authenticated user must have admin or owner permissions to the repository to use this endpoint.

For more information about environments, see "Using environments for deployment."

For more information about the app that is providing this custom deployment rule, see "GET an app".

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

get/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps

Path parameters

environment_namestring required

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

repostring required

The name of the repository without the .git extension. The name is not case sensitive.

ownerstring required

The account owner of the repository. The name is not case sensitive.

Query parameters

pageinteger

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

per_pageinteger

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

Response

A list of custom deployment rule integrations available for this environment.

total_countinteger

The total number of custom deployment protection rule integrations available for this environment.

Example response

{
  "total_count": 35,
  "available_custom_deployment_protection_rule_integrations": [
    {
      "id": 3515,
      "slug": "my-custom-app",
      "integration_url": "https://api.github.com/apps/custom-app-slug",
      "node_id": "MDQ6R2F0ZTM1MTU="
    }
  ]
}