Back to GithubList custom deployment rule integrations available for an environment
Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the repo
scope. GitHub Apps and fine-grained personal access tokens must have the actions:read
permission 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".
Input
type: object
properties:
parameters:
type: object
properties:
environment_name:
type: string
description: The name of the environment.
repo:
type: string
description: The name of the repository. The name is not case sensitive.
owner:
type: string
description: The account owner of the repository. The name is not case sensitive.
page:
type: integer
default: 1
description: Page number of the results to fetch.
per_page:
type: integer
default: 30
description: The number of results per page (max 100).
required:
- environment_name
- repo
- owner
title: Parameters
Output
type: object
properties:
total_count:
description: >-
The total number of custom deployment protection rule integrations
available for this environment.
type: integer
example: 35
available_custom_deployment_protection_rule_integrations:
type: array
items:
type: object
title: Custom deployment protection rule app
properties:
id:
type: integer
example: 3515
description: The unique identifier of the deployment protection rule integration.
slug:
type: string
example: my-custom-app
description: The slugified name of the deployment protection rule integration.
integration_url:
type: string
example: https://api.github.com/apps/custom-app-slug
description: The URL for the endpoint to get details about the app.
node_id:
type: string
example: MDQ6R2F0ZTM1MTU=
description: The node ID for the deployment protection rule integration.