Check integration status and settings

You're viewing Apigee Edge documentation.
Go to the Apigee X documentation. info

After enabling API Hub connector integration, you can verify its status and review the configured settings.

Checking API Hub connector integration status

To check the current status of API Hub connector integration for an organization, make a GET request to the Edge management API:

curl -X GET https://api.enterprise.apigee.com/v1/organizations/ORG_NAME uapim/status \
  -H "Authorization: Bearer OAUTH_TOKEN

For OAuth, enter the following in the Key field: Bearer your-token (For more information, see Get the tokens).

This step requires orgadmin permission within the respective Apigee Edge organization to perform this operation.

A successful response will look like this:

  {
    "status": "running",
    "lastUpdated": "04-16-2025 00:56:45"
  }

"status": "running" indicates that the API Hub connector integration integration is active and data synchronization is in progress.

"lastUpdated" shows the timestamp of the last status update.

To retrieve the API Hub connector integration settings for an organization, make a GET request to the Edge management API:

curl -X GET https://api.enterprise.apigee.com/v1/organizations/ORG_NAME uapim/settings \
  -H "Authorization: Bearer OAUTH_TOKEN"

For OAuth, enter the following in the Key field: Bearer your-token (For more information, see Get the tokens).

This step requires orgadmin permission within the respective Apigee Edge organization to perform this operation.

A successful response will look like this:

  {
    "enabled": true,
    "gatewayId": "INSTANCE_RESOURCE_NAME"
  }

"enabled": true confirms that API Hub connector integration is activated for the organization.

"gatewayId" displays the Instance Resource Name to which this Apigee Edge organization is connected.