aireg atlan api when a public API has no dedicated CLI command. It uses
the selected Atlan registry’s origin and credentials, so you do not need to
copy a bearer token into a command argument.
Before you begin
Set up the Atlan adapter and confirm your account withaireg auth list. Use the public API reference
to choose the method, path, and request body. Your account still needs the
operation’s permissions and workspace access.
Start with a read
--registry is optional. Name it explicitly in
scripts to keep the destination clear.
The path must start with one / and stay on the selected Gateway origin.
For a query string, quote the full path:
Send JSON
For a write, save the request body as JSON and pass--input <file>.
--input - reads standard input. GET requests do not accept --input.
Review the public operation’s required fields before sending the request.
Keep returned credentials out of terminal output
The command removes recognized credential fields from normal output. When an operation returns a key or other one-time credential that you need to retain, use--output-file <new-path>. The command creates a private file and refuses
to overwrite an existing file. Add --output-field <dotted-path> to save one
field instead of the full response.
Put credential files outside the repository and move their contents into your
approved secret store. A redacted terminal response cannot recover a one-time
key after the request.