Skip to content

Commit 1d67e11

Browse files
committed
Add documentation for hosting parameter to cli-subscriptions.md
1 parent 28f2216 commit 1d67e11

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

docs/cli/cli-orders.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,26 @@ planet orders request \
176176

177177
*New in version 2.1*
178178

179+
#### Sentinel Hub Hosting
180+
181+
You can deliver your orders directly to Sentinel Hub using the hosting options.
182+
183+
```
184+
planet orders request \
185+
--item-type PSScene \
186+
--bundle analytic_sr_udm2 \
187+
--name 'My First Order' \
188+
20220605_124027_64_242b \
189+
--hosting sentinel_hub \
190+
--collection_id ba8f7274-aacc-425e-8a38-e21517bfbeff
191+
```
192+
193+
- The --hosting option is optional and currently supports sentinel_hub as its only value.
194+
- The --collection_id is also optional. If you decide to use this, ensure that the order 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.
195+
196+
For more information on Sentinel Hub hosting, see the [Orders API documentation](https://developers.planet.com/apis/orders/delivery/#delivery-to-sentinel-hub-collection) and the [Linking Planet User to Sentinel Hub User
197+
](https://support.planet.com/hc/en-us/articles/16550358397469-Linking-Planet-User-to-Sentinel-Hub-User) support post.
198+
179199
### Save an Order Request
180200

181201
The above command just prints out the necessary JSON to create an order. To actually use it you can
@@ -236,6 +256,16 @@ Note the default output will be a bit more 'flat' - if you'd like the above form
236256
command-line just use `jq` as above: `planet orders create request-1.json | jq` (but remember
237257
if you run that command again it will create a second order).
238258

259+
#### Sentinel Hub Hosting
260+
261+
For convenience, `planet orders create` accepts the same `--hosting` and `--collection_id` options that [`planet orders request`](#sentinel-hub-hosting) does.
262+
263+
```sh
264+
planet orders create request-1.json \
265+
--hosting sentinel_hub \
266+
--collection_id ba8f7274-aacc-425e-8a38-e21517bfbeff
267+
```
268+
239269
### Create Request and Order in One Call
240270

241271
Using a unix command called a 'pipe', which looks like `|`, you can skip the step of saving to disk,

0 commit comments

Comments
 (0)