Skip to content

Commit db7ff57

Browse files
committed
Move and correct hosting documentation in cli-subscriptions.md
1 parent 1d67e11 commit db7ff57

File tree

1 file changed

+15
-32
lines changed

1 file changed

+15
-32
lines changed

docs/cli/cli-subscriptions.md

Lines changed: 15 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -120,17 +120,6 @@ planet subscriptions create my-subscription.json
120120
!!!note "Note"
121121
The above command assumes that you’ve saved the subscriptions JSON as `my-subscription.json` and that you’ve replaced the delivery information with your own bucket and credentials.
122122

123-
#### Create a Subscription with Hosting and Collection ID
124-
125-
In addition to the basic subscription creation process, you can now specify hosting options and a collection ID directly in the create command.
126-
127-
```sh
128-
planet subscriptions create my-subscription.json --hosting sentinel_hub --collection_id ba8f7274-aacc-425e-8a38-e21517bfbeff
129-
```
130-
131-
- The --hosting option is optional and currently supports sentinel_hub as its only value.
132-
- The --collection_id is also optional. If you decide to use this, ensure that the subscription request and the collection have matching bands. If you're unsure, allow the system to create a new collection for you by omitting the --collection_id option. This will ensure the newly set-up collection is configured correctly, and you can subsequently add items to this collection as needed.
133-
134123
### List Subscriptions
135124

136125
Now that you’ve got a subscription working you can make use of the other commands.
@@ -487,42 +476,36 @@ The main documentation page also has the parameters for Google Cloud, AWS and Or
487476

488477
### Subscriptions Request
489478

490-
When creating a new subscription, you can include hosting options directly using the --hosting and --collection-id flags.
491-
492-
- The --hosting option is optional and currently supports sentinel_hub as its only value.
493-
- The --collection_id is also optional. If you decide to use this, ensure that the subscription request and the collection have matching bands. If you're unsure, allow the system to create a new collection for you by omitting the --collection_id option. This will ensure the newly set-up collection is configured correctly, and you can subsequently add items to this collection as needed.
494-
- You may also input --hosting as a JSON file. The file should be formatted:
495-
496-
```json
497-
"hosting": {
498-
"parameters": {
499-
"collection_id": "4bdef85c-3f50-4006-a713-2350da665f80"
500-
},
501-
"type": "sentinel_hub"
502-
},
503-
```
504-
505479
Once you’ve got all your sub-blocks of JSON saved you’re ready to make a complete subscriptions request with the `subscriptions request` command:
506480

481+
The above will print it nicely out so you can see the full request. You can write it out
482+
as a file, or pipe it directly into `subscriptions create` or `subscriptions update`:
483+
507484
```sh
508485
planet subscriptions request \
509486
--name 'First Subscription' \
510487
--source request-catalog.json \
511488
--tools tools.json \
512489
--delivery cloud-delivery.json \
513-
--hosting sentinel_hub \
514-
-- collection_id 4bdef85c-3f50-4006-a713-2350da665f80 \
515-
--pretty
490+
| planet subscriptions create -
516491
```
517492

518-
The above will print it nicely out so you can see the full request. You can write it out
519-
as a file, or pipe it directly into `subscriptions create` or `subscriptions update`:
493+
#### Sentinel Hub Hosting
494+
495+
When creating a new subscription, you can include hosting options directly using the --hosting and --collection-id flags.
496+
497+
- The --hosting option is optional and currently supports sentinel_hub as its only value.
498+
- The --collection_id is also optional. If you decide to use this, ensure that the subscription request and the collection have matching bands. If you're unsure, allow the system to create a new collection for you by omitting the --collection_id option. This will ensure the newly set-up collection is configured correctly, and you can subsequently add items to this collection as needed.
499+
- You may also input --hosting as a JSON file. The file should be formatted:
520500

521501
```sh
522502
planet subscriptions request \
523503
--name 'First Subscription' \
524504
--source request-catalog.json \
525505
--tools tools.json \
526-
--delivery cloud-delivery.json \
506+
--hosting sentinel_hub \
527507
| planet subscriptions create -
528508
```
509+
510+
For more information on Sentinel Hub hosting, see the [Subscriptions API documentation](https://developers.planet.com/docs/subscriptions/delivery/#delivery-to-sentinel-hub-collection) and the [Linking Planet User to Sentinel Hub User
511+
](https://support.planet.com/hc/en-us/articles/16550358397469-Linking-Planet-User-to-Sentinel-Hub-User) support post.

0 commit comments

Comments
 (0)