2024-04-30 14:31:48 -04:00
|
|
|
---
|
|
|
|
|
layout: docs
|
|
|
|
|
page_title: aliases read - Command
|
2024-12-17 14:13:18 -05:00
|
|
|
description: >-
|
|
|
|
|
The "aliases read" command retrieves the details of an alias resource.
|
2024-04-30 14:31:48 -04:00
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# aliases read
|
|
|
|
|
|
|
|
|
|
Command: `aliases read`
|
|
|
|
|
|
|
|
|
|
The `aliases read` command lets you read the details of an alias with a given ID.
|
|
|
|
|
|
|
|
|
|
## Example
|
|
|
|
|
|
|
|
|
|
This example reads the details of an alias with the ID `alt_1234567890`:
|
|
|
|
|
|
|
|
|
|
```shell-session
|
|
|
|
|
$ boundary aliases read -id alt_1234567890
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
|
|
|
|
|
|
```shell-session
|
|
|
|
|
$ boundary aliases read [options] [args]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
</CodeBlockConfig>
|
|
|
|
|
|
|
|
|
|
### Command options
|
|
|
|
|
|
|
|
|
|
- `-id=<string>` - The ID of the alias you want to read.
|
|
|
|
|
|
|
|
|
|
@include 'cmd-option-note.mdx'
|
