Skip to content

Commit a2cd64c

Browse files
authored
Remove "Encryption at rest" REST API docs for GHAE (#19038)
1 parent 310c43c commit a2cd64c

3 files changed

Lines changed: 2 additions & 68 deletions

File tree

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

Lines changed: 1 addition & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -16,56 +16,4 @@ versions:
1616

1717
To provide a high level of security, {% data variables.product.product_name %} encrypts your data while at rest in the data centers and while your data is in transit between users' machines and the data centers.
1818

19-
For encryption in transit, {% data variables.product.product_name %} uses Transport Layer Security (TLS). For encryption at rest, {% data variables.product.product_name %} provides a default RSA key. After you've initialized your enterprise, you can choose to provide your own key instead. Your key should be a 2048 bit RSA private key in PEM format.
20-
21-
The key that you provide is stored in a FIPS 140-2 compliant hardware security module (HSM) in a key vault that {% data variables.product.company_short %} manages.
22-
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.
24-
25-
### Adding or updating an encryption key
26-
27-
You can add a new encryption key as often as you need. When you add a new key, the old key is discarded. Your enterprise won't experience downtime when you update the key.
28-
29-
Your 2048 bit RSA private key should be in PEM format, for example in a file called _private-key.pem_.
30-
31-
```
32-
-----BEGIN RSA PRIVATE KEY-----
33-
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
34-
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
35-
-----END RSA PRIVATE KEY-----
36-
```
37-
38-
1. To add your key, use the `PATCH /enterprise/encryption` endpoint, replacing *~/private-key.pem* with the path to your private key.
39-
40-
```shell
41-
curl -X PATCH http(s)://<em>hostname</em>/api/v3/enterprise/encryption \
42-
-d "{ \"key\": \"$(awk '{printf "%s\\n", $0}' ~/private-key.pem)\" }"
43-
```
44-
45-
2. Optionally, check the status of the update operation.
46-
47-
```shell
48-
curl -X GET http(s)://<em>hostname</em>/api/v3/enterprise/encryption/status/<em>request_id</em>
49-
```
50-
51-
### Disabling your encryption key
52-
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.
54-
55-
1. To disable your key and encryption at rest, use the `DELETE /enterprise/encryption` endpoint. This operation does not delete the key permanently.
56-
57-
```shell
58-
curl -X DELETE http(s)://<em>hostname</em>/api/v3/enterprise/encryption
59-
```
60-
61-
2. Optionally, check the status of the delete operation. It takes approximately ten minutes to disable encryption at rest.
62-
63-
```shell
64-
curl -X GET http(s)://<em>hostname</em>/api/v3/enterprise/encryption/status/<em>request_id</em>
65-
```
66-
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-
69-
### Further reading
70-
71-
- "[Encryption at rest](/rest/reference/enterprise-admin#encryption-at-rest)" in the REST API documentation
19+
For encryption in transit, {% data variables.product.product_name %} uses Transport Layer Security (TLS). For encryption at rest, {% data variables.product.product_name %} provides a default RSA key.

content/admin/overview/about-github-ae.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ All of your data is stored within the geographic region of your choosing. You ca
2121

2222
### Encryption on your terms
2323

24-
All customer data is encrypted at rest, and you can provide your own encryption key to encrypt your data under your encryption policies. You control your key and access to all of your data. For more information, see "[Configuring data encryption for your enterprise](/admin/configuration/configuring-data-encryption-for-your-enterprise)."
24+
All customer data is encrypted at rest. For more information, see "[Configuring data encryption for your enterprise](/admin/configuration/configuring-data-encryption-for-your-enterprise)."
2525

2626
### Isolated accounts
2727

content/rest/reference/enterprise-admin.md

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -154,20 +154,6 @@ Name | Type | Description
154154
{% endfor %}
155155

156156
{% endif %}
157-
158-
{% if currentVersion == "github-ae@latest" %}
159-
160-
## Encryption at rest
161-
162-
You can use the encryption at rest API to manage the key that encrypts your data on {% data variables.product.product_name %}.
163-
For more information, see "[Configuring data encryption for your enterprise](/admin/configuration/configuring-data-encryption-for-your-enterprise)."
164-
165-
{% for operation in currentRestOperations %}
166-
{% if operation.subcategory == 'encryption-at-rest' %}{% include rest_operation %}{% endif %}
167-
{% endfor %}
168-
169-
{% endif %}
170-
171157
{% if currentVersion == "github-ae@latest" or enterpriseServerVersions contains currentVersion %}
172158
## Admin stats
173159

0 commit comments

Comments
 (0)