Skip to content

Commit a3bb459

Browse files
committed
update cli docs
1 parent e57b6e2 commit a3bb459

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

docs/cli/cli-destinations.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,19 @@ The `list` command supports filtering on a variety of fields. You can discover a
3131
requesting user, false to exclude them.
3232
* `--can-write`: Set to true to include only destinations the user can
3333
modify, false to exclude them.
34+
* `--is-default`: Set to true to include only the default destination,
35+
false to exclude it.
3436

3537
For example, issue the following command to list destinations that are not archived and you as the user have permission to modify:
3638
```sh
3739
planet destinations list --archived false --can-write true
3840
```
3941

42+
To list only the default destination (if one is set):
43+
```sh
44+
planet destinations list --is-default true
45+
```
46+
4047
### Modify Destinations
4148
The CLI conveniently moves all modify actions to first class commands on the destination. The supported actions are archive, unarchive, rename, and update credentials. To discover all update actions run `planet destinations --help`.
4249

@@ -47,6 +54,31 @@ Credential updating might be done if credentials expire or need to be rotated. F
4754
planet destinations update s3 my-destination-id --access-key-id NEW_ACCESS_KEY --secret-access-key NEW_SECRET_KEY
4855
```
4956

57+
### Manage Default Destinations
58+
Default destinations are globally available to all members of an organization. An organization can have zero or one default destination at any time. Managing default destinations (setting, unsetting) is restricted to organization administrators and destination owners.
59+
60+
#### Set a Default Destination
61+
To set a destination as the default for your organization:
62+
```sh
63+
planet destinations default set my-destination-id
64+
```
65+
66+
#### Get the Current Default Destination
67+
To retrieve the current default destination (if one is set):
68+
```sh
69+
planet destinations default get
70+
```
71+
72+
If no default destination is set, this command will return an error indicating that no default destination is configured.
73+
74+
#### Unset the Default Destination
75+
To remove the current default destination:
76+
```sh
77+
planet destinations default unset
78+
```
79+
80+
This command returns no content on success (HTTP 204). Only organization administrators and destination owners can unset the default destination.
81+
5082
## Using destinations in Subscriptions API
5183
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.
5284

0 commit comments

Comments
 (0)