API Governance Experience API

The API Governance Experience API provides a way to interact with API Governance. Review API Governance documentation in: https://docs.mulesoft.com/api-governance/

All requests and responses are filtered according to the users access level.

1 - General headers

For every request, send the following headers, which you can get from authenticating against Core Services:

-H 'Authorization: Bearer '

-H 'x-organization-id: '

-H 'x-owner-id: '

2 - Working with Profiles

To create and list profiles available for the user, use the /profile endpoint.

To update, delete, and obtain details for a specific profile, use the /profile/{profileId} endpoint.

3 - Obtaining stats

To obtain stats for the organization and any API, use the /organization and /organization/targets/{orgId}/{groupId}/{assetId} endpoints.

To obtain stats for a specific profile of the organization and participating APIs, use the /organization/profile/{profileId} and /organization/profile/{profileId}/{orgId}/{groupId}/{assetId} endpoints.

4 - Other endpoints

4.1 Conformance

To obtain conformance details for a specific API, use the /conformance/status endpoint. This provides information about the conformance status for the API based on the centralized governance configuration. Details include the conformance as a whole and for each ruleset. If the user has only read access, details are included only for conformant APIs. If the user has write access for the API, nonconformant information is also provided.

4.2 Explain endpoints

The explain endpoints provide information about the rulesets that apply to a specific API and the criteria that made this asset a match.

To obtain information about an asset that has already been published, use the /plan/explain/{group}/{asset}/{version} endpoint.

To determine the rulesets that would be applied to an API by centralized governance, use the /plan/explain/ endpoint with criteria sent as the body.