Obtain API Gateway Status

Command Execution

You can obtain the current status of your project’s API Gateway to verify if it is enabled or disabled. If API creation is in progress in API Gateway, for example an auto-creation process is in progress, this will also display the status of the schedule progress and inform you of its current state.

To obtain the status of your project’s API Gateway and its schedule progress, execute the following command from your project directory:

copy
$
catalyst apig:status

The current status will be displayed.

Obtain API Gateway Status


API Gateway Status Options

You can also obtain the previous schedule status of your project’s API Gateway, instead of the current status by executing the $ catalyst apig:status with the following option:

copy
$
catalyst apig:status --previous

This will display the previous recorded status of the API Gateway component. If the component was previously disabled or enabled, the CLI will inform you of this.

Obtain API Gateway Status

Note: If you are a Visual Studio Code IDE user, you can install the Catalyst Tools extension, and perform CLI operations using your IDE in place of the CLI. Steps to work with API Gateway using Visual Studio Code IDE can be found here.

Last Updated 2024-01-09 17:07:13 +0530 +0530