deployment_rule_integrations
Creates, updates, deletes, gets or lists a deployment_rule_integrations resource.
Overview
| Name | deployment_rule_integrations |
| Type | Resource |
| Id | github.repos.deployment_rule_integrations |
Fields
The following fields are returned by SELECT queries:
- list_custom_deployment_rule_integrations
A list of custom deployment rule integrations available for this environment.
| Name | Datatype | Description |
|---|---|---|
available_custom_deployment_protection_rule_integrations | array | |
total_count | integer | The total number of custom deployment protection rule integrations available for this environment. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_custom_deployment_rule_integrations | select | environment_name, repo, owner | page, per_page | 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. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
environment_name | string | The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F. |
owner | string | The account owner of the repository. The name is not case sensitive. |
repo | string | The name of the repository without the .git extension. The name is not case sensitive. |
page | integer | The page number of the results to fetch. For more information, see "Using pagination in the REST API." |
per_page | integer | The number of results per page (max 100). For more information, see "Using pagination in the REST API." |
SELECT examples
- list_custom_deployment_rule_integrations
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.
SELECT
available_custom_deployment_protection_rule_integrations,
total_count
FROM github.repos.deployment_rule_integrations
WHERE environment_name = '{{ environment_name }}' -- required
AND repo = '{{ repo }}' -- required
AND owner = '{{ owner }}' -- required
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
;