Manage Registration on Your API Gateway

Use the following commands to list or unregister endpoints and manage registration credentials on your API Gateway.

Note: For a list of all the API gateway commands, see API Gateway (APIGW) Command Index.

  1. Open an SSH connection to the API gateway and log in.
  2. At the prompt, enter the following:

    3. /opt/quantum/api-gateway/bin/apigw endpoint list

  3. Below is an example of the output:

    4. Endpoint UID                                                 Registration Auth              Endpoint Name
stornext-host-6f7c7c83-c6df-4c98-8aa0-a9ebd9661ce6           quantum-app-registration       snt527847-mdc1
stornext-nameserver-6f7c7c83-c6df-4c98-8aa0-a9ebd9661ce6     quantum-app-registration       snt527847-mdc1
stornext-mdc-6f7c7c83-c6df-4c98-8aa0-a9ebd9661ce6            quantum-app-registration       snt527847-mdc1
stornext-fs-snfs1-f5fb1bae-57ea-41cf-b39d-59fd38133cd8       quantum-app-registration       snfs1
stornext-fs-snfs2-4cc91eb9-3e6b-4d98-8ba1-6e68784a48e5       quantum-app-registration       snfs2

  1. Open an SSH connection to the API gateway and log in.
  2. At the prompt, enter the following:

    3. /opt/quantum/api-gateway/bin/apigw endpoint deregister OPTIONS

    Below are the available options for the endpoint deregister command.

    Option Description.

    all

    This option allows you to unregister all current endpoints.

    XXXX

    This option allows you to unregister an endpoint, where XXXX is the endpoint UID.

    -r XXXX

    This option allows you to unregister an endpoint where the registration authentication is XXXX.

    Note: If you do not specify an option, the script enters into interactive mode.

    Example if you specify an option

    /opt/quantum/api-gateway/bin/apigw endpoint deregister stornext-host-6f7c7c83-c6df-4c98-8aa0-a9ebd9661ce6

    Example if you do not specify an option 

    /opt/quantum/api-gateway/bin/apigw endpoint deregister

Index  Endpoint UID                                                 Registration Auth              Endpoint Name
0      stornext-host-3a637017-6d70-46dc-9988-ad43f5a884dc           quantum-app-registration       snt558317-mdc
1      stornext-nameserver-3a637017-6d70-46dc-9988-ad43f5a884dc     quantum-app-registration       snt558317-mdc
2      stornext-mdc-3a637017-6d70-46dc-9988-ad43f5a884dc            quantum-app-registration       snt558317-mdc
3      stornext-host-f7e52ad6-1ba9-461e-ae45-bc4ee9c1d0f9           quantum-app-registration       snt558317-l-server2
4      flexsync-admind-3a637017-6d70-46dc-9988-ad43f5a884dc         quantum-app-registration       snt558317-mdc
5      stornext-fs-snfs2-0c3facfa-664e-4de1-b326-bdb2aa23af11       quantum-app-registration       snfs2
6      stornext-fs-snfs1-7201058f-ff6b-4aba-a36d-260d97f06b0a       quantum-app-registration       snfs1
7      stornext-fs-snfs3-f138f04f-ae74-4f6a-b1ae-f96919fadcdc       quantum-app-registration       snfs3
8      snnas-host-4a16e8a9-ad4a-46f9-8e5a-e7c8b36e6b45              quantum-app-registration       snt558317-gw1

Type index or endpoint uid to deregister, type "q" to exit: 8

Type 'yes' to confirm 'snnas-host-4a16e8a9-ad4a-46f9-8e5a-e7c8b36e6b45' endpoint deregistration: yes
Endpoint "snnas-host-4a16e8a9-ad4a-46f9-8e5a-e7c8b36e6b45" deregistered

Type index or endpoint uid to deregister, type "q" to exit: q
  1. Open an SSH connection to the API gateway and log in.
  2. At the prompt, enter the following:

    3. /opt/quantum/api-gateway/bin/apigw endpoint regauth config registration name

    Note: The registration name is the name of the registration you want to display the configuration details for. See Show All Registration Names on Your API Gateway.

  3. Below is an example of the output:

    4. {
    "url": "https://myapi-gateway.mydomain.com:8443",
    "admin_url": "https://myapi-gateway.mydomain.com:8443",
    "access_token_url": "https://myapi-gateway.mydomain.com:8443/api/authentication/client-access-token",
    "refresh_token_url": "https://myapi-gateway.mydomain.com:8443/api/authentication/client-refresh-token",
    "public_key_url": "https://myapi-gateway.mydomain.com:8443/api/authentication/public-key",
    "logout_url":  "https://myapi-gateway.mydomain.com:8443/api/authentication/client-logout",
    "auth_client_id": "myregistration",
    "auth_client_secret": "M27918!XTe#rMe$MBcyGEd8S"
}

  1. Open an SSH connection to the API gateway and log in.
  2. At the prompt, enter the following:

    3. /opt/quantum/api-gateway/bin/apigw endpoint regauth list

  3. Below is an example of the output:

    4. NAME                           ENABLED
====                           =======
quantum-app-registration       true

  1. Open an SSH connection to the API gateway and log in.
  2. At the prompt, enter the following:

    3. /opt/quantum/api-gateway/bin/apigw endpoint regauth add <registration name> OPTIONS

    Note: The registration name is the name of the registration you want to add on your API gateway.

    Below are the available options for the endpoint regauth add command.

    Option Description.

    -e, or --enabled

    This option allows you to specify if the registration is enabled or disabled. Enter one of the following:

    • true
    • false

    The default is true.

    Example

    /opt/quantum/api-gateway/bin/apigw endpoint regauth add myregistration -e true

  1. Open an SSH connection to the API gateway and log in.
  2. At the prompt, enter the following:

    3. /opt/quantum/api-gateway/bin/apigw endpoint regauth update <registration name> OPTIONS

    Note: The registration name is the name of the registration you want to update on your API gateway. See Show All Registration Names on Your API Gateway.

    Below are the available options for the endpoint regauth update command.

    Option Description.

    -e, or --enabled

    This option allows you to specify if the registration is enabled or disabled. Enter one of the following:

    • true
    • false

    -s, or --secret

    This option automatically generates a new secret for the specified registration.

    Example

    /opt/quantum/api-gateway/bin/apigw endpoint regauth update myregistration -e false -s

  1. Open an SSH connection to the API gateway and log in.
  2. At the prompt, enter the following:

    3. /opt/quantum/api-gateway/bin/apigw endpoint regauth delete <registration name>

    Note: The registration name is the identifier of the registration you want to remove from your API gateway. See Show All Registration Names on Your API Gateway.

    Example

    /opt/quantum/api-gateway/bin/apigw endpoint regauth delete myregistration