You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/cli/cli-destinations.md
+5-8Lines changed: 5 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ title: CLI for Destinations API Tutorial
3
3
---
4
4
5
5
## Introduction
6
-
The `planet destinations` command enables interaction with the [Destinations API](https://docs.planet.com/develop/apis/destinations/), that enables the creation, listing, and modifying of destinations as well as using the destination in other services to streamline data delivery. This tutorial takes you through the main command available in the CLI.
6
+
The `planet destinations` command enables interaction with the [Destinations API](https://docs.planet.com/develop/apis/destinations/), which enables the creation, listing, and modifying of destinations as well as using destinations in other services to streamline data delivery. This tutorial takes you through the main commands available in the CLI.
7
7
8
8
## Core Workflows
9
9
@@ -34,8 +34,6 @@ For example, to list destinations that are not archived and you can modify you w
34
34
planet destinations list --not-archived --can-write
35
35
```
36
36
37
-
As a reminder, destinations are shared across your organization so without using --is-owner, destinations created by anyone in your organization will be returned.
38
-
39
37
### Update Destinations
40
38
The CLI conveniently moves all update actions to first class commands on the destination. The allowed update actions are archiving, unarchiving, renaming, and updating credentials. To discover all update actions run `planet destinations --help`.
Now that you have created a destination, it can be used as the delivery location for subscriptions. Use the destination reference in the delivery block instead of credentials.
48
+
After creating a destination, it can be used as the delivery location for subscriptions. Use the destination reference in the delivery block instead of credentials.
51
49
52
50
The subsequent examples will use the destination ref `pl:destinations/my-s3-destination-6HRjBcW74jeH9SC4VElKqX`.
53
51
```json
@@ -106,15 +104,15 @@ Then create the subscription, with the json above saved to a file.
106
104
planet subscriptions create my-subscription.json
107
105
```
108
106
109
-
The results of the created subscription will be delivered to the destination provided. You may re-use the destinations across an unlimited number of subscriptions.
107
+
The results of the created subscription will be delivered to the destination provided.
110
108
111
109
To retrieve all subscriptions created with a specific destination, issue the following command:
112
110
```sh
113
111
planet subscriptions list --destination-ref pl:destinations/my-s3-destination-6HRjBcW74jeH9SC4VElKqX
114
112
```
115
113
116
114
## Using destinations in Orders API
117
-
Now that you have created a destination, it can be used as the delivery location for orders. Use the destination reference in the delivery block instead of credentials.
115
+
After creating a destination, it can be used as the delivery location for orders. Use the destination reference in the delivery block instead of credentials.
118
116
119
117
The subsequent examples will use the destination ref `pl:destinations/my-s3-destination-6HRjBcW74jeH9SC4VElKqX`.
120
118
```json
@@ -137,13 +135,12 @@ The subsequent examples will use the destination ref `pl:destinations/my-s3-dest
137
135
}
138
136
```
139
137
140
-
141
138
Then create the order, with the json above saved to a file.
142
139
```sh
143
140
planet orders create my-order.json
144
141
```
145
142
146
-
The results of the created order will be delivered to the destination provided. You may re-use the destinations across an unlimited number of orders (and subscriptions!).
143
+
The results of the created order will be delivered to the destination provided.
147
144
148
145
To retrieve all orders created with a specific destination, issue the following command:
0 commit comments