--- title: "API Hosting" slug: "api-hosting" description: "Once added, Hosted APIs can be used when setting up Option Sets, Lookups, form Validation, or Personalization & Receipt Generation." updated: 2026-10-16T18:47:47Z published: 2026-10-16T18:47:47Z canonical: "www.civicplus.help/api-hosting" --- > ## Documentation Index > Fetch the complete documentation index at: https://www.civicplus.help/llms.txt > Use this file to discover all available pages before exploring further. # API Hosting This article will show you how to create a Hosted API. Once added, Hosted APIs can be used when setting up [Option Sets](/process-automation/docs/create-a-dynamic-list), [Lookups](/process-automation/docs/create-and-manage-lookups), [form Validation](/process-automation/docs/server-side-validation), or [Personalization and Receipt Generation](/process-automation/docs/receipt-generation). ## Add an API [Embedded content](https://www.iorad.com/player/1888045/CivicOptimize--How-to-Add-an-API-Hosting-Practice-Tutorial) 1. [Sign in to your site](/process-automation/docs/sign-in-to-your-site) 2. Click on the **Workflow navigation** and select the **Settings** button ![Navigation menu showing 'My Workspace' and 'Settings' options.](https://cdn.us.document360.io/17dc564a-8310-4f61-b929-1bd73b36e158/Images/Documentation/Environments, Settings - PADS.png?sv=2026-02-06&spr=https&st=2026-11-22T12%3A50%3A48Z&se=2026-11-22T13%3A50%3A48Z&sr=b&sp=r&sig=CwhTkKZQ0frvESWqABvPo8Spi%2FLAHH6NiWrcv%2Fso3YI%3D) 3. Navigate to **Developer Tools** and select **API** **Hosting**![Account settings menu highlighting Developer Tools and API Hosting options for configuration.](https://cdn.us.document360.io/17dc564a-8310-4f61-b929-1bd73b36e158/Images/Documentation/Developer%20Tools,%20API%20Hosting%20-%20PADS.png?sv=2026-02-06&spr=https&st=2026-11-22T12%3A50%3A48Z&se=2026-11-22T13%3A50%3A48Z&sr=b&sp=r&sig=B65CZjVkcqI1o1go06D7BzunU%2FXB0BiMBZAhRKOl0%2Fs%3D) 4. Click the **+** button in the bottom right corner ![A circular icon with a plus sign.](https://cdn.us.document360.io/17dc564a-8310-4f61-b929-1bd73b36e158/Images/Documentation/Add%20API%20Hosting%20-%20PADS.png?sv=2026-02-06&spr=https&st=2026-11-22T12%3A50%3A48Z&se=2026-11-22T13%3A50%3A48Z&sr=b&sp=r&sig=%2FfbjgvEp2m8sPCWCR%2FawUEoYaypYhlwKoGd1unrGGMY%3D) 5. Fill out the API fields![Form for creating a new API with fields for subdomain and email addresses.](https://cdn.us.document360.io/17dc564a-8310-4f61-b929-1bd73b36e158/Images/Documentation/API%20Hosting%20Fields%20-%20PADS.png?sv=2026-02-06&spr=https&st=2026-11-22T12%3A50%3A48Z&se=2026-11-22T13%3A50%3A48Z&sr=b&sp=r&sig=WKQDpkdYlBLAF427kPlLHwD5hPrTki4Vi%2BHt9EfCLyI%3D) - **API Subdomain:** Add the subdomain for the API URL > [!WARNING] > Note: > > The URL must only contain lowercase letters and numbers. - **Sending Email Addresses:** If applicable, enter email addresses for the API - **Subnets:** Choose to add subnets to the API - **Security Groups:** Add any applicable security groups 6. Click **Save**![A save button on the pop-up screen.](https://cdn.us.document360.io/17dc564a-8310-4f61-b929-1bd73b36e158/Images/Documentation/Save%20API%20Hosting%20Fields%20-%20PADS.png?sv=2026-02-06&spr=https&st=2026-11-22T12%3A50%3A48Z&se=2026-11-22T13%3A50%3A48Z&sr=b&sp=r&sig=nf29UfuslcMV8XI9KKNmdUwggDFk4v3E9xB8fkXbdEw%3D) 7. Your API will appear at the top of the screen ![API example.](https://cdn.us.document360.io/17dc564a-8310-4f61-b929-1bd73b36e158/Images/Documentation/9303338181271.png?sv=2026-02-06&spr=https&st=2026-11-22T12%3A50%3A48Z&se=2026-11-22T13%3A50%3A48Z&sr=b&sp=r&sig=5cxtG2w4XwuIWueU6dzNl9%2FD8HlsPkUhUnwS9IqH%2BEs%3D) 8. Use the [CivicPlus CLI (command-line interface)](https://www.npmjs.com/package/@oneblink/cli) to deploy an API environment. If you require further assistance, please don't hesitate to [contact Support](/process-automation/docs/contact-civicplus-support). ![environments deployed for API.](https://cdn.us.document360.io/17dc564a-8310-4f61-b929-1bd73b36e158/Images/Documentation/9303292796311.png?sv=2026-02-06&spr=https&st=2026-11-22T12%3A50%3A48Z&se=2026-11-22T13%3A50%3A48Z&sr=b&sp=r&sig=RXHBrcbOFgC9B%2FeEx4j63gPatFSzz6Bmb8IiHt1U5IE%3D) --- ## Delete an API [Embedded content](https://www.iorad.com/player/1888039/CivicOptimize--How-to-Delete-an-API-Instance-Practice-Tutorial) 1. [Sign in to your site](/process-automation/docs/sign-in-to-your-site) 2. Click on the **Workflow navigation** and select the **Settings** button ![Navigation menu showing 'My Workspace' and 'Settings' options.](https://cdn.us.document360.io/17dc564a-8310-4f61-b929-1bd73b36e158/Images/Documentation/Environments, Settings - PADS.png?sv=2026-02-06&spr=https&st=2026-11-22T12%3A50%3A48Z&se=2026-11-22T13%3A50%3A48Z&sr=b&sp=r&sig=CwhTkKZQ0frvESWqABvPo8Spi%2FLAHH6NiWrcv%2Fso3YI%3D) 3. Navigate to **Developer Tools** and select **API Hosting** ![Account settings menu highlighting Developer Tools and API Hosting options for configuration.](https://cdn.us.document360.io/17dc564a-8310-4f61-b929-1bd73b36e158/Images/Documentation/Developer%20Tools,%20API%20Hosting%20-%20PADS.png?sv=2026-02-06&spr=https&st=2026-11-22T12%3A50%3A48Z&se=2026-11-22T13%3A50%3A48Z&sr=b&sp=r&sig=B65CZjVkcqI1o1go06D7BzunU%2FXB0BiMBZAhRKOl0%2Fs%3D) 4. Click **Delete API Instance** (trash can icon) next to the API![API hosting domain with the trashcan icon highlighted.](https://cdn.us.document360.io/17dc564a-8310-4f61-b929-1bd73b36e158/Images/Documentation/Delete%20Hosting%20-%20PADS.png?sv=2026-02-06&spr=https&st=2026-11-22T12%3A50%3A48Z&se=2026-11-22T13%3A50%3A48Z&sr=b&sp=r&sig=s9XmMD5wXlXJ1DrcJWSi1mnQfqvOKfSG6wCTNZYu0l4%3D) 5. Select **Delete** on the pop-up that says **Are you sure you want to delete [API name]?**![Confirmation dialog asking to delete a specific API with cancel and delete options.](https://cdn.us.document360.io/17dc564a-8310-4f61-b929-1bd73b36e158/Images/Documentation/Delete%20Hosting%20Confirmation%20-%20PADS.png?sv=2026-02-06&spr=https&st=2026-11-22T12%3A50%3A48Z&se=2026-11-22T13%3A50%3A48Z&sr=b&sp=r&sig=hpTWOqVLHbd%2BBjgseLemNx2i1bvrD%2FO%2FlQvfJLYYAb0%3D) Application Programming Interface. A set of rules that allows programmers to develop software for a particular operating system without having to be completely familiar with that operating system. Uniform Resource Locator