Skip to content

Commit 2956adf

Browse files
authored
BYOK key is disabled, not deleted (#17512)
1 parent 3b30531 commit 2956adf

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

content/admin/configuration/configuring-data-encryption-for-your-enterprise.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ For encryption in transit, {% data variables.product.product_name %} uses Transp
2020

2121
The key that you provide is stored in a hardware security module (HSM) in a key vault that {% data variables.product.company_short %} manages.
2222

23-
To configure your encryption key, use the REST API. There are a number of API endpoints, for example to check the status of encryption, update your encryption key, and delete your encryption key. Note that deleting your key will freeze your enterprise. For more information about the API endpoints, see "[Encryption at rest](/rest/reference/enterprise-admin#encryption-at-rest)" in the REST API documentation.
23+
To configure your encryption key, use the REST API. There are a number of API endpoints, for example to check the status of encryption, update your encryption key, and disable your encryption key. Note that disabling your key will freeze your enterprise. For more information about the API endpoints, see "[Encryption at rest](/rest/reference/enterprise-admin#encryption-at-rest)" in the REST API documentation.
2424

2525
### Adding or updating an encryption key
2626

@@ -48,24 +48,24 @@ Your 2048 bit RSA private key should be in PEM format, for example in a file cal
4848
curl -X GET http(s)://<em>hostname</em>/api/v3/enterprise/encryption/status/<em>request_id</em>
4949
```
5050

51-
### Deleting your encryption key
51+
### Disabling your encryption key
5252

53-
To freeze your enterprise, for example in the case of a breach, you can disable encryption at rest by deleting your encryption key.
53+
To freeze your enterprise, for example in the case of a breach, you can disable encryption at rest by marking your encryption key as disabled.
5454

55-
To unfreeze your enterprise after you've deleted your encryption key, contact support. For more information, see "[About {% data variables.contact.enterprise_support %}](/admin/enterprise-support/about-github-enterprise-support)."
56-
57-
1. To delete your key and disable encryption at rest, use the `DELETE /enterprise/encryption` endpoint.
55+
1. To disable your key and encryption at rest, use the `DELETE /enterprise/encryption` endpoint. This operation does not delete the key permanently.
5856

5957
```shell
6058
curl -X DELETE http(s)://<em>hostname</em>/api/v3/enterprise/encryption
6159
```
6260

63-
2. Optionally, check the status of the delete operation.
61+
2. Optionally, check the status of the delete operation. It takes approximately ten minutes to disable encryption at rest.
6462

6563
```shell
6664
curl -X GET http(s)://<em>hostname</em>/api/v3/enterprise/encryption/status/<em>request_id</em>
6765
```
6866

67+
To unfreeze your enterprise after you've disabled your encryption key, contact support. For more information, see "[About {% data variables.contact.enterprise_support %}](/admin/enterprise-support/about-github-enterprise-support)."
68+
6969
### Further reading
7070

7171
- "[Encryption at rest](/rest/reference/enterprise-admin#encryption-at-rest)" in the REST API documentation

0 commit comments

Comments
 (0)