REST-API-Endpunkte für Schutzregeln

Get all deployment protection rules for an environment

Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can 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 the documentation for the GET /apps/{app_slug} endpoint.

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

Differenzierte Zugriffstoken für "Get all deployment protection rules for an environment"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Actions" repository permissions (read)

Dieser Endpunkt kann ohne Authentifizierung oder die zuvor erwähnten Berechtigungen verwendet werden, wenn nur öffentliche Ressourcen angefordert werden.

Parameter für „Get all deployment protection rules for an environment“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`environment_name` string Erforderlich The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.
`repo` string Erforderlich The name of the repository without the `.git` extension. The name is not case sensitive.
`owner` string Erforderlich The account owner of the repository. The name is not case sensitive.

HTTP-Antwortstatuscodes für „Get all deployment protection rules for an environment“

Statuscode	BESCHREIBUNG
`200`	List of deployment protection rules

Codebeispiele für „Get all deployment protection rules for an environment“

Anforderungsbeispiel

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

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/environments/ENVIRONMENT_NAME/deployment_protection_rules

List of deployment protection rules

Status: 200

{
  "total_count": 2,
  "custom_deployment_protection_rules": [
    {
      "id": 3,
      "node_id": "IEH37kRlcGxveW1lbnRTdGF0ddiv",
      "enabled": true,
      "app": {
        "id": 1,
        "node_id": "GHT58kRlcGxveW1lbnRTdTY!bbcy",
        "slug": "a-custom-app",
        "integration_url": "https://HOSTNAME/apps/a-custom-app"
      }
    },
    {
      "id": 4,
      "node_id": "MDE2OkRlcGxveW1lbnRTdHJ41128",
      "enabled": true,
      "app": {
        "id": 1,
        "node_id": "UHVE67RlcGxveW1lbnRTdTY!jfeuy",
        "slug": "another-custom-app",
        "integration_url": "https://HOSTNAME/apps/another-custom-app"
      }
    }
  ]
}

Create a custom deployment protection rule on an environment

Enable a custom deployment protection rule for an environment.

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

For more information about the app that is providing this custom deployment rule, see the documentation for the GET /apps/{app_slug} endpoint.

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

Differenzierte Zugriffstoken für "Create a custom deployment protection rule on an environment"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Administration" repository permissions (write)

Parameter für „Create a custom deployment protection rule on an environment“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`environment_name` string Erforderlich The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.
`repo` string Erforderlich The name of the repository without the `.git` extension. The name is not case sensitive.
`owner` string Erforderlich The account owner of the repository. The name is not case sensitive.

Textparameter
Name, type, BESCHREIBUNG
`integration_id` integer The ID of the custom app that will be enabled on the environment.

HTTP-Antwortstatuscodes für „Create a custom deployment protection rule on an environment“

Statuscode	BESCHREIBUNG
`201`	The enabled custom deployment protection rule

Codebeispiele für „Create a custom deployment protection rule on an environment“

Anforderungsbeispiel

post/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/environments/ENVIRONMENT_NAME/deployment_protection_rules \
  -d '{"integration_id":5}'

The enabled custom deployment protection rule

Status: 201

{
  "id": 3,
  "node_id": "IEH37kRlcGxveW1lbnRTdGF0ddiv",
  "enabled": true,
  "app": {
    "id": 1,
    "node_id": "GHT58kRlcGxveW1lbnRTdTY!bbcy",
    "slug": "a-custom-app",
    "integration_url": "https://HOSTNAME/apps/a-custom-app"
  }
}

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.

Differenzierte Zugriffstoken für "List custom deployment rule integrations available for an environment"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Administration" repository permissions (read)

Parameter für „List custom deployment rule integrations available for an environment“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`environment_name` string Erforderlich The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.
`repo` string Erforderlich The name of the repository without the `.git` extension. The name is not case sensitive.
`owner` string Erforderlich The account owner of the repository. The name is not case sensitive.

Abfrageparameter
Name, type, BESCHREIBUNG
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Standard: `1`
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Standard: `30`

HTTP-Antwortstatuscodes für „List custom deployment rule integrations available for an environment“

Statuscode	BESCHREIBUNG
`200`	A list of custom deployment rule integrations available for this environment.

Codebeispiele für „List custom deployment rule integrations available for an environment“

Anforderungsbeispiel

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

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/environments/ENVIRONMENT_NAME/deployment_protection_rules/apps

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

Status: 200

[
  {
    "total_count": 2
  },
  {
    "available_custom_deployment_protection_rule_integrations": [
      {
        "id": 1,
        "node_id": "GHT58kRlcGxveW1lbnRTdTY!bbcy",
        "slug": "a-custom-app",
        "integration_url": "https://HOSTNAME/apps/a-custom-app"
      },
      {
        "id": 2,
        "node_id": "UHVE67RlcGxveW1lbnRTdTY!jfeuy",
        "slug": "another-custom-app",
        "integration_url": "https://HOSTNAME/apps/another-custom-app"
      }
    ]
  }
]

Get a custom deployment protection rule

Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can 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 /apps/{app_slug}.

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

Differenzierte Zugriffstoken für "Get a custom deployment protection rule"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Actions" repository permissions (read)

Dieser Endpunkt kann ohne Authentifizierung oder die zuvor erwähnten Berechtigungen verwendet werden, wenn nur öffentliche Ressourcen angefordert werden.

Parameter für „Get a custom deployment protection rule“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`owner` string Erforderlich The account owner of the repository. The name is not case sensitive.
`repo` string Erforderlich The name of the repository without the `.git` extension. The name is not case sensitive.
`environment_name` string Erforderlich The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.
`protection_rule_id` integer Erforderlich The unique identifier of the protection rule.

HTTP-Antwortstatuscodes für „Get a custom deployment protection rule“

Statuscode	BESCHREIBUNG
`200`	OK

Codebeispiele für „Get a custom deployment protection rule“

Anforderungsbeispiel

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

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/environments/ENVIRONMENT_NAME/deployment_protection_rules/PROTECTION_RULE_ID

Response

Status: 200

{
  "id": 3,
  "node_id": "IEH37kRlcGxveW1lbnRTdGF0ddiv",
  "enabled": true,
  "app": {
    "id": 1,
    "node_id": "GHT58kRlcGxveW1lbnRTdTY!bbcy",
    "slug": "a-custom-app",
    "integration_url": "https://HOSTNAME/apps/a-custom-app"
  }
}

Disable a custom protection rule for an environment

Disables a custom deployment protection rule for an environment.

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

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

Differenzierte Zugriffstoken für "Disable a custom protection rule for an environment"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Administration" repository permissions (write)

Parameter für „Disable a custom protection rule for an environment“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`environment_name` string Erforderlich The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.
`repo` string Erforderlich The name of the repository without the `.git` extension. The name is not case sensitive.
`owner` string Erforderlich The account owner of the repository. The name is not case sensitive.
`protection_rule_id` integer Erforderlich The unique identifier of the protection rule.

HTTP-Antwortstatuscodes für „Disable a custom protection rule for an environment“

Statuscode	BESCHREIBUNG
`204`	No Content

Codebeispiele für „Disable a custom protection rule for an environment“

Anforderungsbeispiel

delete/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/environments/ENVIRONMENT_NAME/deployment_protection_rules/PROTECTION_RULE_ID

Response

Status: 204