Skip to content

Commit 08d2c1d

Browse files
committed
Revert to single quotes around JSON blocks
1 parent 1f87b54 commit 08d2c1d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+97
-97
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ To configure the frequency and retention of managed backups, send a `PUT` reques
4343
curl --request PUT \
4444
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/backups-config \
4545
--header "Authorization: Bearer {secret_key}" \
46-
--data "{"enabled": true, "frequency_minutes": 30, "retention_days": 2}"
46+
--data '{"enabled": true, "frequency_minutes": 30, "retention_days": 2}'
4747
~~~
4848

4949
Set the following:

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

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,10 @@ To restore a cluster to a recent managed backup, send a `POST` request to the `/
2525
curl --request POST \
2626
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/restores \
2727
--header "Authorization: Bearer {secret_key}" \
28-
--json "{
28+
--json '{
2929
"source_cluster_id": "{cluster_id}",
3030
"type": "CLUSTER"
31-
}"
31+
}'
3232
~~~
3333

3434
By default, the restore job uses the most recent backup stored within the last 7 days on the cluster specified in `source_cluster_id`. To restore a specific backup, include the `backup_id` field and specify a backup ID from the [managed backups list](#view-managed-backups):
@@ -38,10 +38,10 @@ By default, the restore job uses the most recent backup stored within the last 7
3838
curl --request POST \
3939
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/restores \
4040
--header "Authorization: Bearer {secret_key}" \
41-
--json "{
41+
--json '{
4242
"backup_id": "example-2d25-4a64-8172-28af7a0d41cc",
4343
"type": "CLUSTER"
44-
}"
44+
}'
4545
~~~
4646

4747
{% if page.name == "managed-backups-advanced.md" %}
@@ -52,10 +52,10 @@ To restore a cluster backup into a different cluster, ensure that the destinatio
5252
curl --request POST \
5353
--url https://cockroachlabs.cloud/api/v1/clusters/{destination_cluster_id}/restores \
5454
--header "Authorization: Bearer {secret_key}" \
55-
--json "{
55+
--json '{
5656
"source_cluster_id": "{source_cluster_id}",
5757
"type": "CLUSTER"
58-
}"
58+
}'
5959
~~~
6060

6161
You can specify additional options for the restore job in the `restore_opts` object. For more information, see the [API endpoint documentation](https://www.cockroachlabs.com/docs/api/cloud/v1#get-/api/v1/clusters/-cluster_id-/restores-config).
@@ -85,7 +85,7 @@ To restore one or more databases from a cluster's managed backup, send a `POST`
8585
curl --request POST \
8686
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/restores \
8787
--header "Authorization: Bearer {secret_key}" \
88-
--json "{
88+
--json '{
8989
"source_cluster_id": "{cluster_id}",
9090
"type": "DATABASE",
9191
"objects": [
@@ -96,7 +96,7 @@ curl --request POST \
9696
"database": "movr"
9797
}
9898
]
99-
}"
99+
}'
100100
~~~
101101

102102
By default, the database is restored into the original database name from the managed backup. To restore the database contents into a new database, include the field `restore_opts.new_db_name` with the new database name. You can only restore one database at a time when using this option.
@@ -106,7 +106,7 @@ By default, the database is restored into the original database name from the ma
106106
curl --request POST \
107107
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/restores \
108108
--header "Authorization: Bearer {secret_key}" \
109-
--json "{
109+
--json '{
110110
"source_cluster_id": "{cluster_id}",
111111
"type": "DATABASE",
112112
"objects": [
@@ -117,7 +117,7 @@ curl --request POST \
117117
"restore_opts": {
118118
"new_db_name": "tpcc2"
119119
}
120-
}"
120+
}'
121121
~~~
122122

123123
To restore from a specific backup rather than the most recently created managed backup, include the `backup_id` field specifying a backup ID:
@@ -127,15 +127,15 @@ To restore from a specific backup rather than the most recently created managed
127127
curl --request POST \
128128
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/restores \
129129
--header "Authorization: Bearer {secret_key}" \
130-
--json "{
130+
--json '{
131131
"backup_id": "example-2d25-4a64-8172-28af7a0d41cc",
132132
"type": "DATABASE",
133133
"objects": [
134134
{
135135
"database": "tpcc"
136136
}
137137
]
138-
}"
138+
}'
139139
~~~
140140

141141
To restore a database from a source cluster's managed backup into a different cluster, send the restore request to the destination cluster ID. Specify the ID of the backup's cluster as `source_cluster_id`. Both the source cluster and the destination cluster must use the Advanced plan.
@@ -145,15 +145,15 @@ To restore a database from a source cluster's managed backup into a different cl
145145
curl --request POST \
146146
--url https://cockroachlabs.cloud/api/v1/clusters/{destination_cluster_id}/restores \
147147
--header "Authorization: Bearer {secret_key}" \
148-
--json "{
148+
--json '{
149149
"source_cluster_id": "{source_cluster_id}",
150150
"type": "DATABASE",
151151
"objects": [
152152
{
153153
"database": "tpcc"
154154
}
155155
]
156-
}"
156+
}'
157157
~~~
158158

159159
You can specify additional options for the restore jobs in the `restore_opts` object. For more information, see the [API endpoint documentation](https://www.cockroachlabs.com/docs/api/cloud/v1#get-/api/v1/clusters/-cluster_id-/restores-config).
@@ -180,7 +180,7 @@ To restore a one or more tables from a cluster's managed backup, send a `POST` r
180180
curl --request POST \
181181
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/restores \
182182
--header "Authorization: Bearer {secret_key}" \
183-
--json "{
183+
--json '{
184184
"source_cluster_id": "{cluster_id}",
185185
"type": "TABLE",
186186
"objects": [
@@ -195,7 +195,7 @@ curl --request POST \
195195
"table": "customer"
196196
}
197197
]
198-
}"
198+
}'
199199
~~~
200200

201201
By default, the table is restored into the original database name from the managed backup. To restore the table into a different database, include the field `restore_opts.into_db` with the desired database name. The following example restores the `tpcc.public.warehouse` table from the most recent managed backup into `tpcc2.public.warehouse` on the cluster:
@@ -205,7 +205,7 @@ By default, the table is restored into the original database name from the manag
205205
curl --request POST \
206206
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/restores \
207207
--header "Authorization: Bearer {secret_key}" \
208-
--json "{
208+
--json '{
209209
"source_cluster_id": "{cluster_id}",
210210
"type": "TABLE",
211211
"objects": [
@@ -223,7 +223,7 @@ curl --request POST \
223223
"restore_opts": {
224224
"into_db": "tpcc2"
225225
}
226-
}"
226+
}'
227227
~~~
228228

229229
To restore from a specific backup rather than the most recently created managed backup, include the `backup_id` field specifying a backup ID:
@@ -233,7 +233,7 @@ To restore from a specific backup rather than the most recently created managed
233233
curl --request POST \
234234
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/restores \
235235
--header "Authorization: Bearer {secret_key}" \
236-
--json "{
236+
--json '{
237237
"backup_id": "example-2d25-4a64-8172-28af7a0d41cc",
238238
"type": "TABLE",
239239
"objects": [
@@ -243,7 +243,7 @@ curl --request POST \
243243
"table": "warehouse"
244244
}
245245
]
246-
}"
246+
}'
247247
~~~
248248

249249
To restore a table from a source cluster's managed backup into a different cluster, send the restore request to the destination cluster ID. Specify the ID of the backup's cluster as `source_cluster_id`. Both the source cluster and the destination cluster must use the Advanced plan.
@@ -253,7 +253,7 @@ To restore a table from a source cluster's managed backup into a different clust
253253
curl --request POST \
254254
--url https://cockroachlabs.cloud/api/v1/clusters/{destination_cluster_id}/restores \
255255
--header "Authorization: Bearer {secret_key}" \
256-
--json "{
256+
--json '{
257257
"source_cluster_id": "{source_cluster_id}",
258258
"type": "TABLE",
259259
"objects": [
@@ -263,7 +263,7 @@ curl --request POST \
263263
"table": "warehouse"
264264
}
265265
]
266-
}"
266+
}'
267267
~~~
268268

269269
You can specify additional options for the restore jobs in the `restore_opts` object. For more information, see the [API endpoint documentation](https://www.cockroachlabs.com/docs/api/cloud/v1#get-/api/v1/clusters/-cluster_id-/restores-config).

src/current/cockroachcloud/aws-privatelink.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ curl --request POST \
8080
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/networking/private-endpoint-trusted-owners \
8181
--header "Authorization: Bearer {bearer_token}" \
8282
--header "content-type: application/json" \
83-
--data "{"external_owner_id":"{aws_account_id}","type":"AWS_ACCOUNT_ID"}"
83+
--data '{"external_owner_id":"{aws_account_id}","type":"AWS_ACCOUNT_ID"}'
8484
~~~
8585

8686
Replace:

src/current/cockroachcloud/cloud-api.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ The service account associated with the secret key must have the Cluster Admin o
108108
curl --request POST \
109109
--url https://cockroachlabs.cloud/api/v1/clusters \
110110
--header "Authorization: Bearer {secret_key}" \
111-
--json "{"name":"{cluster_name}","provider":"{cloud_provider}","plan":"BASIC","spec":{"serverless":{"regions":["{region_name}"]}}}"
111+
--json '{"name":"{cluster_name}","provider":"{cloud_provider}","plan":"BASIC","spec":{"serverless":{"regions":["{region_name}"]}}}'
112112
~~~
113113

114114
</section>
@@ -154,7 +154,7 @@ For example, to create a new Basic cluster named `basic-test` using GCP as the c
154154
curl --request POST \
155155
--url https://cockroachlabs.cloud/api/v1/clusters \
156156
--header "Authorization: Bearer {secret_key}" \
157-
--json "{"name":"basic-test","provider":"GCP","plan":"BASIC","spec":{"serverless":{"regions":["us-central1"]}}}"
157+
--json '{"name":"basic-test","provider":"GCP","plan":"BASIC","spec":{"serverless":{"regions":["us-central1"]}}}'
158158
~~~
159159

160160
</section>
@@ -203,7 +203,7 @@ The service account associated with the secret key must have the Cluster Admin o
203203
curl --request POST \
204204
--url https://cockroachlabs.cloud/api/v1/clusters \
205205
--header "Authorization: Bearer {secret_key}" \
206-
--json "{"name":"{cluster_name}","provider":"{cloud_provider}","plan":"STANDARD","spec":{"serverless":{"regions":["{region_name}"],"usage_limits":{"provisioned_virtual_cpus":"2"}}}}"
206+
--json '{"name":"{cluster_name}","provider":"{cloud_provider}","plan":"STANDARD","spec":{"serverless":{"regions":["{region_name}"],"usage_limits":{"provisioned_virtual_cpus":"2"}}}}'
207207
~~~
208208

209209
</section>
@@ -253,7 +253,7 @@ For example, to create a new Standard cluster named `notorious-moose` using the
253253
curl --request POST \
254254
--url https://cockroachlabs.cloud/api/v1/clusters \
255255
--header "Authorization: Bearer {secret_key}" \
256-
--json "{"name":"notorious-moose","provider":"GCP","plan":"STANDARD","spec":{"serverless":{"regions":["us-central1"],"usage_limits":{"provisioned_virtual_cpus":"2"}}}}"
256+
--json '{"name":"notorious-moose","provider":"GCP","plan":"STANDARD","spec":{"serverless":{"regions":["us-central1"],"usage_limits":{"provisioned_virtual_cpus":"2"}}}}'
257257
~~~
258258

259259
</section>
@@ -305,7 +305,7 @@ The service account associated with the secret key must have the Cluster Admin o
305305
curl --request POST \
306306
--url https://cockroachlabs.cloud/api/v1/clusters \
307307
--header "Authorization: Bearer {secret_key}" \
308-
--json "{"name":"{cluster_name}","provider":"{cloud_provider}","plan":"ADVANCED","spec":{"dedicated":{"region_nodes":{"{region_name}":3},"hardware":{"machine_spec":{"num_virtual_cpus":{num_vcpus}}},"cockroach_version":"{version}"}}}"
308+
--json '{"name":"{cluster_name}","provider":"{cloud_provider}","plan":"ADVANCED","spec":{"dedicated":{"region_nodes":{"{region_name}":3},"hardware":{"machine_spec":{"num_virtual_cpus":{num_vcpus}}},"cockroach_version":"{version}"}}}'
309309
~~~
310310

311311
</section>
@@ -360,7 +360,7 @@ For example, to create a new Advanced cluster named `advanced-test` using AWS as
360360
curl --request POST \
361361
--url https://cockroachlabs.cloud/api/v1/clusters \
362362
--header "Authorization: Bearer {secret_key}" \
363-
--json "{"name":"advanced-test","provider":"AWS","plan":"ADVANCED","spec":{"dedicated":{"region_nodes":{"us-east-1":3},"hardware":{"machine_spec":{"num_virtual_cpus":4}},"cockroach_version":"v23.1.2"}}}"
363+
--json '{"name":"advanced-test","provider":"AWS","plan":"ADVANCED","spec":{"dedicated":{"region_nodes":{"us-east-1":3},"hardware":{"machine_spec":{"num_virtual_cpus":4}},"cockroach_version":"v23.1.2"}}}'
364364
~~~
365365

366366
</section>
@@ -497,7 +497,7 @@ The service account associated with the secret key must have the Cluster Admin o
497497
curl --request PATCH \
498498
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id} \
499499
--header "Authorization: Bearer {secret_key}" \
500-
--json "{"serverless":{"usage_limits":{"storage_mib_limit":"5242880","request_unit_limit":"50000000"}}}"
500+
--json '{"serverless":{"usage_limits":{"storage_mib_limit":"5242880","request_unit_limit":"50000000"}}}'
501501
~~~
502502

503503
</section>
@@ -556,7 +556,7 @@ The service account associated with the secret key must have the Cluster Admin o
556556
curl --request PATCH \
557557
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id} \
558558
--header "Authorization: Bearer {secret_key}" \
559-
--json "{"serverless":{"usage_limits":{"provisioned_virtual_cpus":"{provisioned_virtual_cpus}"}}}"
559+
--json '{"serverless":{"usage_limits":{"provisioned_virtual_cpus":"{provisioned_virtual_cpus}"}}}'
560560
~~~
561561

562562
</section>
@@ -600,7 +600,7 @@ For example, to change the number of vCPUs per node to 8:
600600
curl --request PATCH \
601601
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id} \
602602
--header "Authorization: Bearer {secret_key}" \
603-
--json "{
603+
--json '{
604604
"spec": {
605605
"dedicated": {
606606
"hardware": {
@@ -610,7 +610,7 @@ curl --request PATCH \
610610
}
611611
}
612612
}
613-
}"
613+
}'
614614
~~~
615615

616616
To change the number of nodes in a region:
@@ -620,15 +620,15 @@ To change the number of nodes in a region:
620620
curl --request PATCH \
621621
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id} \
622622
--header "Authorization: Bearer {secret_key}" \
623-
--json "{
623+
--json '{
624624
"spec": {
625625
"dedicated": {
626626
"region_nodes": {
627627
"us-east-1": 5
628628
}
629629
}
630630
}
631-
}"
631+
}'
632632
~~~
633633

634634
Where `{cluster_id}` is the ID of your cluster and `{secret_key}` is your API key.
@@ -924,7 +924,7 @@ When possible, it is best practice to [limit each user's privileges]({% link coc
924924
curl --request POST \
925925
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/sql-users \
926926
--header "Authorization: Bearer {secret_key}" \
927-
--json "{"name":"{sql_username}","password":"{password}"}"
927+
--json '{"name":"{sql_username}","password":"{password}"}'
928928
~~~
929929

930930
Where:
@@ -1000,7 +1000,7 @@ The service account associated with the secret key must have the Cluster Admin o
10001000
curl --request PUT \
10011001
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/sql-users/{sql_username}/password \
10021002
--header "Authorization: Bearer {secret_key}" \
1003-
--json "{"password":"{new_password}"}"
1003+
--json '{"password":"{new_password}"}'
10041004
~~~
10051005

10061006
Where:
@@ -1035,7 +1035,7 @@ The service account associated with the secret key must have the Cluster Admin o
10351035
curl --request PUT \
10361036
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/maintenance-window \
10371037
--header "Authorization: Bearer REPLACE_BEARER_TOKEN" \
1038-
--json "{"offset_duration":"{offset_duration}","window_duration":"{window_duration}"}"
1038+
--json '{"offset_duration":"{offset_duration}","window_duration":"{window_duration}"}'
10391039
~~~
10401040

10411041
Where:
@@ -1094,7 +1094,7 @@ The service account associated with the secret key must have the Cluster Admin o
10941094
curl --request PUT \
10951095
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/version-deferral \
10961096
--header "Authorization: Bearer REPLACE_BEARER_TOKEN" \
1097-
--json "{"deferral_policy":"{deferral_policy}"}"
1097+
--json '{"deferral_policy":"{deferral_policy}"}'
10981098
~~~
10991099

11001100
Where:

src/current/cockroachcloud/egress-perimeter-controls.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ Essential external traffic destined to resources managed by Cockroach Labs is al
115115
--header "Authorization: Bearer $CC_API_KEY" \
116116
--header "Cc-Version: latest" \
117117
--url https://cockroachlabs.cloud/api/v1/clusters/$CLUSTER_ID/networking/egress-rules/egress-traffic-policy \
118-
--data "{"allow_all":false}"
118+
--data '{"allow_all":false}'
119119
~~~
120120
121121
~~~txt

0 commit comments

Comments
 (0)