We've recently moved some of the REST API documentation. If you can't find what you're looking for, you might try the new Branches, Collaborators, Commits, Deploy Keys, Deployments, GitHub Pages, Releases, Metrics, Webhooks REST API pages.
Directivas de rama de implementación
Usa la API REST para administrar directivas de rama de implementación personalizadas.
Acerca de las directivas de rama de implementación
Puedes usar la API REST para especificar patrones de nombre personalizados que las ramas deben cumplir con el fin de implementarse en un entorno. La propiedad deployment_branch_policy.custom_branch_policies
del entorno debe establecerse en true
para usar estos puntos de conexión. Para actualizar la deployment_branch_policy
para un entorno, consulte "Crear o actualizar un entorno".
Para obtener más información sobre cómo restringir las implementaciones de entorno a determinadas ramas, consulte "Uso de entornos para la implementación".
List deployment branch policies
Lists the deployment branch policies for an environment.
Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the repo
scope. GitHub Apps must have the actions:read
permission to use this endpoint.
Parameters
Headers |
---|
Nombre, Type, Descripción |
accept stringSetting to |
Path parameters |
Nombre, Type, Descripción |
owner stringRequiredThe account owner of the repository. The name is not case sensitive. |
repo stringRequiredThe name of the repository. The name is not case sensitive. |
environment_name stringRequiredThe name of the environment. |
Query parameters |
Nombre, Type, Descripción |
per_page integerThe number of results per page (max 100). Default: |
page integerPage number of the results to fetch. Default: |
HTTP response status codes
Status code | Descripción |
---|---|
200 | OK |
Code samples
curl \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/environments/ENVIRONMENT_NAME/deployment-branch-policies
Response
Status: 200
{
"total_count": 2,
"branch_policies": [
{
"id": 361471,
"node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE=",
"name": "release/*"
},
{
"id": 361472,
"node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzI=",
"name": "main"
}
]
}
Create a deployment branch policy
Creates a deployment branch policy for an environment.
You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the administration:write
permission for the repository to use this endpoint.
Parameters
Headers |
---|
Nombre, Type, Descripción |
accept stringSetting to |
Path parameters |
Nombre, Type, Descripción |
owner stringRequiredThe account owner of the repository. The name is not case sensitive. |
repo stringRequiredThe name of the repository. The name is not case sensitive. |
environment_name stringRequiredThe name of the environment. |
Body parameters |
Nombre, Type, Descripción |
name stringRequiredThe name pattern that branches must match in order to deploy to the environment. Wildcard characters will not match |
HTTP response status codes
Status code | Descripción |
---|---|
200 | OK |
303 | Response if the same branch name pattern already exists |
404 | Not Found or |
Code samples
curl \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/environments/ENVIRONMENT_NAME/deployment-branch-policies \
-d '{"name":"release/*"}'
Response
Status: 200
{
"id": 364662,
"node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=",
"name": "release/*"
}
Get a deployment branch policy
Gets a deployment branch policy for an environment.
Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the repo
scope. GitHub Apps must have the actions:read
permission to use this endpoint.
Parameters
Headers |
---|
Nombre, Type, Descripción |
accept stringSetting to |
Path parameters |
Nombre, Type, Descripción |
owner stringRequiredThe account owner of the repository. The name is not case sensitive. |
repo stringRequiredThe name of the repository. The name is not case sensitive. |
environment_name stringRequiredThe name of the environment. |
branch_policy_id integerRequiredThe unique identifier of the branch policy. |
HTTP response status codes
Status code | Descripción |
---|---|
200 | OK |
Code samples
curl \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/environments/ENVIRONMENT_NAME/deployment-branch-policies/BRANCH_POLICY_ID
Response
Status: 200
{
"id": 364662,
"node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=",
"name": "release/*"
}
Update a deployment branch policy
Updates a deployment branch policy for an environment.
You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the administration:write
permission for the repository to use this endpoint.
Parameters
Headers |
---|
Nombre, Type, Descripción |
accept stringSetting to |
Path parameters |
Nombre, Type, Descripción |
owner stringRequiredThe account owner of the repository. The name is not case sensitive. |
repo stringRequiredThe name of the repository. The name is not case sensitive. |
environment_name stringRequiredThe name of the environment. |
branch_policy_id integerRequiredThe unique identifier of the branch policy. |
Body parameters |
Nombre, Type, Descripción |
name stringRequiredThe name pattern that branches must match in order to deploy to the environment. Wildcard characters will not match |
HTTP response status codes
Status code | Descripción |
---|---|
200 | OK |
Code samples
curl \
-X PUT \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/environments/ENVIRONMENT_NAME/deployment-branch-policies/BRANCH_POLICY_ID \
-d '{"name":"release/*"}'
Response
Status: 200
{
"id": 364662,
"node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=",
"name": "release/*"
}
Delete a deployment branch policy
Deletes a deployment branch policy for an environment.
You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the administration:write
permission for the repository to use this endpoint.
Parameters
Headers |
---|
Nombre, Type, Descripción |
accept stringSetting to |
Path parameters |
Nombre, Type, Descripción |
owner stringRequiredThe account owner of the repository. The name is not case sensitive. |
repo stringRequiredThe name of the repository. The name is not case sensitive. |
environment_name stringRequiredThe name of the environment. |
branch_policy_id integerRequiredThe unique identifier of the branch policy. |
HTTP response status codes
Status code | Descripción |
---|---|
204 | No Content |
Code samples
curl \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/environments/ENVIRONMENT_NAME/deployment-branch-policies/BRANCH_POLICY_ID
Response
Status: 204