Skip to content

Commit 8769735

Browse files
committed
Fix backup and restore API docs bugs
1 parent a67ff63 commit 8769735

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

src/current/_includes/cockroachcloud/backups/cloud-api-backup-settings.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
### Get information on backup settings
22

3-
To retrieve information about a specific cluster, make a `GET` request to the `/v1/clusters/{cluster_id}/backups/config` endpoint.
3+
To retrieve information about a specific cluster, make a `GET` request to the `/v1/clusters/{cluster_id}/backups-config` endpoint.
44

55
{% include_cached copy-clipboard.html %}
66
~~~ shell
77
curl --request GET \
8-
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/backups/config \
8+
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/backups-config \
99
--header 'Authorization: Bearer {secret_key}'
1010
~~~
1111

1212
Set the following:
1313

14-
- `{cluster_id}` is the unique ID of the cluster. Use this ID when making API requests. You can find the cluster ID in the cluster's Cloud Console page. Find your cluster ID in the URL of the single cluster overview page: `https://cockroachlabs.cloud/cluster/{your_cluster_id}/overview`. The ID should resemble `f78b7feb-b6cf-4396-9d7f-494982d7d81e`.
14+
- `{cluster_id}` is the unique ID of the cluster. This ID is written in a UUID format similar to `f78b7feb-b6cf-4396-9d7f-494982d7d81e` and is returned by a [GET request against the `/v1/clusters` endpoint]({% link cockroachcloud/cloud-api.md %}#list-all-clusters-in-an-organization). You can also find the cluster ID in the Cloud Console, in the URL of the single cluster overview page: `https://cockroachlabs.cloud/cluster/{your_cluster_id}/overview`.
1515
- `{secret_key}` is your API key. Refer to [API Access]({% link cockroachcloud/managing-access.md %}#api-access) for more details.
1616

1717
If the request is successful, the API will return details about the managed backup settings:
@@ -36,19 +36,19 @@ If the request is successful, the API will return details about the managed back
3636

3737
{% include cockroachcloud/backups/review-settings.md %}
3838

39-
To configure the frequency and retention of managed backups, send a `PUT` request to the `/v1/clusters/{cluster_id}/backups/config` endpoint.
39+
To configure the frequency and retention of managed backups, send a `PUT` request to the `/v1/clusters/{cluster_id}/backups-config` endpoint.
4040

4141
{% include_cached copy-clipboard.html %}
4242
~~~ shell
4343
curl --request PUT \
44-
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/backups/config \
44+
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/backups-config \
4545
--header 'Authorization: Bearer {secret_key}' \
4646
--data '{"enabled": true, "frequency_minutes": 30, "retention_days": 2}'
4747
~~~
4848

4949
Set the following:
5050

51-
- `{cluster_id}` is the unique ID of the cluster. Use this ID when making API requests. You can find the cluster ID in the cluster's Cloud Console page. Find your cluster ID in the URL of the single cluster overview page: `https://cockroachlabs.cloud/cluster/{your_cluster_id}/overview`. The ID should resemble `f78b7feb-b6cf-4396-9d7f-494982d7d81e`.
51+
- `{cluster_id}` is the unique ID of the cluster. This ID is written in a UUID format similar to `f78b7feb-b6cf-4396-9d7f-494982d7d81e` and is returned by a [GET request against the `/v1/clusters` endpoint]({% link cockroachcloud/cloud-api.md %}#list-all-clusters-in-an-organization). You can also find the cluster ID in the Cloud Console, in the URL of the single cluster overview page: `https://cockroachlabs.cloud/cluster/{your_cluster_id}/overview`.
5252
- `{enabled}` controls whether managed backups are enabled or disabled. If you are disabling managed backups, you cannot set backup frequency or retention. Possible values are: `true`, `false`.
5353
- `{frequency_minutes}` determines [how often](#frequency) the managed backup will run in minutes. Possible values are: `5`, `10`, `15`, `30`, `60`, `240` (4 hours), `1440` (24 hours).
5454
- `{retention_days}` sets the number of days Cockroach Labs will [retain](#retention) the managed backup in storage. You can change `retention_days` for the cluster **once** (whether in the Cloud API or [Cloud Console](#cloud-console)). Possible values are: `2`, `7`, `30`, `90`, `365`.

src/current/_includes/cockroachcloud/backups/cloud-api-restore-endpoint.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ curl --request POST \
2626
--url 'https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/restores' \
2727
--header "Authorization: Bearer {secret_key}" \
2828
--json '{
29-
"source_cluster_id": "{cluster_id}"
29+
"source_cluster_id": "{cluster_id}",
3030
"type": "CLUSTER"
3131
}'
3232
~~~
@@ -86,7 +86,7 @@ curl --request POST \
8686
--url 'https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/restores' \
8787
--header "Authorization: Bearer {secret_key}" \
8888
--json '{
89-
"source_cluster_id": "{cluster_id}"
89+
"source_cluster_id": "{cluster_id}",
9090
"type": "DATABASE",
9191
"objects": [
9292
{
@@ -107,7 +107,7 @@ curl --request POST \
107107
--url 'https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/restores' \
108108
--header "Authorization: Bearer {secret_key}" \
109109
--json '{
110-
"source_cluster_id": "{cluster_id}"
110+
"source_cluster_id": "{cluster_id}",
111111
"type": "DATABASE",
112112
"objects": [
113113
{
@@ -181,7 +181,7 @@ curl --request POST \
181181
--url 'https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/restores' \
182182
--header "Authorization: Bearer {secret_key}" \
183183
--json '{
184-
"source_cluster_id": "{cluster_id}"
184+
"source_cluster_id": "{cluster_id}",
185185
"type": "TABLE",
186186
"objects": [
187187
{
@@ -206,7 +206,7 @@ curl --request POST \
206206
--url 'https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/restores' \
207207
--header "Authorization: Bearer {secret_key}" \
208208
--json '{
209-
"source_cluster_id": "{cluster_id}"
209+
"source_cluster_id": "{cluster_id}",
210210
"type": "TABLE",
211211
"objects": [
212212
{
@@ -294,7 +294,7 @@ To view the status of a restore job using the cloud API, send a `GET` request to
294294
~~~ shell
295295
curl --request GET \
296296
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/restores/{restore_id} \
297-
--header 'Authorization: Bearer {secret_key}' \
297+
--header 'Authorization: Bearer {secret_key}'
298298
~~~
299299

300300
If the request is successful, the client recieves a response containing JSON describing the status of the specified request operation:

0 commit comments

Comments
 (0)