--- title: "Implementation" url: https://docs.catalyst.zoho.com/en/cloud-scale/help/api-gateway/implementation/ description: "Catalyst API Gateway enables you to create APIs to access the functions and web client end-points of your app, and perform advanced API management." last_updated: 2026-08-28T06:26:16Z service: Cloud Scale type: general --- # Implementation The implementation section is a step-by-step procedure guide to configure API Gateway from the Catalyst web console. You can learn about working with API Gateway from the CLI from the [CLI help documentation](https://docs.catalyst.zoho.com/en/cli/v1/working-with-api-gateway/introduction/). ### Enable API Gateway You must enable API Gateway for your project before you access it for the first time. As discussed earlier, when you enable the API Gateway for your Catalyst application, the configurations in [Security Rules](https://docs.catalyst.zoho.com/en/serverless/help/security-rules/introduction) are automatically disabled. The functions and the web client hosted in your Catalyst project will immediately become inaccessible until you create APIs for them. You should therefore proceed with caution. Ensure that you create APIs for all your functions and web client immediately after enabling API Gateway. You must also ensure that the end users do not access them in the meantime. You can learn about disabling API Gateway from [this section](https://docs.catalyst.zoho.com/en/cloud-scale/help/api-gateway/implementation/#disable-api-gateway). To enable API Gateway for your Catalyst application from the console: 1. Navigate to **API Gateway** under _Security & Identity_ in the Catalyst Cloud Scale console and Click **Enable Now**. ![catalyst_apig](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig.webp) 2. Click **Proceed** in the confirmation window. ![apig_enable](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig_enable.webp) You will receive a notification in the console once API Gateway is enabled for your Catalyst project. ### Create an API Before you begin, you must ensure that you have hosted at least one function or the web client in your Catalyst project, to create an API for it. > **Note:** You can create up to 1000 APIs in a project in the [development environment](https://docs.catalyst.zoho.com/en/deployment-and-billing/environments/development-environment). There are no upper limits for rule creation in the production environment. #### Auto-Create You can only use auto-create to create APIs automatically when you enable API Gateway for your project for the first time. If you have already created a custom API, you will not be able to access auto-create. Refer to [this section](https://docs.catalyst.zoho.com/en/cloud-scale/help/api-gateway/key-concepts/#auto-created-apis-custom-apis-and-the-default-api) for protocols to be followed when migrating definitions from Security Rules. To create APIs for your functions or the web client using auto-create: 1. Click **Create API** after you enable API Gateway in the Catalyst console. ![create_page](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig_create_page.webp) 2. Select **Auto-create API** and click **Next**. ![create_api](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig_create_api.webp) 3. All your Basic I/O and Advanced I/O functions, and the web client are selected by default. ![apig_autocreate](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig_autocreate_1.webp) Unselect the services that you don't want to create APIs for and click **Create**. ![apig_autocreate](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig_autocreate_2.webp) Catalyst will initiate the API creation process. ![apig_autocreate](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig_autocreate_3.webp) Once the APIs are created, you will receive a notification in your console. The APIs will be listed in the _API Gateway_ page. ![apig_autocreate](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig_autocreate_created.webp) You can edit the default values set for these APIs, and individually configure them based on your requirements. As discussed in this section, the default `Login Redirect API` is also created for the web client hosted in the project. ![apig_login_redirect](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig_login_redirect.webp) #### Create a Custom API You can create a custom API either immediately after enabling API Gateway or at any time after using auto-create. To create a custom API for your functions or the web client: 1. Click **Create API** from the _API Gateway_ page. ![catalyst_apig_custom_create](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig_custom_create.webp) You can also create it by selecting **Create a custom API** in the pop-up box after enabling API Gateway and clicking **Next**. ![catalyst_apig_customcreate_1](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig_customcreate_1.webp) This will open the _Create API_ window. ![catalyst_apig_customcreate_2](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig_customcreate_2.webp) 2. Enter a unique name for the API. Select a [request method](https://docs.catalyst.zoho.com/en/cloud-scale/help/api-gateway/key-concepts/#routing) and enter the request URL. ![catalyst_apig_customcreate_3](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig_customcreate_3.webp) > **Notes:** * You can only select the `GET` method for a web client. * The combination of the request URL and the request method should be unique. You will not be able to create more than one API for a specific combination of request URL and request method. Select the target component and then select the specific function or web client. ![](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig_customcreate_4.webp) If you selected an Advanced I/O function or a web client, you can append a route to the default target URL. A preview of the request URL will also be displayed. ![catalyst_apig_customcreate_5](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig_customcreate_5.webp) Select the [authentication methods](https://docs.catalyst.zoho.com/en/cloud-scale/help/api-gateway/key-concepts/#authentication-request-processor) if you require authentication. You can select any or all of these methods, and implement any one of them while providing the request URL. ![](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig_customcreate_6.webp) Configure the throttling limits for the API. You can configure either or both of the [throttling methods](https://docs.catalyst.zoho.com/en/cloud-scale/help/api-gateway/key-concepts/#throttling). ![catalyst_apig_customcreate_7](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig_customcreate_7.webp) 3. Click **Create**. The API will be created and listed in the _API Gateway_ page. ![catalyst_apig_customcreate_created](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig_customcreate_created.webp) ### Edit an API You can edit an auto-created or a custom API at any time and modify its definitions in the following way: 1. Click **Edit** for the API. ![catalyst_apig_edit_icon](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig_edit_icon.webp) 2. Modify the required values and click **Update**. ![catalyst_apig_edit_api](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig_edit_api.webp) ### Delete an API You can delete an API in the following way: 1. Click **Delete** for the API. ![catalyst_apig_delete_api](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig_delete_api.webp) 2. Click **Yes, Proceed** in the confirmation box. ![catalyst_apig_delete_confirmation](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig_delete_confirmation.webp) > **Note:** Deleting an API will render its associated target URL inaccessible. ### Disable API Gateway You can disable API Gateway at any time and switch to the definitions configured in the [Security Rules](https://docs.catalyst.zoho.com/en/serverless/help/security-rules/introduction). 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: 1. Click the **ellipsis icon** on the _API Gateway_ page and click **Disable**. ![catalyst_apig_disable](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig_disable.webp) 2. Type "DISABLE" in the text box and click **Confirm**. ![catalyst_apig_disable_confirmation](https://catalyst-docs-development.zohostratus.in/images/help/api-gateway/catalyst_apig_disable_confirmation.webp) The API Gateway will now be disabled and Security Rules will immediately be automatically enabled.