Stay organized with collections
Save and categorize content based on your preferences.
This page
applies to Apigee and Apigee hybrid.
This page describes how to view, analyze, and stop collecting API observations and API operations data in API hub
Before you begin
To manage API observations in API hub, make sure that you have the required IAM roles and permissions. For more information, see IAM roles and permissions.
PROJECT_ID: The name of your API hub host project. The host project was selected
when API hub was provisioned.
LOCATION: The location of the host project. The location was chosen when API
hub was provisioned.
OBSERVATION_ID: The ID of the discovered API observation.
OPERATION_ID: The ID of the API operation.
Stop collecting API observations in API hub
Stopping the collection of API observations in API hub temporarily stops the ingestion of new data. This operation doesn't delete the existing data that is already ingested in API hub. You can stop collecting API observations data in API hub using any of the following methods:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-26 UTC."],[],[],null,["# Manage API observations in API hub\n\n*This page\napplies to **Apigee** and **Apigee hybrid**.*\n|\n| **Preview\n| --- Shadow API Discovery in API hub**\n|\n|\n| This feature is subject to the \"Pre-GA Offerings Terms\" in the General Service Terms section\n| of the [Service Specific Terms](/terms/service-terms#1).\n|\n| Pre-GA features are available \"as is\" and might have limited support.\n|\n| For more information, see the\n| [launch stage descriptions](/products#product-launch-stages).\n\n\nThis page describes how to view, analyze, and stop collecting API observations and API operations data in API hub\n\nBefore you begin\n----------------\n\n\nTo manage API observations in API hub, make sure that you have the required IAM roles and permissions. For more information, see [IAM roles and permissions](/apigee/docs/apihub/api-observation-overview#iam-roles-permissions).\n\nView discovered API observations in API hub\n-------------------------------------------\n\nYou can view or list all the [discovered API observations](/apigee/docs/apihub/api-observation-overview#discovered-api-observations) using the Google Cloud console or the APIM API. \n\n### Console\n\nTo view discovered API observations, do the following:\n\n1. In the Google Cloud console, go to the **API hub** page.\n\n [Go to API hub](https://console.cloud.google.com/apigee/api-hub)\n2. Click **API observations** from the left navigation menu to open the **API observations** page.\n3. The **API observations** page displays all the discovered API observations in your API ecosystem.\n\n### REST\n\nTo list all the discovered API observations using the `DiscoveredApiObservations` API, use the following API call: \n\n```\ncurl -X GET \\\n -H \"Authorization: Bearer $(gcloud auth print-access-token)\" \\\n\"https://apihub.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/discoveredApiObservations\"\n```\n\nReplace the following:\n\n- \u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e: The name of your API hub host project. The host project was selected when API hub was provisioned.\n- \u003cvar translate=\"no\"\u003eLOCATION\u003c/var\u003e: The location of the host project. The location was chosen when API hub was provisioned.\n\nAnalyze discovered API observations in API hub\n----------------------------------------------\n\n\nYou can analyze a specific discovered API observation to examine the individual API operations and associated metadata of the observation. \n\n### Console\n\nTo analyze a specific discovered API observation, do the following:\n\n1. In the Google Cloud console, go to the **API hub** page.\n\n [Go to API hub](https://console.cloud.google.com/apigee/api-hub)\n2. Click **API observations** from the left navigation menu to open the **API observations** page.\n3. Click the **Host name** of the discovered API observation that you want to analyze.\n\n\n The observation details page appears displaying the associated API metadata and API operations collected by API hub.\n\n### API operation details\n\n\nThe API operation details section displays the following information:\n\n- **Path**: the HTTP request path for the API operation.\n- **Method**: the HTTP request method string.\n- **Count**: the total number of times API observations in API hub observed this operation.\n- **Observation** : indicates if the API is **Known** or **Unknown** . You can click the observation to view its complete resource definition in API hub. **Known API:** APIs that are [registered](/apigee/docs/apihub/quickstart-api) with API hub.\n |\n |\n | **Unknown API:** APIs that are detected by API observations but are not registered with API hub.\n- **Transaction Request**: lists the key value pairs of the request headers and their count.\n- **Transaction Response Headers**: lists the key value pairs of response headers and their count.\n- **Transaction Response Codes**: lists the key value pairs of response codes and their count.\n- **First Seen**: the timestamp when the API operation was first observed.\n- **Last Seen**: The timestamp when this API operation was last .\n\n### REST\n\nTo analyze a specific discovered API observation, do the following:\n\n- To retrieve detailed information for a specific discovered API observation, use the following API call: \n\n ```\n curl -X GET \\\n -H \"Authorization: Bearer $(gcloud auth print-access-token)\" \\\n \"https://apihub.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/discoveredApiObservations/OBSERVATION_ID\n \n ```\n\n Replace the following:\n - \u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e: The name of your API hub host project. The host project was selected when API hub was provisioned.\n - \u003cvar translate=\"no\"\u003eLOCATION\u003c/var\u003e: The location of the host project. The location was chosen when API hub was provisioned.\n - \u003cvar translate=\"no\"\u003eOBSERVATION_ID\u003c/var\u003e: The ID of the discovered API observation.\n- To retrieve a list of all the API operations in a specific discovered API observation, use the following API call: \n\n ```\n curl -X GET \\\n -H \"Authorization: Bearer $(gcloud auth print-access-token)\" \\\n \"https://apihub.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/discoveredApiObservations/OBSERVATION_ID/discoveredApiOperations\"\n \n ```\n\n Replace the following:\n - \u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e: The name of your API hub host project. The host project was selected when API hub was provisioned.\n - \u003cvar translate=\"no\"\u003eLOCATION\u003c/var\u003e: The location of the host project. The location was chosen when API hub was provisioned.\n - \u003cvar translate=\"no\"\u003eOBSERVATION_ID\u003c/var\u003e: The ID of the discovered API observation.\n- To retrieve detailed information for a specific API operation, use the following API call: \n\n ```\n curl -X GET \\\n -H \"Authorization: Bearer $(gcloud auth print-access-token)\" \\\n \"https://apihub.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/discoveredApiObservations/OBSERVATION_ID/discoveredApiOperations/OPERATION_ID\"\n \n ```\n\n Replace the following:\n - \u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e: The name of your API hub host project. The host project was selected when API hub was provisioned.\n - \u003cvar translate=\"no\"\u003eLOCATION\u003c/var\u003e: The location of the host project. The location was chosen when API hub was provisioned.\n - \u003cvar translate=\"no\"\u003eOBSERVATION_ID\u003c/var\u003e: The ID of the discovered API observation.\n - \u003cvar translate=\"no\"\u003eOPERATION_ID\u003c/var\u003e: The ID of the API operation.\n\nStop collecting API observations in API hub\n-------------------------------------------\n\n\nStopping the collection of API observations in API hub temporarily stops the ingestion of new data. This operation doesn't delete the existing data that is already ingested in API hub. You can stop collecting API observations data in API hub using any of the following methods:\n\n- [Detach runtime project](/apigee/docs/apihub/auto-register-apigee-proxies#detach-a-runtime-project) from API hub.\n- [Edit project association settings](/apigee/docs/apihub/auto-register-apigee-proxies#edit-project-association-settings) to deselect the **Apigee API Observation** import configuration. **Important:** Deselecting the **Apigee API Observation** import configuration doesn't automatically disable or delete any Apigee API observation jobs from the Apigee runtime projects. This also means that the underlying Shadow API Discovery job will continue to run and incur charges in Apigee. You must disable any Apigee API observation jobs manually in Apigee runtime projects to avoid this. Disabling a job preserves its results, while deleting it removes both the job and its associated observation results.\n- [Delete the associated plugin instance](/apigee/docs/apihub/manage-plugin-instances#delete-plugin-instance) from API hub.\n\n\u003cbr /\u003e\n\nConsiderations\n--------------\n\n\nThe following considerations apply when managing API observation data in API hub:\n\n- When you stop collecting API observations in API hub, the data that has already been collected is not deleted.\n\n\u003cbr /\u003e"]]
API observations from the left navigation menu to open the API observations page.