Robert Main
18f469105c
* Update website folder to indicate deprecation Adds an alert banner to the top of all MDX files within `/website` to indicate deprecation * Update website README
46 lines
1.5 KiB
Plaintext
46 lines
1.5 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: read - Command
|
|
description: >-
|
|
The "read" command retrieves details about existing Boundary resources using the resource's ID.
|
|
---
|
|
|
|
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
|
|
> [!IMPORTANT]
|
|
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
|
|
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
|
|
|
|
# read
|
|
|
|
Command: `boundary read`
|
|
|
|
The `boundary read` command lets you read Boundary resources.
|
|
It is a generic command that runs a read operation on a Boundary resource using the resource's ID.
|
|
|
|
When you run this command, Boundary interprets it as the type-specific command.
|
|
For example, if you enter the `read` command with a storage bucket ID, Boundary runs the `storage-buckets read` command.
|
|
Help, error, or cURL output from the command may show the full command syntax.
|
|
|
|
## Example
|
|
|
|
This example reads a storage bucket with the ID `sb_1234567890`:
|
|
|
|
```shell-session
|
|
$ boundary read -id sb_1234567890
|
|
```
|
|
|
|
## Usage
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```shell-session
|
|
$ boundary read [resource ID] [args]
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
### Command options
|
|
|
|
- `-id=<string>` - The ID of the resource you want to read.
|
|
|
|
@include 'cmd-option-note.mdx' |