Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 30. endpoint

This chapter describes the commands under the endpoint command.

30.1. endpoint create
Copy link

Usage:

openstack endpoint create [-h] [-f {json,shell,table,value,yaml}]

                               [-c COLUMN] [--max-width <integer>]
                               [--fit-width] [--print-empty] [--noindent]
                               [--prefix PREFIX] --publicurl <url>
                               [--adminurl <url>] [--internalurl <url>]
                               [--region <region-id>]
                               <service>
Copy to Clipboard Toggle word wrap

Create new endpoint

Expand
Table 30.1. Positional Arguments
ValueSummary

<service>

Service to be associated with new endpoint (name or ID)

Expand
Table 30.2. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--publicurl <url>

New endpoint public url (required)

--adminurl <url>

New endpoint admin url

--internalurl <url>

New endpoint internal url

--region <region-id>

New endpoint region id

Expand
Table 30.3. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 30.4. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 30.5. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 30.6. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

30.2. endpoint delete
Copy link

Usage:

openstack endpoint delete [-h] <endpoint-id> [<endpoint-id> ...]
Copy to Clipboard Toggle word wrap

Delete endpoint(s)

Expand
Table 30.7. Positional Arguments
ValueSummary

<endpoint-id>

Endpoint(s) to delete (id only)

Expand
Table 30.8. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

30.3. endpoint list
Copy link

Usage:

openstack endpoint list [-h] [-f {csv,json,table,value,yaml}]

                             [-c COLUMN] [--max-width <integer>]
                             [--fit-width] [--print-empty] [--noindent]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--sort-column SORT_COLUMN] [--long]
Copy to Clipboard Toggle word wrap

List endpoints

Expand
Table 30.9. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

Expand
Table 30.10. Output Formatters
ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Expand
Table 30.11. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 30.12. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 30.13. CSV Formatter
ValueSummary

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

30.4. endpoint show
Copy link

Usage:

openstack endpoint show [-h] [-f {json,shell,table,value,yaml}]

                             [-c COLUMN] [--max-width <integer>]
                             [--fit-width] [--print-empty] [--noindent]
                             [--prefix PREFIX]
                             <endpoint>
Copy to Clipboard Toggle word wrap

Display endpoint details

Expand
Table 30.14. Positional Arguments
ValueSummary

<endpoint>

Endpoint to display (endpoint id, service id, service name, service type)

Expand
Table 30.15. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 30.16. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 30.17. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 30.18. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 30.19. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat