Disable API Gateway

You can disable the API Gateway in your project at any time from the CLI. This will immediately re-enable the definitions configured in the Security Rules .

Note: If you re-enable API Gateway after disabling it, all the APIs that you had created will still be available and will immediately be re-enabled when API Gateway is re-enabled. You will not have to create the same APIs again.

To disable API Gateway for your project, execute the following command from your project directory:

copy
$
catalyst apig:disable

The CLI will disable the component and update the catalyst.json file with the API Gateway’s status. The enabled parameter for the apig configuration will be updated to false. This will also disable the API Gateway in the remote console.

Disable API Gateway

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

ON THIS PAGE