|
| 1 | +--- |
| 2 | +title: Customize the API Center Portal |
| 3 | +description: Learn about settings you can customize in your Azure API Center portal. |
| 4 | +author: dlepow |
| 5 | +ms.service: azure-api-center |
| 6 | +ms.topic: how-to |
| 7 | +ms.date: 08/07/2025 |
| 8 | +ms.update-cycle: 180-days |
| 9 | +ms.author: danlep |
| 10 | +ms.custom: |
| 11 | +ms.collection: ce-skilling-ai-copilot |
| 12 | +# Customer intent: As an API program manager, I want to customize the Azure-managed portal for developers and other API stakeholders in my organization. |
| 13 | +--- |
| 14 | + |
| 15 | +# Customize your API Center portal |
| 16 | + |
| 17 | +This article explains settings that you can customize in the API Center portal (preview). The API Center portal is an Azure-managed website that developers and other stakeholders in your organization use to discover the APIs in your [API center](overview.md). |
| 18 | + |
| 19 | +To set up the API Center portal for initial use and sign-in, see [Set up the API Center portal](set-up-api-center-portal.md). |
| 20 | + |
| 21 | +> [!NOTE] |
| 22 | +> The API Center portal is currently in preview. |
| 23 | +
|
| 24 | +## Portal settings page |
| 25 | + |
| 26 | +Configure API Center portal settings in the Azure portal. To access the settings page: |
| 27 | + |
| 28 | +1. Navigate to your API center in the Azure portal. |
| 29 | +1. Under **API Center portal**, select **Settings**. |
| 30 | +1. Click on the tabs to view and customize the settings. |
| 31 | +1. Select **Save + publish** to apply your changes. |
| 32 | + |
| 33 | +:::image type="content" source="media/customize-api-center-portal/configure-portal-settings.png" alt-text="Screenshot of API Center portal settings in the Azure portal." lightbox="media/customize-api-center-portal/configure-portal-settings.png"::: |
| 34 | + |
| 35 | +> [!IMPORTANT] |
| 36 | +> Select **Save + publish** each time that you make changes to the settings. Until you publish, your changes aren't visible in the API Center portal. |
| 37 | +
|
| 38 | +## Site profile |
| 39 | + |
| 40 | +On the **Site profile** tab, optionally provide a custom name that appears in the top bar of the published portal. |
| 41 | + |
| 42 | +:::image type="content" source="media/customize-api-center-portal/custom-name.png" alt-text="Screenshot of custom name in API Center portal."::: |
| 43 | + |
| 44 | +## API visibility |
| 45 | + |
| 46 | +On the **API visibility** tab, control which APIs are discoverable (visible) to API Center portal users. Visibility settings apply to all users of the API Center portal. |
| 47 | + |
| 48 | +The API Center portal uses the [Azure API Center data plane API](/rest/api/dataplane/apicenter/operation-groups) to retrieve and display APIs in your API center, and by default shows all APIs for signed-in users with Azure RBAC permissions. |
| 49 | + |
| 50 | +To make only specific APIs visible, add filter conditions for APIs based on built-in properties. For instance, choose to display APIs only of certain types (like REST or GraphQL) or based on certain specification formats (such as OpenAPI). |
| 51 | + |
| 52 | +:::image type="content" source="media/customize-api-center-portal/add-visibility-condition.png" alt-text="Screenshot of adding API visibility conditions in the portal."::: |
| 53 | + |
| 54 | +## Anonymous access |
| 55 | + |
| 56 | +On the **API visibility** tab, optionally enable anonymous read access to the [Azure API Center data plane API](/rest/api/dataplane/apicenter/operation-groups), which allows unauthenticated users to discover the API inventory by direct API calls. For example, enable this setting to make APIs discoverable to unauthenticated users when you [self-host](self-host-api-center-portal.md) the API Center portal. |
| 57 | + |
| 58 | +> [!CAUTION] |
| 59 | +> When enabling anonymous access, take care not to expose sensitive information in API definitions or settings. |
| 60 | +
|
| 61 | +## Semantic search |
| 62 | + |
| 63 | +If enabled on the **Semantic search** tab, the API Center portal supplements basic name-based API search with AI-assisted *semantic search* built on API names, descriptions, and optionally custom metadata. Semantic search is available in the **Standard** plan only. |
| 64 | + |
| 65 | +Users can search for APIs using natural language queries, making it easier to find APIs based on their intent. For example, if a developer searches for "I need an API for inventory management," the portal can suggest relevant APIs, even if the API names or descriptions don't include those exact words. |
| 66 | + |
| 67 | +> [!TIP] |
| 68 | +> When using the **Free** plan of Azure API Center, you can [upgrade easily](frequently-asked-questions.yml#how-do-i-upgrade-my-api-center-from-the-free-plan-to-the-standard-plan) to the **Standard** plan to enable full service features including semantic search in the API Center portal. |
| 69 | +
|
| 70 | +To use AI-assisted search when signed in to the API Center portal, click in the search box, select **Search with AI**, and enter a query. |
| 71 | + |
| 72 | +:::image type="content" source="media/customize-api-center-portal/semantic-search.png" alt-text="Screenshot of semantic search results in API Center portal."::: |
| 73 | + |
| 74 | +## Custom metadata |
| 75 | + |
| 76 | +On the **Metadata** tab, optionally select [custom metadata](metadata.md) properties that you want to expose in API details and semantic search. |
| 77 | + |
| 78 | +## Enable access to test console for APIs |
| 79 | + |
| 80 | +You can configure user settings to granularly authorize access to APIs and their specific versions in your API center. For example, configure certain API versions to use API keys for authentication, and create an access policy that permits only specific users to authenticate using those keys. |
| 81 | + |
| 82 | +Access policies also apply to the "Try this API" capability for APIs in the API Center portal, ensuring that only portal users with the appropriate access policy can use the test console for those API versions. [Learn more about authorizing access to APIs](authorize-api-access.md) |
| 83 | + |
| 84 | +## Related content |
| 85 | + |
| 86 | +* [Set up the API Center portal](set-up-api-center-portal.md) |
| 87 | +* [Enable and view Azure API Center portal in Visual Studio Code](enable-api-center-portal-vs-code-extension.md) |
| 88 | +* [Self-host the API Center portal](self-host-api-center-portal.md) |
| 89 | + |
0 commit comments