Last modified March 2, 2022

'gsctl list endpoints' command reference

gsctl and the REST API are being phased out. We don't have an end-of-life date yet. However, we recommend to familiarize yourself with our Management API and the kubectl gs plugin as a future-proof replacement. We provide a migration page to help you with the transition.

The gsctl list endpoints command shows all endpoints you have logged in to so far with additional information.

An endpoint is the Giant Swarm REST API URL for an installation you access using gsctl. If you have only one installation, you have only one endpoint. But if you are using, for example, one installation on-premises and one in the cloud, you have two endpoints.

Usage and output

The command has no specific flags. Simply run it like this:

gsctl list endpoints

If you have ever logged in to an endpoint before, you will get a table like the one below as a result:

ALIAS    ENDPOINT URL                                          EMAIL            SELECTED  LOGGED IN
cloudy  yes       yes
onpremy   no        yes

Output details

  • The first column shows the endpoint alias which you can use as a shorthand to select this endpoint. See gsctl select endpoint for details.

    Note: If the column shows n/a, the endpoint has been added with a gsctl version before 0.10.0. You can manually edit the configuration file to remove the according endpoint and then re-login.

  • Column two shows the full endpoint URL.

  • The EMAIL column shows the email address you have used to log in.

  • The SELECTED column informs you which one of the endpoints listed is currently selected. This means that you will work with this endpoint, unless you specify a different endpoint using the -e/--endpoint command line flag.

  • The column LOGGED IN indicates whether you are currently logged in with the endpoint.