From 9e3f2b5ba335c0760405a03e50cb61d9f3c2afac Mon Sep 17 00:00:00 2001 From: Mariano de Achaval Date: Fri, 24 Apr 2026 17:23:18 -0300 Subject: [PATCH 1/2] Omni api onboarding --- apis/omni-xapi/api.yaml | 6701 ++++++++++++++++++++++++++++++++++ apis/omni-xapi/exchange.json | 14 + 2 files changed, 6715 insertions(+) create mode 100644 apis/omni-xapi/api.yaml create mode 100644 apis/omni-xapi/exchange.json diff --git a/apis/omni-xapi/api.yaml b/apis/omni-xapi/api.yaml new file mode 100644 index 00000000..bb681b21 --- /dev/null +++ b/apis/omni-xapi/api.yaml @@ -0,0 +1,6701 @@ +components: + securitySchemes: + bearerAuth: + type: http + scheme: bearer + bearerFormat: JWT + description: Bearer token authentication for API access. + clientAuth: + type: http + scheme: bearer + description: Client credentials authentication token. + schemas: + ApplyApigeePolicyRequest: + description: Request to apply a policy template to an Apigee API proxy revision. + properties: + api_name: + title: Api Name + type: string + configuration_data: + additionalProperties: true + default: + {} + title: Configuration Data + type: object + direction: + default: inbound + title: Direction + type: string + endpoint_name: + default: default + title: Endpoint Name + type: string + organization: + title: Organization + type: string + revision: + title: Revision + type: string + template_id: + title: Template Id + type: string + required: + - organization + - api_name + - revision + - template_id + title: ApplyApigeePolicyRequest + type: object + ApplyPluginRequest: + description: Request to apply a Kong plugin to a gateway service. + properties: + config: + additionalProperties: true + title: Config + type: object + enabled: + default: true + title: Enabled + type: boolean + gateway_id: + title: Gateway Id + type: string + plugin_name: + title: Plugin Name + type: string + protocols: + anyOf: + - + items: + type: string + type: array + - + type: "null" + title: Protocols + service_id: + anyOf: + - + type: string + - + type: "null" + title: Service Id + required: + - gateway_id + - plugin_name + - config + title: ApplyPluginRequest + type: object + AssetSearchAggregatesRequest: + description: Flags controlling which aggregate facets to include in search results. + properties: + activeVersionAssetCount: + default: false + title: Activeversionassetcount + type: boolean + byApiCategory: + default: false + title: Byapicategory + type: boolean + byProvider: + default: false + title: Byprovider + type: boolean + byStatus: + default: false + title: Bystatus + type: boolean + byType: + default: false + title: Bytype + type: boolean + totalHits: + default: false + title: Totalhits + type: boolean + uniqueAssets: + default: false + title: Uniqueassets + type: boolean + title: AssetSearchAggregatesRequest + type: object + AssetSearchFilters: + description: Optional filters to narrow an Exchange asset search. + properties: + apiCategoryIn: + anyOf: + - + items: + type: string + type: array + - + type: "null" + title: Apicategoryin + hasActiveInstance: + anyOf: + - + type: boolean + - + type: "null" + title: Hasactiveinstance + hasActiveVersion: + anyOf: + - + type: boolean + - + type: "null" + title: Hasactiveversion + hasInstances: + anyOf: + - + type: boolean + - + type: "null" + title: Hasinstances + providerIn: + anyOf: + - + items: + type: string + type: array + - + type: "null" + title: Providerin + statusIn: + anyOf: + - + items: + type: string + type: array + - + type: "null" + title: Statusin + title: AssetSearchFilters + type: object + AssetSearchRequest: + description: Request to search Exchange assets by type, query, filters, and aggregates. + properties: + aggregates: + anyOf: + - + $ref: "#/components/schemas/AssetSearchAggregatesRequest" + - + type: "null" + assetTypes: + anyOf: + - + type: string + - + items: + type: string + type: array + - + type: "null" + title: Assettypes + enrich: + default: false + title: Enrich + type: boolean + filters: + anyOf: + - + $ref: "#/components/schemas/AssetSearchFilters" + - + type: "null" + includeAffordances: + anyOf: + - + type: boolean + - + type: "null" + title: Includeaffordances + organizationId: + anyOf: + - + type: string + - + items: + type: string + type: array + title: Organizationid + providers: + anyOf: + - + items: + type: string + type: array + - + type: "null" + title: Providers + q: + anyOf: + - + type: string + - + type: "null" + title: Q + size: + default: 500 + title: Size + type: integer + required: + - organizationId + title: AssetSearchRequest + type: object + Body_uploadZipToRegistryApiRegistryUploadPost: + properties: + apiVersion: + default: v1 + title: Apiversion + type: string + dryRun: + default: false + title: Dryrun + type: boolean + file: + format: binary + title: File + type: string + organizationId: + title: Organizationid + type: string + resourceId: + default: "" + title: Resourceid + type: string + required: + - file + - organizationId + title: Body_uploadZipToRegistryApiRegistryUploadPost + type: object + ConnectApigeeGatewayRequest: + description: Request to register an Apigee API proxy as a connected gateway. + properties: + api_name: + title: Api Name + type: string + organization: + title: Organization + type: string + required: + - organization + - api_name + title: ConnectApigeeGatewayRequest + type: object + ConnectGatewayRequest: + description: Request to connect or register a standalone gateway by its ID. + properties: + gateway_id: + title: Gateway Id + type: string + required: + - gateway_id + title: ConnectGatewayRequest + type: object + ConnectKongRequest: + description: Request to register a Kong control plane as a connected gateway. + properties: + auth_token: + title: Auth Token + type: string + region: + default: us + title: Region + type: string + required: + - auth_token + title: ConnectKongRequest + type: object + CreateExternalInstanceRequest: + description: Request to create an external (unmanaged) instance for an Exchange asset. + properties: + assetId: + title: Assetid + type: string + endpointUri: + title: Endpointuri + type: string + isPublic: + default: true + title: Ispublic + type: boolean + name: + title: Name + type: string + organizationId: + title: Organizationid + type: string + versionGroup: + title: Versiongroup + type: string + required: + - organizationId + - assetId + - versionGroup + - name + - endpointUri + title: CreateExternalInstanceRequest + type: object + DeleteAssetRequest: + description: Request to delete an asset version from Anypoint Exchange. + properties: + allowGavReusable: + default: false + title: Allowgavreusable + type: boolean + assetId: + title: Assetid + type: string + groupId: + title: Groupid + type: string + version: + title: Version + type: string + required: + - groupId + - assetId + - version + title: DeleteAssetRequest + type: object + DeleteExternalInstanceRequest: + description: Request to delete an external (unmanaged) instance from an Exchange asset. + properties: + assetId: + title: Assetid + type: string + instanceId: + title: Instanceid + type: string + organizationId: + title: Organizationid + type: string + versionGroup: + title: Versiongroup + type: string + required: + - organizationId + - assetId + - versionGroup + - instanceId + title: DeleteExternalInstanceRequest + type: object + GovernanceAgenticRequest: + description: Payload for governance agentic actions (explain, review, maturity). + properties: + orgId: + title: Orgid + type: string + payload: + additionalProperties: true + title: Payload + type: object + required: + - orgId + - payload + title: GovernanceAgenticRequest + type: object + GovernanceInsightsJobRequest: + description: Request to start a governance insights analysis job. + properties: + orgId: + title: Orgid + type: string + required: + - orgId + title: GovernanceInsightsJobRequest + type: object + HTTPValidationError: + description: Wrapper returned when request validation fails (HTTP 422). + properties: + detail: + items: + $ref: "#/components/schemas/ValidationError" + title: Detail + type: array + title: HTTPValidationError + type: object + ListProxiesRequest: + description: Request to list API proxies in an Apigee organization. + properties: + organization: + title: Organization + type: string + required: + - organization + title: ListProxiesRequest + type: object + MonitoringOmniCardRequest: + description: Request to generate an agentic insight card summarizing monitoring data. + properties: + environment: + default: sandbox + enum: + - production + - sandbox + - development + title: Environment + type: string + orgId: + anyOf: + - + type: string + - + type: "null" + title: Orgid + prompt: + title: Prompt + type: string + timeRange: + default: 7d + enum: + - 1h + - 6h + - 24h + - 7d + - 30d + title: Timerange + type: string + required: + - prompt + title: MonitoringOmniCardRequest + type: object + SlackOAuthStartResponse: + description: Response with OAuth authorization URL. + example: + oauth_url: Oauth Url + state_id: State Id + properties: + oauth_url: + description: Slack authorization URL to redirect user to + title: Oauth Url + type: string + state_id: + description: State ID for CSRF protection + title: State Id + type: string + required: + - oauth_url + - state_id + title: SlackOAuthStartResponse + type: object + TestConnectionRequest: + description: Credentials payload to test connectivity to an Apigee organization. + properties: + service_account_json: + title: Service Account Json + type: string + required: + - service_account_json + title: TestConnectionRequest + type: object + TestKongConnectionRequest: + description: Credentials payload to test connectivity to a Kong control plane. + properties: + auth_token: + title: Auth Token + type: string + region: + default: us + title: Region + type: string + required: + - auth_token + title: TestKongConnectionRequest + type: object + TestMcpConnectionRequest: + description: Request to test connectivity to a remote MCP server URL. + properties: + headers: + anyOf: + - + additionalProperties: + type: string + type: object + - + type: "null" + title: Headers + organizationId: + title: Organizationid + type: string + timeoutMs: + default: 10000 + title: Timeoutms + type: integer + url: + title: Url + type: string + required: + - organizationId + - url + title: TestMcpConnectionRequest + type: object + ValidationError: + description: Individual field-level validation error detail. + properties: + ctx: + title: Context + type: object + input: + title: Input + loc: + items: + anyOf: + - + type: string + - + type: integer + title: Location + type: array + msg: + title: Message + type: string + type: + title: Error Type + type: string + required: + - loc + - msg + - type + title: ValidationError + type: object +info: + contact: + name: MuleSoft Omni Team + url: https://github.com/mulesoft/mulesoft-omni-app + description: Backend API for MuleSoft Omni — the unified Anypoint management and agent interface. + title: MuleSoft Omni Backend API + version: 0.1.0 +openapi: 3.1.0 +servers: + - url: https://omni.mulesoft.com/ + description: The production MuleSoft Omni API server +security: +- bearerAuth: [] +- clientAuth: [] +paths: + /.well-known/oauth-protected-resource: + get: + description: RFC 9728 Protected Resource Metadata — advertises the Anypoint authorization server. + operationId: oauthProtectedResourceWellKnownOauthProtectedResourceGet + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: Oauth Protected Resource + tags: + - Well-Known + /api/agent/call-tool: + post: + description: Invoke an MCP tool by name and return its result. + operationId: callMcpToolApiAgentCallToolPost + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: Call Mcp Tool + tags: + - Agent + /api/agent/chat: + post: + description: Start or continue a streaming agent chat conversation. + operationId: chatApiAgentChatPost + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: Chat + tags: + - Agent + /api/agent/chat/plain: + post: + description: Send a plain (non-streaming) agent chat message. + operationId: chatPlainApiAgentChatPlainPost + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: Chat Plain + tags: + - Agent + /api/agent/chat/resume: + post: + description: Resume a paused agent chat conversation with tool confirmation. + operationId: resumeChatApiAgentChatResumePost + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: Resume Chat + tags: + - Agent + /api/agent/ui-app: + get: + description: Serve a UI application resource by its ui:// URI. + operationId: serveUiAppApiAgentUiAppGet + parameters: + - + description: The ui:// resource URI + in: query + name: uri + required: true + schema: + description: The ui:// resource URI + title: Uri + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Serve Ui App + tags: + - Agent + /api/api-instances/client-providers: + get: + description: List client identity providers for an environment. + operationId: getClientProvidersApiApiInstancesClientProvidersGet + parameters: + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + - + description: Target environment ID + in: query + name: environmentId + required: true + schema: + description: Target environment ID + title: Environmentid + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Client Providers + tags: + - API Instances + /api/api-instances/create: + post: + description: Create a new API instance in API Manager. + operationId: createApiInstanceEndpointApiApiInstancesCreatePost + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: Create Api Instance Endpoint + tags: + - API Instances + /api/api-instances/delete: + delete: + description: Delete an API instance from API Manager. + operationId: deleteApiInstanceEndpointApiApiInstancesDeleteDelete + parameters: + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + - + description: Environment containing the instance + in: query + name: environmentId + required: true + schema: + description: Environment containing the instance + title: Environmentid + type: string + - + description: API instance ID to delete + in: query + name: apiInstanceId + required: true + schema: + description: API instance ID to delete + title: Apiinstanceid + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Delete Api Instance Endpoint + tags: + - API Instances + /api/api-instances/exchange-search: + post: + description: Search Exchange assets by term and type for instance creation. + operationId: exchangeSearchApiApiInstancesExchangeSearchPost + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: Exchange Search + tags: + - API Instances + /api/api-instances/gateway-targets: + get: + description: List managed gateway targets for an environment. + operationId: getGatewayTargetsApiApiInstancesGatewayTargetsGet + parameters: + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + - + description: Target environment ID + in: query + name: environmentId + required: true + schema: + description: Target environment ID + title: Environmentid + type: string + - + description: Zero-based page index + in: query + name: pageNumber + required: false + schema: + default: 0 + description: Zero-based page index + title: Pagenumber + type: integer + - + description: Number of targets per page + in: query + name: pageSize + required: false + schema: + default: 20 + description: Number of targets per page + title: Pagesize + type: integer + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Gateway Targets + tags: + - API Instances + /api/api-instances/governance-report: + get: + description: Retrieve the governance conformance report for an Exchange asset version. + operationId: governanceReportEndpointApiApiInstancesGovernanceReportGet + parameters: + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + - + description: Exchange group ID (organization ID) + in: query + name: groupId + required: true + schema: + description: Exchange group ID (organization ID) + title: Groupid + type: string + - + description: Exchange asset identifier + in: query + name: assetId + required: true + schema: + description: Exchange asset identifier + title: Assetid + type: string + - + description: Semantic version of the asset + in: query + name: version + required: true + schema: + description: Semantic version of the asset + title: Version + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Governance Report Endpoint + tags: + - API Instances + /api/api-instances/validate-base-path: + get: + description: Validate that an API base path is available on a gateway target. + operationId: validateBasePathEndpointApiApiInstancesValidateBasePathGet + parameters: + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + - + description: Target environment ID + in: query + name: environmentId + required: true + schema: + description: Target environment ID + title: Environmentid + type: string + - + description: Gateway target ID to validate against + in: query + name: targetId + required: true + schema: + description: Gateway target ID to validate against + title: Targetid + type: string + - + description: Listener port on the gateway target + in: query + name: port + required: false + schema: + default: 8081 + description: Listener port on the gateway target + title: Port + type: integer + - + description: Base path to validate for uniqueness + in: query + name: path + required: true + schema: + description: Base path to validate for uniqueness + title: Path + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Validate Base Path Endpoint + tags: + - API Instances + /api/apigee/connected-gateways: + get: + description: Return all Apigee gateways that have been registered in this session. + operationId: getApigeeConnectedGatewaysApiApigeeConnectedGatewaysGet + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: Get Apigee Connected Gateways + tags: + - Apigee + /api/apigee/gateways: + post: + description: List API proxies (gateways) in the given Apigee organization. + operationId: listApigeeGatewaysApiApigeeGatewaysPost + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/ListProxiesRequest" + description: Request to list API proxies in an Apigee organization. + required: true + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: List Apigee Gateways + tags: + - Apigee + /api/apigee/gateways/connect: + post: + description: Verify an Apigee proxy exists and register it as a connected gateway. + operationId: connectApigeeGatewayApiApigeeGatewaysConnectPost + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/ConnectApigeeGatewayRequest" + description: Request to register an Apigee API proxy as a connected gateway. + required: true + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Connect Apigee Gateway + tags: + - Apigee + /api/apigee/organizations: + post: + description: Validate a GCP service-account JSON key and return the Apigee organizations it can access. + operationId: testApigeeConnectionApiApigeeOrganizationsPost + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/TestConnectionRequest" + description: Credentials payload to test connectivity to an Apigee organization. + required: true + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Test Apigee Connection + tags: + - Apigee + /api/apigee/policies/apply: + post: + description: Inject a policy into an Apigee proxy revision bundle, import it, and optionally deploy. + operationId: applyApigeePolicyApiApigeePoliciesApplyPost + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/ApplyApigeePolicyRequest" + description: Request to apply a policy template to an Apigee API proxy revision. + required: true + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Apply Apigee Policy + tags: + - Apigee + /api/apigee/policy-templates: + get: + description: Return the catalog of bundled Apigee policy templates. + operationId: listApigeePolicyTemplatesApiApigeePolicyTemplatesGet + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: List Apigee Policy Templates + tags: + - Apigee + /api/apigee/policy-templates/{template_id}: + get: + description: Return a single Apigee policy template by its identifier, including its XSD schema. + operationId: getApigeePolicyTemplateApiApigeePolicyTemplatesTemplateIdGet + parameters: + - + description: Unique identifier of the Apigee policy template + in: path + name: template_id + required: true + schema: + description: Unique identifier of the Apigee policy template + title: Template Id + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Apigee Policy Template + tags: + - Apigee + /api/assets/create: + post: + description: |- + Create an Agent, MCP, or API asset in Anypoint Exchange. + + Accepts either application/json or multipart/form-data. + When multipart, JSON files (agent card, MCP schema) are sent as binary file parts. + Uses Exchange API v2 POST multipart/form-data: + - Agent: type=agent, status, properties.protocol=a2a, properties.platform + - MCP: type=mcp, status, properties.platform + - API: type=, status, properties.apiVersion, optional properties.mainFile/properties.url/properties.assetLink + - Optional: files.a2a-card.json (Agent A2A), files.other-card.json (Agent other), files.mcp-metadata.json (MCP) + operationId: createAssetEndpointApiAssetsCreatePost + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: Create Asset Endpoint + tags: + - Assets + /api/assets/delete: + post: + description: |- + Delete an asset version in Anypoint Exchange. + + Checks deletion permission first via GET .../settings?settings=deletionSettings. + Only proceeds if hardDeletionEnabled is true. + + Uses Exchange API v2: + DELETE /api/v2/assets/:groupId/:assetId/:version + x-delete-type: soft-delete (default) | hard-delete (when allowGavReusable) + operationId: deleteAssetEndpointApiAssetsDeletePost + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteAssetRequest" + description: Request to delete an asset version from Anypoint Exchange. + required: true + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Delete Asset Endpoint + tags: + - Assets + /api/assets/external-instance: + delete: + description: |- + Delete an external (unmanaged) instance from an Exchange asset. + + Proxies to DELETE /api/v2/assets/{orgId}/{assetId}/versionGroups/{versionGroup}/instances/external/{instanceId}. + operationId: deleteExternalInstanceEndpointApiAssetsExternalInstanceDelete + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteExternalInstanceRequest" + description: Request to delete an external (unmanaged) instance from an Exchange asset. + required: true + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Delete External Instance Endpoint + tags: + - Assets + post: + description: |- + Create an external (unmanaged) instance for an Exchange asset. + + Proxies to POST /api/v2/assets/{orgId}/{assetId}/versionGroups/{versionGroup}/instances/external + with body {"name": "...", "endpointUri": "...", "isPublic": true}. + operationId: createExternalInstanceEndpointApiAssetsExternalInstancePost + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/CreateExternalInstanceRequest" + description: Request to create an external (unmanaged) instance for an Exchange asset. + required: true + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Create External Instance Endpoint + tags: + - Assets + /api/assets/global-search: + post: + description: Cross-type global search across all Exchange assets using a free-text query. + operationId: searchAssetsGlobalEndpointApiAssetsGlobalSearchPost + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/AssetSearchRequest" + description: Request to search Exchange assets by type, query, filters, and aggregates. + required: true + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Search Assets Global Endpoint + tags: + - Assets + /api/assets/mcp-instance-tools: + post: + description: List tools from a live MCP server instance via Exchange API. + operationId: fetchMcpInstanceToolsEndpointApiAssetsMcpInstanceToolsPost + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: Fetch Mcp Instance Tools Endpoint + tags: + - Assets + /api/assets/publication/status: + get: + description: |- + Get asset publication status from Anypoint Exchange. + + Poll this after async create to wait until status is "running" or "completed". + operationId: getPublicationStatusEndpointApiAssetsPublicationStatusGet + parameters: + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + - + description: Exchange group ID (organization ID) + in: query + name: groupId + required: true + schema: + description: Exchange group ID (organization ID) + title: Groupid + type: string + - + description: Exchange asset identifier + in: query + name: assetId + required: true + schema: + description: Exchange asset identifier + title: Assetid + type: string + - + description: Semantic version of the asset + in: query + name: version + required: true + schema: + description: Semantic version of the asset + title: Version + type: string + - + description: Publication job ID to poll + in: query + name: publicationId + required: true + schema: + description: Publication job ID to poll + title: Publicationid + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Publication Status Endpoint + tags: + - Assets + /api/assets/search: + post: + description: Search Exchange assets by type, free-text query, filters, and optional aggregates. + operationId: searchAssetsEndpointApiAssetsSearchPost + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/AssetSearchRequest" + description: Request to search Exchange assets by type, query, filters, and aggregates. + required: true + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Search Assets Endpoint + tags: + - Assets + /api/assets/test-mcp-connection: + post: + description: |- + Test MCP server connection via Anypoint Exchange assets/fetch. + + Proxies to POST .../organizations/{orgId}/assets/fetch with + body {"type":"mcp","url":"","authorization":null}. + + Returns success or error message from Exchange (e.g. "Streamable HTTP error...", + "Failed to fetch URL"). + operationId: testMcpConnectionEndpointApiAssetsTestMcpConnectionPost + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/TestMcpConnectionRequest" + description: Request to test connectivity to a remote MCP server URL. + required: true + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Test Mcp Connection Endpoint + tags: + - Assets + /api/assets/{asset_id}: + get: + description: Retrieve a single Exchange asset with its metadata, instances, and governance status. + operationId: getAssetEndpointApiAssetsAssetIdGet + parameters: + - + description: Exchange asset identifier + in: path + name: asset_id + required: true + schema: + description: Exchange asset identifier + title: Asset Id + type: string + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + - + description: Comma-separated asset type classifiers to match + in: query + name: assetTypes + required: false + schema: + anyOf: + - + items: + type: string + type: array + - + type: "null" + description: Comma-separated asset type classifiers to match + title: Assettypes + - + description: Filter by gateway providers (e.g. mulesoft, apigee, kong) + in: query + name: providers + required: false + schema: + anyOf: + - + items: + type: string + type: array + - + type: "null" + description: Filter by gateway providers (e.g. mulesoft, apigee, kong) + title: Providers + - + description: Specific semantic version; omit for latest + in: query + name: version + required: false + schema: + anyOf: + - + type: string + - + type: "null" + description: Specific semantic version; omit for latest + title: Version + - + description: API version qualifier within the asset version + in: query + name: apiVersion + required: false + schema: + anyOf: + - + type: string + - + type: "null" + description: API version qualifier within the asset version + title: Apiversion + - + description: Include enriched metadata (instances, governance) + in: query + name: enrich + required: false + schema: + default: true + description: Include enriched metadata (instances, governance) + title: Enrich + type: boolean + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Asset Endpoint + tags: + - Assets + /api/assets/{asset_id}/overview-spec: + get: + description: Return the OAS/RAML specification overview for an API asset version. + operationId: getAssetOverviewSpecEndpointApiAssetsAssetIdOverviewSpecGet + parameters: + - + description: Exchange asset identifier + in: path + name: asset_id + required: true + schema: + description: Exchange asset identifier + title: Asset Id + type: string + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + - + description: Comma-separated asset type classifiers to match + in: query + name: assetTypes + required: false + schema: + anyOf: + - + items: + type: string + type: array + - + type: "null" + description: Comma-separated asset type classifiers to match + title: Assettypes + - + description: Filter by gateway providers + in: query + name: providers + required: false + schema: + anyOf: + - + items: + type: string + type: array + - + type: "null" + description: Filter by gateway providers + title: Providers + - + description: Specific semantic version; omit for latest + in: query + name: version + required: false + schema: + anyOf: + - + type: string + - + type: "null" + description: Specific semantic version; omit for latest + title: Version + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Asset Overview Spec Endpoint + tags: + - Assets + /api/assets/{asset_id}/versions: + get: + description: List all published versions of an Exchange asset with summary details. + operationId: getAssetVersionsEndpointApiAssetsAssetIdVersionsGet + parameters: + - + description: Exchange asset identifier + in: path + name: asset_id + required: true + schema: + description: Exchange asset identifier + title: Asset Id + type: string + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + - + description: Comma-separated asset type classifiers to match + in: query + name: assetTypes + required: false + schema: + anyOf: + - + items: + type: string + type: array + - + type: "null" + description: Comma-separated asset type classifiers to match + title: Assettypes + - + description: Include enriched metadata per version + in: query + name: enrich + required: false + schema: + default: true + description: Include enriched metadata per version + title: Enrich + type: boolean + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Asset Versions Endpoint + tags: + - Assets + /api/auth/login: + post: + description: Authenticate with Anypoint using username and password. + operationId: loginApiAuthLoginPost + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: Login + tags: + - Auth + /api/auth/logout: + post: + description: Revoke the user's OAuth token on the Anypoint side. + operationId: logoutApiAuthLogoutPost + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: Logout + tags: + - Auth + /api/auth/oauth/token: + post: + description: Exchange authorization code for token using client secret (server-side, avoids CORS). + operationId: oauthTokenApiAuthOauthTokenPost + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: Oauth Token + tags: + - Auth + /api/auth/profile: + get: + description: Retrieve the authenticated user's Anypoint profile. + operationId: profileApiAuthProfileGet + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: Profile + tags: + - Auth + /api/cost-management/instances: + get: + description: List cost management instances with usage metrics. + operationId: costManagementInstancesApiCostManagementInstancesGet + parameters: + - + description: Anypoint organization ID; uses profile org when omitted + in: query + name: organizationId + required: false + schema: + anyOf: + - + type: string + - + type: "null" + description: Anypoint organization ID; uses profile org when omitted + title: Organizationid + - + description: Lookback window for cost aggregation + in: query + name: timeRange + required: false + schema: + default: 30d + description: Lookback window for cost aggregation + enum: + - 1h + - 6h + - 24h + - 7d + - 30d + title: Timerange + type: string + - + description: Bearer token from the caller's Anypoint session. The endpoint forwards this credential to upstream Anypoint services (Monitoring, API Manager, Runtime Manager); the value is not stored server-side. + in: header + name: authorization + required: false + schema: + description: Bearer token from the caller's Anypoint session. The endpoint forwards this credential to upstream Anypoint services (Monitoring, API Manager, Runtime Manager); the value is not stored server-side. + title: Authorization + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Cost Management Instances + tags: + - Cost Management + /api/cost-management/instances/{instance_id}/timeseries: + get: + description: Return cost time-series data for a specific instance. + operationId: costManagementInstanceTimeseriesApiCostManagementInstancesInstanceIdTimeseriesGet + parameters: + - + description: API instance ID to fetch cost time-series for + in: path + name: instance_id + required: true + schema: + description: API instance ID to fetch cost time-series for + title: Instance Id + type: string + - + description: Anypoint organization ID; uses profile org when omitted + in: query + name: organizationId + required: false + schema: + anyOf: + - + type: string + - + type: "null" + description: Anypoint organization ID; uses profile org when omitted + title: Organizationid + - + description: Lookback window for time-series data + in: query + name: timeRange + required: false + schema: + default: 24h + description: Lookback window for time-series data + enum: + - 1h + - 6h + - 24h + - 7d + - 30d + title: Timerange + type: string + - + description: Bearer token from the caller's Anypoint session. The endpoint forwards this credential to upstream Anypoint services (Monitoring, API Manager, Runtime Manager); the value is not stored server-side. + in: header + name: authorization + required: false + schema: + description: Bearer token from the caller's Anypoint session. The endpoint forwards this credential to upstream Anypoint services (Monitoring, API Manager, Runtime Manager); the value is not stored server-side. + title: Authorization + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Cost Management Instance Timeseries + tags: + - Cost Management + /api/cost-management/overview: + get: + description: Return the cost management overview with aggregated totals. + operationId: costManagementOverviewApiCostManagementOverviewGet + parameters: + - + description: Anypoint organization ID; uses profile org when omitted + in: query + name: organizationId + required: false + schema: + anyOf: + - + type: string + - + type: "null" + description: Anypoint organization ID; uses profile org when omitted + title: Organizationid + - + description: Lookback window for cost aggregation + in: query + name: timeRange + required: false + schema: + default: 30d + description: Lookback window for cost aggregation + enum: + - 1h + - 6h + - 24h + - 7d + - 30d + title: Timerange + type: string + - + description: Bearer token from the caller's Anypoint session. The endpoint forwards this credential to upstream Anypoint services (Monitoring, API Manager, Runtime Manager); the value is not stored server-side. + in: header + name: authorization + required: false + schema: + description: Bearer token from the caller's Anypoint session. The endpoint forwards this credential to upstream Anypoint services (Monitoring, API Manager, Runtime Manager); the value is not stored server-side. + title: Authorization + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Cost Management Overview + tags: + - Cost Management + /api/gateways/agentic/{action}: + post: + description: Build a contextual LLM prompt to explain, review, or suggest fixes for a gateway configuration. + operationId: buildGatewayAgenticPromptApiGatewaysAgenticActionPost + parameters: + - + description: "Agentic action: explain, review, or fix" + in: path + name: action + required: true + schema: + description: "Agentic action: explain, review, or fix" + title: Action + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Build Gateway Agentic Prompt + tags: + - Gateways + /api/gateways/delete: + post: + description: Delete a managed or connected gateway from the environment. + operationId: deleteGatewayApiGatewaysDeletePost + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: Delete Gateway + tags: + - Gateways + /api/gateways/detail: + get: + description: Retrieve detailed information for a specific Flex Gateway instance. + operationId: getGatewayDetailRouteApiGatewaysDetailGet + parameters: + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + - + description: Environment containing the gateway + in: query + name: environmentId + required: true + schema: + description: Environment containing the gateway + title: Environmentid + type: string + - + description: Gateway instance ID + in: query + name: gatewayId + required: true + schema: + description: Gateway instance ID + title: Gatewayid + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Gateway Detail Route + tags: + - Gateways + /api/gateways/discovery: + get: + description: Discover available Flex and connected gateways across all environments. + operationId: listDiscoveryGatewaysApiGatewaysDiscoveryGet + parameters: + - + description: Anypoint organization ID; resolved from profile when omitted + in: query + name: organizationId + required: false + schema: + anyOf: + - + type: string + - + type: "null" + description: Anypoint organization ID; resolved from profile when omitted + title: Organizationid + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: List Discovery Gateways + tags: + - Gateways + /api/gateways/environments: + get: + description: List environments that contain gateway deployments for the organization. + operationId: listGatewayEnvironmentsApiGatewaysEnvironmentsGet + parameters: + - + description: Anypoint organization ID; resolved from profile when omitted + in: query + name: organizationId + required: false + schema: + anyOf: + - + type: string + - + type: "null" + description: Anypoint organization ID; resolved from profile when omitted + title: Organizationid + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: List Gateway Environments + tags: + - Gateways + /api/gateways/managed: + post: + description: Provision a new Flex Gateway after governance validation of the configuration. + operationId: createManagedGatewayApiGatewaysManagedPost + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: Create Managed Gateway + tags: + - Gateways + /api/gateways/runtime-configuration-schema: + get: + description: Return the JSON schema that describes valid runtime-configuration for a gateway kind and version. + operationId: getGatewayRuntimeConfigurationSchemaApiGatewaysRuntimeConfigurationSchemaGet + parameters: + - + description: Gateway kind (e.g. flex-gateway) + in: query + name: kind + required: true + schema: + description: Gateway kind (e.g. flex-gateway) + title: Kind + type: string + - + description: Gateway version to fetch the schema for + in: query + name: version + required: true + schema: + description: Gateway version to fetch the schema for + title: Version + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Gateway Runtime Configuration Schema + tags: + - Gateways + /api/gateways/target-domains: + get: + description: List upstream domains routed through a specific gateway target. + operationId: listGatewayTargetDomainsApiGatewaysTargetDomainsGet + parameters: + - + description: Anypoint organization ID; resolved from profile when omitted + in: query + name: organizationId + required: false + schema: + anyOf: + - + type: string + - + type: "null" + description: Anypoint organization ID; resolved from profile when omitted + title: Organizationid + - + description: Environment to scope the query to + in: query + name: environmentId + required: false + schema: + anyOf: + - + type: string + - + type: "null" + description: Environment to scope the query to + title: Environmentid + - + description: Gateway target ID to query domains for + in: query + name: targetId + required: false + schema: + anyOf: + - + type: string + - + type: "null" + description: Gateway target ID to query domains for + title: Targetid + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: List Gateway Target Domains + tags: + - Gateways + /api/gateways/targets: + get: + description: List runtime deployment targets (Flex replicas) within an environment. + operationId: listGatewayTargetsApiGatewaysTargetsGet + parameters: + - + description: Anypoint organization ID; resolved from profile when omitted + in: query + name: organizationId + required: false + schema: + anyOf: + - + type: string + - + type: "null" + description: Anypoint organization ID; resolved from profile when omitted + title: Organizationid + - + description: Environment to scope targets to + in: query + name: environmentId + required: false + schema: + anyOf: + - + type: string + - + type: "null" + description: Environment to scope targets to + title: Environmentid + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: List Gateway Targets + tags: + - Gateways + /api/gateways/usage-report: + get: + description: Aggregate gateway entitlement usage across the organization. + operationId: getGatewayUsageReportApiGatewaysUsageReportGet + parameters: + - + description: Anypoint organization ID; resolved from profile when omitted + in: query + name: organizationId + required: false + schema: + anyOf: + - + type: string + - + type: "null" + description: Anypoint organization ID; resolved from profile when omitted + title: Organizationid + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Gateway Usage Report + tags: + - Gateways + /api/gateways/{gateway_id}: + get: + description: Fetch gateway metadata, status, and version from the Gateway Manager xAPI. + operationId: getGatewayDetailApiGatewaysGatewayIdGet + parameters: + - + description: Composite or UUID gateway identifier + in: path + name: gateway_id + required: true + schema: + description: Composite or UUID gateway identifier + title: Gateway Id + type: string + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + - + description: Environment containing the gateway + in: query + name: environmentId + required: true + schema: + description: Environment containing the gateway + title: Environmentid + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Gateway Detail + tags: + - Gateways + /api/gateways/{gateway_id}/apis: + get: + description: List API instances managed by a specific gateway with pagination. + operationId: getGatewayApisApiGatewaysGatewayIdApisGet + parameters: + - + description: Composite or UUID gateway identifier + in: path + name: gateway_id + required: true + schema: + description: Composite or UUID gateway identifier + title: Gateway Id + type: string + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + - + description: Environment containing the gateway + in: query + name: environmentId + required: true + schema: + description: Environment containing the gateway + title: Environmentid + type: string + - + description: Zero-based page index + in: query + name: pageNumber + required: false + schema: + default: 0 + description: Zero-based page index + title: Pagenumber + type: integer + - + description: Number of API instances per page + in: query + name: pageSize + required: false + schema: + default: 20 + description: Number of API instances per page + title: Pagesize + type: integer + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Gateway Apis + tags: + - Gateways + /api/gateways/{gateway_id}/logs: + get: + description: Stream recent log entries from a Flex Gateway replica. + operationId: getGatewayLogsApiGatewaysGatewayIdLogsGet + parameters: + - + description: Composite or UUID gateway identifier + in: path + name: gateway_id + required: true + schema: + description: Composite or UUID gateway identifier + title: Gateway Id + type: string + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + - + description: Environment containing the gateway + in: query + name: environmentId + required: true + schema: + description: Environment containing the gateway + title: Environmentid + type: string + - + description: Return logs in descending chronological order + in: query + name: descending + required: false + schema: + default: true + description: Return logs in descending chronological order + title: Descending + type: boolean + - + description: Pagination cursor — log document ID to continue after + in: query + name: afterDocId + required: false + schema: + anyOf: + - + type: string + - + type: "null" + description: Pagination cursor — log document ID to continue after + title: Afterdocid + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Gateway Logs + tags: + - Gateways + /api/gateways/{gateway_id}/metrics/{metric}/{aggregation}: + get: + description: Return time-series metric data (CPU, memory, latency, requests, errors) for a gateway. + operationId: getGatewayMetricsApiGatewaysGatewayIdMetricsMetricAggregationGet + parameters: + - + description: Composite or UUID gateway identifier + in: path + name: gateway_id + required: true + schema: + description: Composite or UUID gateway identifier + title: Gateway Id + type: string + - + description: "Metric name: cpu, mem, latency, requests, or errors" + in: path + name: metric + required: true + schema: + description: "Metric name: cpu, mem, latency, requests, or errors" + title: Metric + type: string + - + description: "Aggregation function: avg, count, max, min, or sum" + in: path + name: aggregation + required: true + schema: + description: "Aggregation function: avg, count, max, min, or sum" + title: Aggregation + type: string + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + - + description: Environment containing the gateway + in: query + name: environmentId + required: true + schema: + description: Environment containing the gateway + title: Environmentid + type: string + - + description: Start timestamp in epoch milliseconds + in: query + name: start + required: true + schema: + description: Start timestamp in epoch milliseconds + title: Start + type: integer + - + description: End timestamp in epoch milliseconds + in: query + name: end + required: true + schema: + description: End timestamp in epoch milliseconds + title: End + type: integer + - + description: ISO 8601 duration bucket size + in: query + name: duration + required: false + schema: + default: PT30M + description: ISO 8601 duration bucket size + title: Duration + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Gateway Metrics + tags: + - Gateways + /api/gateways/{gateway_id}/replicas: + get: + description: List replica pods for a Flex Gateway with optional status filtering. + operationId: getGatewayReplicasApiGatewaysGatewayIdReplicasGet + parameters: + - + description: Composite or UUID gateway identifier + in: path + name: gateway_id + required: true + schema: + description: Composite or UUID gateway identifier + title: Gateway Id + type: string + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + - + description: Environment containing the gateway + in: query + name: environmentId + required: true + schema: + description: Environment containing the gateway + title: Environmentid + type: string + - + description: Zero-based page index + in: query + name: pageNumber + required: false + schema: + default: 0 + description: Zero-based page index + title: Pagenumber + type: integer + - + description: Number of replicas per page + in: query + name: pageSize + required: false + schema: + default: 20 + description: Number of replicas per page + title: Pagesize + type: integer + - + description: Filter replicas by status (e.g. RUNNING, PENDING) + in: query + name: status + required: false + schema: + anyOf: + - + type: string + - + type: "null" + description: Filter replicas by status (e.g. RUNNING, PENDING) + title: Status + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Gateway Replicas + tags: + - Gateways + /api/gateways/{gateway_id}/runtime-configuration: + get: + description: Read the current runtime configuration applied to a Flex Gateway. + operationId: getGatewayRuntimeConfigurationApiGatewaysGatewayIdRuntimeConfigurationGet + parameters: + - + description: Composite or UUID gateway identifier + in: path + name: gateway_id + required: true + schema: + description: Composite or UUID gateway identifier + title: Gateway Id + type: string + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + - + description: Environment containing the gateway + in: query + name: environmentId + required: true + schema: + description: Environment containing the gateway + title: Environmentid + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Gateway Runtime Configuration + tags: + - Gateways + put: + description: Update the runtime configuration (logging, resource limits) for a Flex Gateway. + operationId: updateGatewayRuntimeConfigurationApiGatewaysGatewayIdRuntimeConfigurationPut + parameters: + - + description: Gateway instance ID + in: path + name: gateway_id + required: true + schema: + description: Gateway instance ID + title: Gateway Id + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Update Gateway Runtime Configuration + tags: + - Gateways + /api/gateways/{gateway_id}/usagereport: + get: + description: Return entitlement usage data for a single gateway instance. + operationId: getGatewayDetailUsageReportApiGatewaysGatewayIdUsagereportGet + parameters: + - + description: Composite or UUID gateway identifier + in: path + name: gateway_id + required: true + schema: + description: Composite or UUID gateway identifier + title: Gateway Id + type: string + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + - + description: Environment containing the gateway + in: query + name: environmentId + required: true + schema: + description: Environment containing the gateway + title: Environmentid + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Gateway Detail Usage Report + tags: + - Gateways + /api/governance-insights/agentic/maturity: + post: + description: Generate a governance maturity assessment summary for the organization. + operationId: generateGovernanceMaturityApiGovernanceInsightsAgenticMaturityPost + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/GovernanceAgenticRequest" + description: Payload for governance agentic actions (explain, review, maturity). + required: true + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Generate Governance Maturity + tags: + - Governance Insights + /api/governance-insights/agentic/{action}: + post: + description: Build a contextual LLM prompt for a governance-related agentic action. + operationId: buildGovernanceAgenticPromptApiGovernanceInsightsAgenticActionPost + parameters: + - + description: "Agentic action: explain, review, or summarize" + in: path + name: action + required: true + schema: + description: "Agentic action: explain, review, or summarize" + title: Action + type: string + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/GovernanceAgenticRequest" + description: Payload for governance agentic actions (explain, review, maturity). + required: true + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Build Governance Agentic Prompt + tags: + - Governance Insights + /api/governance-insights/jobs: + post: + description: Start a new governance insights analysis job for the specified organization. + operationId: createGovernanceInsightsJobApiGovernanceInsightsJobsPost + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/GovernanceInsightsJobRequest" + description: Request to start a governance insights analysis job. + required: true + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Create Governance Insights Job + tags: + - Governance Insights + /api/governance-insights/jobs/{job_id}: + get: + description: Poll the progress and result of a governance insights job by ID. + operationId: getGovernanceInsightsJobApiGovernanceInsightsJobsJobIdGet + parameters: + - + description: Governance insights job identifier + in: path + name: job_id + required: true + schema: + description: Governance insights job identifier + title: Job Id + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Governance Insights Job + tags: + - Governance Insights + /api/governance-insights/orgs/{org_id}/ensure-fresh: + post: + description: Ensure the governance report for the organization is up-to-date, recomputing if stale. + operationId: ensureGovernanceOrgReportFreshApiGovernanceInsightsOrgsOrgIdEnsureFreshPost + parameters: + - + description: Anypoint organization ID + in: path + name: org_id + required: true + schema: + description: Anypoint organization ID + title: Org Id + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Ensure Governance Org Report Fresh + tags: + - Governance Insights + /api/governance-insights/orgs/{org_id}/report-details: + get: + description: Retrieve detailed findings from a completed governance insights report. + operationId: getGovernanceInsightsReportDetailsApiGovernanceInsightsOrgsOrgIdReportDetailsGet + parameters: + - + description: Anypoint organization ID + in: path + name: org_id + required: true + schema: + description: Anypoint organization ID + title: Org Id + type: string + - + description: Report identifier from a completed insights job + in: query + name: reportId + required: true + schema: + description: Report identifier from a completed insights job + title: Reportid + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Governance Insights Report Details + tags: + - Governance Insights + /api/governance-insights/orgs/{org_id}/services/status-map: + get: + description: Return a map of service IDs to their governance compliance status across the org. + operationId: getGovernanceServiceStatusMapApiGovernanceInsightsOrgsOrgIdServicesStatusMapGet + parameters: + - + description: Anypoint organization ID + in: path + name: org_id + required: true + schema: + description: Anypoint organization ID + title: Org Id + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Governance Service Status Map + tags: + - Governance Insights + /api/governance-insights/orgs/{org_id}/services/{service_id}/recompute: + post: + description: Trigger a targeted recompute of governance data for a single service version. + operationId: createGovernanceServiceRecomputeJobApiGovernanceInsightsOrgsOrgIdServicesServiceIdRecomputePost + parameters: + - + description: Anypoint organization ID + in: path + name: org_id + required: true + schema: + description: Anypoint organization ID + title: Org Id + type: string + - + description: Exchange service asset identifier + in: path + name: service_id + required: true + schema: + description: Exchange service asset identifier + title: Service Id + type: string + - + description: Semantic version to recompute; omit for latest + in: query + name: version + required: false + schema: + anyOf: + - + type: string + - + type: "null" + description: Semantic version to recompute; omit for latest + title: Version + - + description: API version qualifier within the asset version + in: query + name: apiVersion + required: false + schema: + anyOf: + - + type: string + - + type: "null" + description: API version qualifier within the asset version + title: Apiversion + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Create Governance Service Recompute Job + tags: + - Governance Insights + /api/governance-insights/orgs/{org_id}/services/{service_id}/report: + get: + description: Return the governance compliance report for a specific service version. + operationId: getGovernanceServiceReportApiGovernanceInsightsOrgsOrgIdServicesServiceIdReportGet + parameters: + - + description: Anypoint organization ID + in: path + name: org_id + required: true + schema: + description: Anypoint organization ID + title: Org Id + type: string + - + description: Exchange service asset identifier + in: path + name: service_id + required: true + schema: + description: Exchange service asset identifier + title: Service Id + type: string + - + description: Semantic version to query; omit for latest + in: query + name: version + required: false + schema: + anyOf: + - + type: string + - + type: "null" + description: Semantic version to query; omit for latest + title: Version + - + description: API version qualifier within the asset version + in: query + name: apiVersion + required: false + schema: + anyOf: + - + type: string + - + type: "null" + description: API version qualifier within the asset version + title: Apiversion + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Governance Service Report + tags: + - Governance Insights + /api/governance-insights/worker/health: + get: + description: Check whether the Temporal governance-insights worker is running and healthy. + operationId: governanceInsightsWorkerHealthApiGovernanceInsightsWorkerHealthGet + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: Governance Insights Worker Health + tags: + - Governance Insights + /api/governance/automated-policies/reorder: + patch: + description: Reorder existing automated policies within an organization's governance strategy. + operationId: reorderAutomatedPoliciesRouteApiGovernanceAutomatedPoliciesReorderPatch + parameters: + - + description: Anypoint organization ID that owns the automated policies being reordered. + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID that owns the automated policies being reordered. + title: Organizationid + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Reorder Automated Policies Route + tags: + - Governance + /api/governance/conformance: + post: + description: Run conformance validation against API governance profiles. + operationId: getConformanceApiGovernanceConformancePost + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: Get Conformance + tags: + - Governance + /api/governance/guardrails: + get: + description: List governance guardrails configured for the organization, optionally filtered by type. + operationId: listGuardrailsRouteApiGovernanceGuardrailsGet + parameters: + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + - + description: Filter by strategy type (e.g. api-governance, security) + in: query + name: strategyType + required: false + schema: + anyOf: + - + type: string + - + type: "null" + description: Filter by strategy type (e.g. api-governance, security) + title: Strategytype + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: List Guardrails Route + tags: + - Governance + post: + description: Create a new governance guardrail with rules and scope targeting. + operationId: createGuardrailRouteApiGovernanceGuardrailsPost + parameters: + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Create Guardrail Route + tags: + - Governance + /api/governance/guardrails/coverage: + get: + description: Return guardrail coverage statistics for the organization's governance strategy. + operationId: getGuardrailsCoverageRouteApiGovernanceGuardrailsCoverageGet + parameters: + - + description: Anypoint organization ID whose guardrail coverage should be reported. + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID whose guardrail coverage should be reported. + title: Organizationid + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Guardrails Coverage Route + tags: + - Governance + /api/governance/guardrails/first: + get: + description: Return the first guardrail in the organization to check if any exist. + operationId: getFirstGuardrailRouteApiGovernanceGuardrailsFirstGet + parameters: + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get First Guardrail Route + tags: + - Governance + /api/governance/guardrails/rule-catalog: + get: + description: Return the catalog of available rules that can be included in a guardrail. + operationId: listGuardrailRuleCatalogRouteApiGovernanceGuardrailsRuleCatalogGet + parameters: + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: List Guardrail Rule Catalog Route + tags: + - Governance + /api/governance/guardrails/scope-options: + get: + description: List available scope-filter options (environments, tags) for targeting guardrails. + operationId: listGuardrailScopeOptionsRouteApiGovernanceGuardrailsScopeOptionsGet + parameters: + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: List Guardrail Scope Options Route + tags: + - Governance + /api/governance/guardrails/scope-preview: + post: + description: Preview which APIs would be affected by a guardrail scope filter before applying. + operationId: previewGuardrailScopeRouteApiGovernanceGuardrailsScopePreviewPost + parameters: + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Preview Guardrail Scope Route + tags: + - Governance + /api/governance/guardrails/{guardrail_id}: + delete: + description: Permanently delete a governance guardrail and remove its associated profile. + operationId: deleteGuardrailRouteApiGovernanceGuardrailsGuardrailIdDelete + parameters: + - + description: Unique guardrail identifier + in: path + name: guardrail_id + required: true + schema: + description: Unique guardrail identifier + title: Guardrail Id + type: string + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Delete Guardrail Route + tags: + - Governance + get: + description: Retrieve full details of a single governance guardrail by ID. + operationId: getGuardrailRouteApiGovernanceGuardrailsGuardrailIdGet + parameters: + - + description: Unique guardrail identifier + in: path + name: guardrail_id + required: true + schema: + description: Unique guardrail identifier + title: Guardrail Id + type: string + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Guardrail Route + tags: + - Governance + put: + description: Update an existing governance guardrail's rules, scope, or configuration. + operationId: updateGuardrailRouteApiGovernanceGuardrailsGuardrailIdPut + parameters: + - + description: Unique guardrail identifier + in: path + name: guardrail_id + required: true + schema: + description: Unique guardrail identifier + title: Guardrail Id + type: string + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Update Guardrail Route + tags: + - Governance + /api/governance/guardrails/{guardrail_id}/profile-evaluation: + get: + description: Poll or retrieve results of a guardrail profile evaluation job. + operationId: getGuardrailProfileEvaluationRouteApiGovernanceGuardrailsGuardrailIdProfileEvaluationGet + parameters: + - + description: Unique guardrail identifier + in: path + name: guardrail_id + required: true + schema: + description: Unique guardrail identifier + title: Guardrail Id + type: string + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + - + description: Evaluation job ID to poll; omit to get latest + in: query + name: jobId + required: false + schema: + anyOf: + - + type: string + - + type: "null" + description: Evaluation job ID to poll; omit to get latest + title: Jobid + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Guardrail Profile Evaluation Route + tags: + - Governance + post: + description: Trigger an asynchronous governance profile evaluation for a guardrail. + operationId: startGuardrailProfileEvaluationRouteApiGovernanceGuardrailsGuardrailIdProfileEvaluationPost + parameters: + - + description: Unique guardrail identifier + in: path + name: guardrail_id + required: true + schema: + description: Unique guardrail identifier + title: Guardrail Id + type: string + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Start Guardrail Profile Evaluation Route + tags: + - Governance + /api/governance/omni/reporting-targets/{group_id}/{asset_id}/{version}: + get: + description: Return the Omni-managed reporting target summary for a specific asset version. + operationId: getOmniReportingTargetReportsApiGovernanceOmniReportingTargetsGroupIdAssetIdVersionGet + parameters: + - + description: Exchange group ID (organization ID) + in: path + name: group_id + required: true + schema: + description: Exchange group ID (organization ID) + title: Group Id + type: string + - + description: Exchange asset identifier + in: path + name: asset_id + required: true + schema: + description: Exchange asset identifier + title: Asset Id + type: string + - + description: Semantic version of the asset + in: path + name: version + required: true + schema: + description: Semantic version of the asset + title: Version + type: string + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Omni Reporting Target Reports + tags: + - Governance + /api/governance/omni/settings: + get: + description: Return the current Omni governance strategy settings for the organization. + operationId: getOmniSettingsRouteApiGovernanceOmniSettingsGet + parameters: + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Omni Settings Route + tags: + - Governance + /api/governance/omni/settings/apply: + post: + description: Apply governance strategy rulesets to the organization, creating or updating profiles. + operationId: applyOmniSettingsRouteApiGovernanceOmniSettingsApplyPost + parameters: + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Apply Omni Settings Route + tags: + - Governance + /api/governance/omni/settings/apply/{job_id}: + get: + description: Poll the status of an asynchronous governance settings apply job. + operationId: getOmniSettingsApplyJobRouteApiGovernanceOmniSettingsApplyJobIdGet + parameters: + - + description: Async apply job identifier + in: path + name: job_id + required: true + schema: + description: Async apply job identifier + title: Job Id + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Omni Settings Apply Job Route + tags: + - Governance + /api/governance/omni/settings/preview: + post: + description: Preview what would change if the given governance rulesets were applied. + operationId: previewOmniSettingsRouteApiGovernanceOmniSettingsPreviewPost + parameters: + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Preview Omni Settings Route + tags: + - Governance + /api/governance/report-details: + post: + description: Fetch detailed governance report results for selected conformance targets. + operationId: getReportDetailsApiGovernanceReportDetailsPost + parameters: + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Report Details + tags: + - Governance + /api/governance/strategies/{strategy_id}: + delete: + description: Delete a legacy governance strategy by ID. + operationId: deleteStrategyRouteApiGovernanceStrategiesStrategyIdDelete + parameters: + - + description: Legacy strategy identifier to delete + in: path + name: strategy_id + required: true + schema: + description: Legacy strategy identifier to delete + title: Strategy Id + type: string + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Delete Strategy Route + tags: + - Governance + /api/governance/targets/{group_id}/{asset_id}/{version}: + get: + description: Retrieve governance target reports for a specific Exchange asset version. + operationId: getTargetReportsApiGovernanceTargetsGroupIdAssetIdVersionGet + parameters: + - + description: Exchange group ID (organization ID) + in: path + name: group_id + required: true + schema: + description: Exchange group ID (organization ID) + title: Group Id + type: string + - + description: Exchange asset identifier + in: path + name: asset_id + required: true + schema: + description: Exchange asset identifier + title: Asset Id + type: string + - + description: Semantic version of the asset + in: path + name: version + required: true + schema: + description: Semantic version of the asset + title: Version + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Target Reports + tags: + - Governance + /api/kong/connect: + post: + description: Register a Kong Konnect connection for subsequent gateway and plugin operations. + operationId: connectKongApiKongConnectPost + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/ConnectKongRequest" + description: Request to register a Kong control plane as a connected gateway. + required: true + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Connect Kong + tags: + - Kong + /api/kong/gateways: + get: + description: List all Kong Konnect control planes available through the registered connection. + operationId: listGatewaysApiKongGatewaysGet + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: List Gateways + tags: + - Kong + /api/kong/gateways/connect: + post: + description: Fetch a Kong control plane by ID and register it as a connected gateway. + operationId: connectGatewayApiKongGatewaysConnectPost + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/ConnectGatewayRequest" + description: Request to connect or register a standalone gateway by its ID. + required: true + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Connect Gateway + tags: + - Kong + /api/kong/plugins: + get: + description: List installed plugins on a Kong control plane with their enabled status and configuration. + operationId: getPluginsApiKongPluginsGet + parameters: + - + description: Kong control-plane gateway ID; uses the first registered connection when omitted + in: query + name: gateway_id + required: false + schema: + anyOf: + - + type: string + - + type: "null" + description: Kong control-plane gateway ID; uses the first registered connection when omitted + title: Gateway Id + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Plugins + tags: + - Kong + /api/kong/plugins/apply: + post: + description: Create a new plugin instance on a Kong control plane with the given configuration. + operationId: applyPluginApiKongPluginsApplyPost + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/ApplyPluginRequest" + description: Request to apply a Kong plugin to a gateway service. + required: true + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Apply Plugin + tags: + - Kong + /api/kong/plugins/{plugin_name}/schema: + get: + description: Return the JSON schema definition for a specific Kong plugin's configuration. + operationId: getPluginSchemaApiKongPluginsPluginNameSchemaGet + parameters: + - + description: Kong plugin name (e.g. rate-limiting, key-auth) + in: path + name: plugin_name + required: true + schema: + description: Kong plugin name (e.g. rate-limiting, key-auth) + title: Plugin Name + type: string + - + description: Kong control-plane gateway ID; uses the first registered connection when omitted + in: query + name: gateway_id + required: false + schema: + anyOf: + - + type: string + - + type: "null" + description: Kong control-plane gateway ID; uses the first registered connection when omitted + title: Gateway Id + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Plugin Schema + tags: + - Kong + /api/kong/test-connection: + post: + description: Verify connectivity to Kong Konnect by listing control planes with the provided auth token. + operationId: testKongConnectionApiKongTestConnectionPost + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/TestKongConnectionRequest" + description: Credentials payload to test connectivity to a Kong control plane. + required: true + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Test Kong Connection + tags: + - Kong + /api/mcp/catalog: + get: + description: Return the MCP server catalog from the bundled OAS library. + operationId: getCatalogApiMcpCatalogGet + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: Get Catalog + tags: + - MCP Provisioning + /api/monitoring/agentic/card: + post: + description: Generate an agentic insight card summarizing monitoring data for the agent UI. + operationId: createMonitoringAgenticCardApiMonitoringAgenticCardPost + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/MonitoringOmniCardRequest" + description: Request to generate an agentic insight card summarizing monitoring data. + required: true + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Create Monitoring Agentic Card + tags: + - Monitoring + /api/monitoring/aggregate/charts: + get: + description: Return aggregated monitoring charts for multiple API, agent, or MCP instances. + operationId: getAggregateInstanceChartsApiMonitoringAggregateChartsGet + parameters: + - + description: "Entity type: api, agent, or mcp" + in: query + name: entityType + required: true + schema: + description: "Entity type: api, agent, or mcp" + enum: + - api + - agent + - mcp + title: Entitytype + type: string + - + description: One or more API instance IDs to aggregate + in: query + name: apiInstanceId + required: false + schema: + default: + [] + description: One or more API instance IDs to aggregate + items: + type: string + title: Apiinstanceid + type: array + - + description: Anypoint organization ID; resolved from profile when omitted + in: query + name: organizationId + required: false + schema: + anyOf: + - + type: string + - + type: "null" + description: Anypoint organization ID; resolved from profile when omitted + title: Organizationid + - + description: Lookback window for chart data + in: query + name: timeRange + required: true + schema: + description: Lookback window for chart data + enum: + - 1h + - 6h + - 24h + - 7d + - 30d + title: Timerange + type: string + - + description: Environment name to scope metrics to + in: query + name: environment + required: true + schema: + description: Environment name to scope metrics to + title: Environment + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Aggregate Instance Charts + tags: + - Monitoring + /api/monitoring/alerts: + get: + description: |- + Fetch Runtime Manager alerts from MDAS or Anypoint (ARM UI) per environment. + + On upstream errors, returns 200 with empty ``data`` so the client can still merge + Monitoring and API Manager alert lists. + operationId: getAlertsApiMonitoringAlertsGet + parameters: + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + - + description: Maximum number of alerts to return per environment + in: query + name: limit + required: false + schema: + default: 1000 + description: Maximum number of alerts to return per environment + title: Limit + type: integer + - + description: Bearer token from the caller's Anypoint session. The endpoint forwards this credential to upstream Anypoint services (Monitoring, API Manager, Runtime Manager); the value is not stored server-side. + in: header + name: authorization + required: false + schema: + description: Bearer token from the caller's Anypoint session. The endpoint forwards this credential to upstream Anypoint services (Monitoring, API Manager, Runtime Manager); the value is not stored server-side. + title: Authorization + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Alerts + tags: + - Monitoring + /api/monitoring/alerts/api-manager: + get: + description: Fetch one page of API Manager alerts (Anypoint or MDAS). Client uses ``offset`` / ``limit`` + ``hasMore`` for paging. + operationId: getApiManagerAlertsApiMonitoringAlertsApiManagerGet + parameters: + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + - + description: Zero-based pagination offset + in: query + name: offset + required: false + schema: + default: 0 + description: Zero-based pagination offset + minimum: 0 + title: Offset + type: integer + - + description: Page size (defaults to server config when omitted) + in: query + name: limit + required: false + schema: + anyOf: + - + type: integer + - + type: "null" + description: Page size (defaults to server config when omitted) + title: Limit + - + description: Bearer token from the caller's Anypoint session. The endpoint forwards this credential to upstream Anypoint services (Monitoring, API Manager, Runtime Manager); the value is not stored server-side. + in: header + name: authorization + required: false + schema: + description: Bearer token from the caller's Anypoint session. The endpoint forwards this credential to upstream Anypoint services (Monitoring, API Manager, Runtime Manager); the value is not stored server-side. + title: Authorization + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Api Manager Alerts + tags: + - Monitoring + /api/monitoring/alerts/create: + post: + description: |- + Create a new alert in Anypoint Platform. + + Routes to appropriate backend based on backendService: + 1. Runtime Manager - for deployment/lifecycle events + 2. Anypoint Monitoring - for resource health & performance metrics + operationId: createAlertApiMonitoringAlertsCreatePost + parameters: + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + - + description: Environment ID to create the alert in + in: query + name: environmentId + required: true + schema: + description: Environment ID to create the alert in + title: Environmentid + type: string + - + description: Resource type for the alert (e.g. hybrid-application, server) + in: query + name: resourceType + required: true + schema: + description: Resource type for the alert (e.g. hybrid-application, server) + title: Resourcetype + type: string + - + description: Backend service to route the request to + in: query + name: backendService + required: false + schema: + default: runtime-manager + description: Backend service to route the request to + title: Backendservice + type: string + - + description: Bearer token from the caller's Anypoint session. The endpoint forwards this credential to upstream Anypoint services (Monitoring, API Manager, Runtime Manager); the value is not stored server-side. + in: header + name: authorization + required: false + schema: + description: Bearer token from the caller's Anypoint session. The endpoint forwards this credential to upstream Anypoint services (Monitoring, API Manager, Runtime Manager); the value is not stored server-side. + title: Authorization + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Create Alert + tags: + - Monitoring + /api/monitoring/alerts/create-api-manager: + post: + description: |- + Create a new alert in API Manager API. + + Used for API-level metrics: + - api_policy_violation_count + - request_count (API-level) + - response_time (API-level) + - http_response_codes (API-level) + operationId: createApiManagerAlertApiMonitoringAlertsCreateApiManagerPost + parameters: + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + - + description: Environment ID to create the alert in + in: query + name: environmentId + required: true + schema: + description: Environment ID to create the alert in + title: Environmentid + type: string + - + description: API metric to monitor (e.g. api_policy_violation_count, request_count) + in: query + name: metricType + required: true + schema: + description: API metric to monitor (e.g. api_policy_violation_count, request_count) + title: Metrictype + type: string + - + description: Deployment target type (CLOUDHUB, RTF) + in: query + name: deploymentType + required: false + schema: + default: CLOUDHUB + description: Deployment target type (CLOUDHUB, RTF) + title: Deploymenttype + type: string + - + description: Bearer token from the caller's Anypoint session. The endpoint forwards this credential to upstream Anypoint services (Monitoring, API Manager, Runtime Manager); the value is not stored server-side. + in: header + name: authorization + required: false + schema: + description: Bearer token from the caller's Anypoint session. The endpoint forwards this credential to upstream Anypoint services (Monitoring, API Manager, Runtime Manager); the value is not stored server-side. + title: Authorization + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Create Api Manager Alert + tags: + - Monitoring + /api/monitoring/alerts/create-monitoring: + post: + description: |- + Create a new alert in Anypoint Monitoring API. + + Used for resource health & performance metrics: + - cpu_utilization + - memory_utilization + - thread_count + - message_count + - message_errors + - application_response_time + - api_policy_violation_count + operationId: createMonitoringAlertApiMonitoringAlertsCreateMonitoringPost + parameters: + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + - + description: Environment ID to create the alert in + in: query + name: environmentId + required: true + schema: + description: Environment ID to create the alert in + title: Environmentid + type: string + - + description: Metric to monitor (e.g. cpu_utilization, memory_utilization) + in: query + name: metricType + required: true + schema: + description: Metric to monitor (e.g. cpu_utilization, memory_utilization) + title: Metrictype + type: string + - + description: Deployment target type (RTF, CLOUDHUB) + in: query + name: deploymentType + required: false + schema: + default: RTF + description: Deployment target type (RTF, CLOUDHUB) + title: Deploymenttype + type: string + - + description: CloudHub cluster identifier + in: query + name: clusterId + required: false + schema: + default: cloudhub-us-east-1 + description: CloudHub cluster identifier + title: Clusterid + type: string + - + description: Bearer token from the caller's Anypoint session. The endpoint forwards this credential to upstream Anypoint services (Monitoring, API Manager, Runtime Manager); the value is not stored server-side. + in: header + name: authorization + required: false + schema: + description: Bearer token from the caller's Anypoint session. The endpoint forwards this credential to upstream Anypoint services (Monitoring, API Manager, Runtime Manager); the value is not stored server-side. + title: Authorization + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Create Monitoring Alert + tags: + - Monitoring + /api/monitoring/alerts/monitoring: + get: + description: Fetch monitoring alerts from MDAS or Anypoint Platform based on configuration. + operationId: getMonitoringAlertsApiMonitoringAlertsMonitoringGet + parameters: + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + - + description: Bearer token from the caller's Anypoint session. The endpoint forwards this credential to upstream Anypoint services (Monitoring, API Manager, Runtime Manager); the value is not stored server-side. + in: header + name: authorization + required: false + schema: + description: Bearer token from the caller's Anypoint session. The endpoint forwards this credential to upstream Anypoint services (Monitoring, API Manager, Runtime Manager); the value is not stored server-side. + title: Authorization + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Monitoring Alerts + tags: + - Monitoring + /api/monitoring/alerts/{alert_id}: + delete: + description: |- + Delete an alert. + + Routes to the correct upstream API based on ``source`` and configuration: + - When USE_MDAS_FOR_ALERTS=true -> ``DELETE /mdas/v1/organizations/{orgId}/alerts/{alertId}`` + - When USE_MDAS_FOR_ALERTS=false: + - **anypoint-monitoring** -> + ``DELETE /monitoring/api/v2/organizations/{orgId}/alerts/{alertId}`` + - **API Manager** -> + ``DELETE /monitoring/api/alerts/api/v2/organizations/{orgId}/environments/{envId}/alerts/{alertId}`` + (requires ``environmentId``) + - **runtime-manager** -> + ``DELETE /armui/api/v2/alerts/{endpoint}/{alertId}`` + where *endpoint* is resolved from ``resourceType``. + + ``ANYPOINT_MONITORING_UPSTREAM_DISABLED`` blocks only ``source=anypoint-monitoring``; + API Manager deletes targeting the API Manager source are unaffected. + operationId: deleteAlertApiMonitoringAlertsAlertIdDelete + parameters: + - + description: Alert identifier to delete + in: path + name: alert_id + required: true + schema: + description: Alert identifier to delete + title: Alert Id + type: string + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + - + description: "Alert source: runtime-manager | anypoint-monitoring | API Manager" + in: query + name: source + required: true + schema: + description: "Alert source: runtime-manager | anypoint-monitoring | API Manager" + title: Source + type: string + - + description: Resource type the alert monitors + in: query + name: resourceType + required: false + schema: + default: hybrid-application + description: Resource type the alert monitors + title: Resourcetype + type: string + - + description: Environment ID (required for API Manager alerts) + in: query + name: environmentId + required: false + schema: + default: "" + description: Environment ID (required for API Manager alerts) + title: Environmentid + type: string + - + description: Bearer token from the caller's Anypoint session. The endpoint forwards this credential to upstream Anypoint services (Monitoring, API Manager, Runtime Manager); the value is not stored server-side. + in: header + name: authorization + required: false + schema: + description: Bearer token from the caller's Anypoint session. The endpoint forwards this credential to upstream Anypoint services (Monitoring, API Manager, Runtime Manager); the value is not stored server-side. + title: Authorization + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Delete Alert + tags: + - Monitoring + patch: + description: |- + Update an existing alert in Anypoint Platform or MDAS. + + - **runtime-manager** -> ``PATCH /armui/api/v2/alerts/{endpoint}/{alertId}`` + - **API Manager** -> ``PUT`` API Manager monitoring alerts API for the environment + (requires ``metricType``; same payload shape as the API Manager create route). + - **MDAS** (``USE_MDAS_FOR_ALERTS``) -> ``PATCH`` ``/v1/organizations/{orgId}/alerts/{alertId}`` + (API Manager updates require the API Manager source and ``metricType``; + monitoring updates require ``source=anypoint-monitoring`` and ``metricType``). + operationId: updateAlertApiMonitoringAlertsAlertIdPatch + parameters: + - + description: Alert identifier to update + in: path + name: alert_id + required: true + schema: + description: Alert identifier to update + title: Alert Id + type: string + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + - + description: Environment containing the alert + in: query + name: environmentId + required: true + schema: + description: Environment containing the alert + title: Environmentid + type: string + - + description: Resource type the alert monitors + in: query + name: resourceType + required: true + schema: + description: Resource type the alert monitors + title: Resourcetype + type: string + - + description: "Alert source: runtime-manager | API Manager | anypoint-monitoring" + in: query + name: source + required: false + schema: + default: runtime-manager + description: "Alert source: runtime-manager | API Manager | anypoint-monitoring" + title: Source + type: string + - + description: Metric type for API Manager or monitoring alerts + in: query + name: metricType + required: false + schema: + anyOf: + - + type: string + - + type: "null" + description: Metric type for API Manager or monitoring alerts + title: Metrictype + - + description: Deployment target type (CLOUDHUB, RTF) + in: query + name: deploymentType + required: false + schema: + default: CLOUDHUB + description: Deployment target type (CLOUDHUB, RTF) + title: Deploymenttype + type: string + - + description: Bearer token from the caller's Anypoint session. The endpoint forwards this credential to upstream Anypoint services (Monitoring, API Manager, Runtime Manager); the value is not stored server-side. + in: header + name: authorization + required: false + schema: + description: Bearer token from the caller's Anypoint session. The endpoint forwards this credential to upstream Anypoint services (Monitoring, API Manager, Runtime Manager); the value is not stored server-side. + title: Authorization + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Update Alert + tags: + - Monitoring + /api/monitoring/charts: + get: + description: Return time-series chart data for network errors and request volume. + operationId: getMonitoringChartsApiMonitoringChartsGet + parameters: + - + description: Anypoint organization ID; resolved from profile when omitted + in: query + name: organizationId + required: false + schema: + anyOf: + - + type: string + - + type: "null" + description: Anypoint organization ID; resolved from profile when omitted + title: Organizationid + - + description: Lookback window for chart data + in: query + name: timeRange + required: false + schema: + default: 7d + description: Lookback window for chart data + enum: + - 1h + - 6h + - 24h + - 7d + - 30d + title: Timerange + type: string + - + description: Environment name filter + in: query + name: environment + required: false + schema: + anyOf: + - + type: string + - + type: "null" + default: sandbox + description: Environment name filter + title: Environment + - + description: Gateway provider filter (e.g. mulesoft, apigee, kong) + in: query + name: provider + required: false + schema: + anyOf: + - + type: string + - + type: "null" + description: Gateway provider filter (e.g. mulesoft, apigee, kong) + title: Provider + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Monitoring Charts + tags: + - Monitoring + /api/monitoring/entities: + get: + description: List monitored runtime entities (APIs, agents, MCPs) with traffic and error metrics. + operationId: getMonitoringEntitiesApiMonitoringEntitiesGet + parameters: + - + description: Anypoint organization ID; resolved from profile when omitted + in: query + name: organizationId + required: false + schema: + anyOf: + - + type: string + - + type: "null" + description: Anypoint organization ID; resolved from profile when omitted + title: Organizationid + - + description: Lookback window for entity metrics + in: query + name: timeRange + required: false + schema: + default: 7d + description: Lookback window for entity metrics + enum: + - 1h + - 6h + - 24h + - 7d + - 30d + title: Timerange + type: string + - + description: Environment name filter + in: query + name: environment + required: false + schema: + anyOf: + - + type: string + - + type: "null" + default: sandbox + description: Environment name filter + title: Environment + - + description: One-based page number + in: query + name: page + required: false + schema: + default: 1 + description: One-based page number + minimum: 1 + title: Page + type: integer + - + description: Number of entities per page (max 200) + in: query + name: pageSize + required: false + schema: + default: 50 + description: Number of entities per page (max 200) + maximum: 200 + minimum: 1 + title: Pagesize + type: integer + - + description: Gateway provider filter (e.g. mulesoft, apigee, kong) + in: query + name: provider + required: false + schema: + anyOf: + - + type: string + - + type: "null" + description: Gateway provider filter (e.g. mulesoft, apigee, kong) + title: Provider + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Monitoring Entities + tags: + - Monitoring + /api/monitoring/filters: + get: + description: Return available filter options (environments, providers) for the monitoring dashboard. + operationId: getMonitoringFiltersApiMonitoringFiltersGet + parameters: + - + description: Anypoint organization ID; resolved from profile when omitted + in: query + name: organizationId + required: false + schema: + anyOf: + - + type: string + - + type: "null" + description: Anypoint organization ID; resolved from profile when omitted + title: Organizationid + - + description: Lookback window for available filter discovery + in: query + name: timeRange + required: false + schema: + default: 7d + description: Lookback window for available filter discovery + enum: + - 1h + - 6h + - 24h + - 7d + - 30d + title: Timerange + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Monitoring Filters + tags: + - Monitoring + /api/monitoring/insights: + get: + description: Placeholder endpoint for future AI-driven monitoring insights. + operationId: getMonitoringInsightsApiMonitoringInsightsGet + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: Get Monitoring Insights + tags: + - Monitoring + /api/monitoring/instance/charts: + get: + description: Return time-series charts for a single API, agent, MCP, or LLM instance. + operationId: getInstanceChartsApiMonitoringInstanceChartsGet + parameters: + - + description: "Entity type: api, agent, mcp, or llm" + in: query + name: entityType + required: true + schema: + description: "Entity type: api, agent, mcp, or llm" + enum: + - api + - agent + - mcp + - llm + title: Entitytype + type: string + - + description: The API instance ID to scope metrics to + in: query + name: apiInstanceId + required: true + schema: + description: The API instance ID to scope metrics to + title: Apiinstanceid + type: string + - + description: Anypoint organization ID; resolved from profile when omitted + in: query + name: organizationId + required: false + schema: + anyOf: + - + type: string + - + type: "null" + description: Anypoint organization ID; resolved from profile when omitted + title: Organizationid + - + description: Lookback window for chart data + in: query + name: timeRange + required: true + schema: + description: Lookback window for chart data + enum: + - 1h + - 6h + - 24h + - 7d + - 30d + title: Timerange + type: string + - + description: Environment ID to scope metrics to + in: query + name: environmentId + required: true + schema: + description: Environment ID to scope metrics to + title: Environmentid + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Instance Charts + tags: + - Monitoring + /api/monitoring/runtime-kpis: + get: + description: Return runtime trust KPIs (availability, latency percentiles) for the organization. + operationId: getMonitoringRuntimeKpisApiMonitoringRuntimeKpisGet + parameters: + - + description: Anypoint organization ID; resolved from profile when omitted + in: query + name: organizationId + required: false + schema: + anyOf: + - + type: string + - + type: "null" + description: Anypoint organization ID; resolved from profile when omitted + title: Organizationid + - + description: Aggregation window for KPI calculation + in: query + name: aggregation + required: false + schema: + default: 7d + description: Aggregation window for KPI calculation + enum: + - 7d + - daily + title: Aggregation + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Monitoring Runtime Kpis + tags: + - Monitoring + /api/monitoring/service/distributions: + get: + description: Return endpoint and tool traffic distribution breakdowns for a service. + operationId: getServiceDistributionsApiMonitoringServiceDistributionsGet + parameters: + - + description: Anypoint organization ID; resolved from profile when omitted + in: query + name: organizationId + required: false + schema: + anyOf: + - + type: string + - + type: "null" + description: Anypoint organization ID; resolved from profile when omitted + title: Organizationid + - + description: Lookback window for distribution data + in: query + name: timeRange + required: false + schema: + default: 7d + description: Lookback window for distribution data + enum: + - 1h + - 6h + - 24h + - 7d + - 30d + title: Timerange + type: string + - + description: Environment name filter + in: query + name: environment + required: false + schema: + anyOf: + - + type: string + - + type: "null" + description: Environment name filter + title: Environment + - + description: "Entity type: api, agent, or mcp" + in: query + name: entityType + required: false + schema: + default: api + description: "Entity type: api, agent, or mcp" + enum: + - api + - agent + - mcp + title: Entitytype + type: string + - + description: One or more API instance IDs to scope the distribution + in: query + name: apiInstanceId + required: false + schema: + default: + [] + description: One or more API instance IDs to scope the distribution + items: + type: string + title: Apiinstanceid + type: array + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Service Distributions + tags: + - Monitoring + /api/monitoring/summary: + get: + description: Return a high-level monitoring summary with KPIs, error rates, and request volume. + operationId: getMonitoringSummaryApiMonitoringSummaryGet + parameters: + - + description: Anypoint organization ID; resolved from profile when omitted + in: query + name: organizationId + required: false + schema: + anyOf: + - + type: string + - + type: "null" + description: Anypoint organization ID; resolved from profile when omitted + title: Organizationid + - + description: Lookback window for summary metrics + in: query + name: timeRange + required: false + schema: + default: 7d + description: Lookback window for summary metrics + enum: + - 1h + - 6h + - 24h + - 7d + - 30d + title: Timerange + type: string + - + description: Environment name filter + in: query + name: environment + required: false + schema: + anyOf: + - + type: string + - + type: "null" + default: sandbox + description: Environment name filter + title: Environment + - + description: Gateway provider filter (e.g. mulesoft, apigee, kong) + in: query + name: provider + required: false + schema: + anyOf: + - + type: string + - + type: "null" + description: Gateway provider filter (e.g. mulesoft, apigee, kong) + title: Provider + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Monitoring Summary + tags: + - Monitoring + /api/monitoring/target-agentic-apis: + get: + description: |- + List API Manager **agentic** family instances (agents + MCP servers) for org/env. + + Proxies Anypoint ``GET .../apimanager/xapi/v1/organizations/{org}/environments/{env}/apis`` + with ``family=agentic``. Paginates until all instances are retrieved (bounded). + + The UI filters rows by ``endpointType`` / ``metadata.assetType`` (MCP vs Agent). + operationId: getTargetAgenticApisApiMonitoringTargetAgenticApisGet + parameters: + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + - + description: Environment ID to list agentic instances for + in: query + name: environmentId + required: true + schema: + description: Environment ID to list agentic instances for + title: Environmentid + type: string + - + description: Bearer token from the caller's Anypoint session. The endpoint forwards this credential to upstream Anypoint services (Monitoring, API Manager, Runtime Manager); the value is not stored server-side. + in: header + name: authorization + required: false + schema: + description: Bearer token from the caller's Anypoint session. The endpoint forwards this credential to upstream Anypoint services (Monitoring, API Manager, Runtime Manager); the value is not stored server-side. + title: Authorization + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Target Agentic Apis + tags: + - Monitoring + /api/monitoring/target-apis: + get: + description: |- + Return monitoring APIs (targets) for a given org/env, with server-side caching. + + The cache TTL is controlled by the ``MONITORING_APIS_CACHE_TTL_SECONDS`` + environment variable (default 600 s / 10 min). + + Not gated by ``ANYPOINT_MONITORING_UPSTREAM_DISABLED``: API catalog is required for + API Manager alerts and notification UI even when monitoring **alert** upstream is off. + operationId: getTargetApisApiMonitoringTargetApisGet + parameters: + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + - + description: Environment ID to list targets for + in: query + name: environmentId + required: true + schema: + description: Environment ID to list targets for + title: Environmentid + type: string + - + description: Bearer token from the caller's Anypoint session. The endpoint forwards this credential to upstream Anypoint services (Monitoring, API Manager, Runtime Manager); the value is not stored server-side. + in: header + name: authorization + required: false + schema: + description: Bearer token from the caller's Anypoint session. The endpoint forwards this credential to upstream Anypoint services (Monitoring, API Manager, Runtime Manager); the value is not stored server-side. + title: Authorization + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Target Apis + tags: + - Monitoring + /api/monitoring/target-applications: + get: + description: |- + Return runtime applications for a given org/env, with server-side caching. + + The cache TTL is controlled by the ``MONITORING_APIS_CACHE_TTL_SECONDS`` + environment variable (default 600 s / 10 min). + + Set ``ANYPOINT_RUNTIME_MANAGER_UPSTREAM_DISABLED=true`` to skip upstream + calls and return an empty application list. + operationId: getTargetApplicationsApiMonitoringTargetApplicationsGet + parameters: + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + - + description: Environment ID to list applications for + in: query + name: environmentId + required: true + schema: + description: Environment ID to list applications for + title: Environmentid + type: string + - + description: Bearer token from the caller's Anypoint session. The endpoint forwards this credential to upstream Anypoint services (Monitoring, API Manager, Runtime Manager); the value is not stored server-side. + in: header + name: authorization + required: false + schema: + description: Bearer token from the caller's Anypoint session. The endpoint forwards this credential to upstream Anypoint services (Monitoring, API Manager, Runtime Manager); the value is not stored server-side. + title: Authorization + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Target Applications + tags: + - Monitoring + /api/monitoring/target-llm-apis: + get: + description: |- + List API Manager instances for **LLM** endpoints in the environment. + + Proxies ``GET .../apimanager/xapi/v1/organizations/{org}/environments/{env}/apis`` + with ``endpointType=llm`` (same pagination and ``instances`` / ``total`` shape as agentic). + operationId: getTargetLlmApisApiMonitoringTargetLlmApisGet + parameters: + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + - + description: Environment ID to list LLM instances for + in: query + name: environmentId + required: true + schema: + description: Environment ID to list LLM instances for + title: Environmentid + type: string + - + description: Bearer token from the caller's Anypoint session. The endpoint forwards this credential to upstream Anypoint services (Monitoring, API Manager, Runtime Manager); the value is not stored server-side. + in: header + name: authorization + required: false + schema: + description: Bearer token from the caller's Anypoint session. The endpoint forwards this credential to upstream Anypoint services (Monitoring, API Manager, Runtime Manager); the value is not stored server-side. + title: Authorization + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Target Llm Apis + tags: + - Monitoring + /api/monitoring/users/resolve: + post: + description: Resolve user IDs to user profiles (id, email, name). + operationId: resolveUsersApiMonitoringUsersResolvePost + parameters: + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + - + description: Bearer token from the caller's Anypoint session. The endpoint forwards this credential to upstream Anypoint services (Monitoring, API Manager, Runtime Manager); the value is not stored server-side. + in: header + name: authorization + required: false + schema: + description: Bearer token from the caller's Anypoint session. The endpoint forwards this credential to upstream Anypoint services (Monitoring, API Manager, Runtime Manager); the value is not stored server-side. + title: Authorization + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Resolve Users + tags: + - Monitoring + /api/monitoring/users/search: + get: + description: Search for users in an organization. + operationId: searchUsersApiMonitoringUsersSearchGet + parameters: + - + description: Anypoint organization ID + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID + title: Organizationid + type: string + - + description: Search query (min 2 chars) + in: query + name: search + required: false + schema: + default: "" + description: Search query (min 2 chars) + title: Search + type: string + - + description: Maximum number of users to return (max 50) + in: query + name: limit + required: false + schema: + default: 10 + description: Maximum number of users to return (max 50) + maximum: 50 + title: Limit + type: integer + - + description: Bearer token from the caller's Anypoint session. The endpoint forwards this credential to upstream Anypoint services (Monitoring, API Manager, Runtime Manager); the value is not stored server-side. + in: header + name: authorization + required: false + schema: + description: Bearer token from the caller's Anypoint session. The endpoint forwards this credential to upstream Anypoint services (Monitoring, API Manager, Runtime Manager); the value is not stored server-side. + title: Authorization + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Search Users + tags: + - Monitoring + /api/policies/agentic/{action}: + post: + description: Build a contextual LLM prompt to explain, review, or suggest fixes for a policy. + operationId: buildPolicyAgenticPromptApiPoliciesAgenticActionPost + parameters: + - + description: "Agentic action: explain, review, or fix" + in: path + name: action + required: true + schema: + description: "Agentic action: explain, review, or fix" + title: Action + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Build Policy Agentic Prompt + tags: + - Policies + /api/policies/apply: + post: + description: Apply a policy to an API instance after governance validation. + operationId: applyPolicyApiPoliciesApplyPost + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: Apply Policy + tags: + - Policies + /api/policies/apply-outbound: + post: + description: Apply an outbound policy to one or more upstreams after governance validation. + operationId: applyOutboundPolicyApiPoliciesApplyOutboundPost + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: Apply Outbound Policy + tags: + - Policies + /api/policies/global: + get: + description: Fetch global (automated) policies that apply to an API instance. + operationId: listGlobalPoliciesApiPoliciesGlobalGet + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: List Global Policies + tags: + - Policies + /api/policies/list: + get: + description: Fetch applied policies for an API instance. + operationId: listPoliciesApiPoliciesListGet + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: List Policies + tags: + - Policies + /api/policies/remove: + post: + description: Remove an applied inbound or outbound policy from an API instance. + operationId: removePolicyApiPoliciesRemovePost + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: Remove Policy + tags: + - Policies + /api/policies/template-detail: + get: + description: Fetch one policy template detail on demand (for dynamic config forms). + operationId: templateDetailApiPoliciesTemplateDetailGet + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: Template Detail + tags: + - Policies + /api/policies/templates: + get: + description: Fetch available OOTB + custom policy templates for an organization. + operationId: listTemplatesApiPoliciesTemplatesGet + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: List Templates + tags: + - Policies + /api/policies/upstreams: + get: + description: Fetch upstreams for an API instance. + operationId: listUpstreamsApiPoliciesUpstreamsGet + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: List Upstreams + tags: + - Policies + /api/policies/validate-configuration: + post: + description: Validate a policy configuration against its JSON schema before applying. + operationId: validatePolicyConfigurationApiPoliciesValidateConfigurationPost + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: Validate Policy Configuration + tags: + - Policies + /api/providers/connected: + get: + description: List all connected third-party providers for the current organization. + operationId: getConnectedProvidersApiProvidersConnectedGet + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: Get Connected Providers + tags: + - Providers + /api/providers/disconnect/{provider_id}: + delete: + description: Disconnect a provider by removing all its scanner configurations. + operationId: disconnectProviderApiProvidersDisconnectProviderIdDelete + parameters: + - + description: Identifier of the provider to disconnect + in: path + name: provider_id + required: true + schema: + description: Identifier of the provider to disconnect + title: Provider Id + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Disconnect Provider + tags: + - Providers + /api/registry/status: + get: + description: Check whether an asset created via PAPI registry is visible in Platform Search. + operationId: getRegistryAssetStatusApiRegistryStatusGet + parameters: + - + description: Anypoint organization ID the asset was registered under. + in: query + name: organizationId + required: true + schema: + description: Anypoint organization ID the asset was registered under. + title: Organizationid + type: string + - + description: Registry asset ID to look up in Platform Search. + in: query + name: assetId + required: true + schema: + description: Registry asset ID to look up in Platform Search. + title: Assetid + type: string + - + description: API version label used when the asset was registered (e.g. 'v1'). + in: query + name: apiVersion + required: false + schema: + default: v1 + description: API version label used when the asset was registered (e.g. 'v1'). + title: Apiversion + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Registry Asset Status + tags: + - Registry + /api/registry/upload: + post: + description: Upload a pre-built ZIP package directly to the PAPI registry. + operationId: uploadZipToRegistryApiRegistryUploadPost + requestBody: + content: + multipart/form-data: + schema: + $ref: "#/components/schemas/Body_uploadZipToRegistryApiRegistryUploadPost" + description: Request payload for Upload Zip To Registry. + required: true + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Upload Zip To Registry + tags: + - Registry + /api/reports/time-series: + get: + description: Return time-series report data, optionally filtered by metric name. + operationId: getTimeSeriesApiReportsTimeSeriesGet + parameters: + - + description: Filter results to a single metric name + in: query + name: metric_name + required: false + schema: + anyOf: + - + type: string + - + type: "null" + description: Filter results to a single metric name + title: Metric Name + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Time Series + tags: + - Reports + /api/scanner/create: + post: + description: Create a new scanner configuration and store its provider credentials. + operationId: createScannerApiScannerCreatePost + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: Create Scanner + tags: + - Scanner + /api/scanner/delete: + delete: + description: Delete a scanner configuration and its stored credentials. + operationId: deleteScannerApiScannerDeleteDelete + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: Delete Scanner + tags: + - Scanner + /api/scanner/get: + post: + description: Fetch a scanner configuration by ID using a POST body (browser-friendly). + operationId: getScannerPostApiScannerGetPost + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: Get Scanner Post + tags: + - Scanner + /api/scanner/get/{scanner_id}: + get: + description: Fetch a scanner configuration by its ID from the path. + operationId: getScannerApiScannerGetScannerIdGet + parameters: + - + description: Unique scanner configuration ID + in: path + name: scanner_id + required: true + schema: + description: Unique scanner configuration ID + title: Scanner Id + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Scanner + tags: + - Scanner + /api/scanner/last-report: + post: + description: Retrieve the most recent run report for a scanner. + operationId: lastReportApiScannerLastReportPost + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: Last Report + tags: + - Scanner + /api/scanner/list: + get: + description: List all scanner configurations for the current organization. + operationId: listScannersApiScannerListGet + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: List Scanners + tags: + - Scanner + /api/scanner/pause-resume: + post: + description: Pause or resume a scheduled scanner's automatic execution. + operationId: pauseResumeScannerApiScannerPauseResumePost + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: Pause Resume Scanner + tags: + - Scanner + /api/scanner/providers: + get: + description: List supported third-party API discovery provider types. + operationId: listProvidersApiScannerProvidersGet + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: List Providers + tags: + - Scanner + /api/scanner/providers/metadata: + get: + description: Return metadata (auth fields, capabilities) for each configured provider. + operationId: listProviderMetadataApiScannerProvidersMetadataGet + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: List Provider Metadata + tags: + - Scanner + /api/scanner/run: + post: + description: Execute a scanner's discovery workflow to import APIs from the provider. + operationId: runScannerApiScannerRunPost + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: Run Scanner + tags: + - Scanner + /api/scanner/runs/{scanner_id}: + get: + description: List historical execution runs for a scanner. + operationId: scannerRunsApiScannerRunsScannerIdGet + parameters: + - + description: Unique scanner configuration ID + in: path + name: scanner_id + required: true + schema: + description: Unique scanner configuration ID + title: Scanner Id + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Scanner Runs + tags: + - Scanner + /api/scanner/runs/{scanner_id}/{run_id}/agents: + get: + description: List agents discovered during a specific scanner run. + operationId: scannerRunAgentsApiScannerRunsScannerIdRunIdAgentsGet + parameters: + - + description: Unique scanner configuration ID + in: path + name: scanner_id + required: true + schema: + description: Unique scanner configuration ID + title: Scanner Id + type: string + - + description: Identifier of a specific scanner execution run + in: path + name: run_id + required: true + schema: + description: Identifier of a specific scanner execution run + title: Run Id + type: string + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Scanner Run Agents + tags: + - Scanner + /api/scanner/test-connection: + post: + description: Validate provider credentials by performing a connectivity test. + operationId: testConnectionApiScannerTestConnectionPost + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: Test Connection + tags: + - Scanner + /api/scanner/update: + put: + description: Update an existing scanner configuration's settings or credentials. + operationId: updateScannerApiScannerUpdatePut + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: Update Scanner + tags: + - Scanner + /api/slack/channels: + get: + description: |- + Get Slack channels (and optionally app DMs) for the organization. + + Returns list of channels and bot DM conversations available in the + connected Slack workspace. Each item includes a ``type`` field + (``"channel"`` or ``"app_dm"``) so the UI can group them. + + Query params: + include_apps: If true (default), also return bot/app DM conversations. + + Returns: + [ + { + "id": "C01234", + "name": "general", + "isPrivate": false, + "isMember": true, + "memberCount": 42, + "type": "channel" + }, + { + "id": "D09876", + "name": "Mule Agent DM", + "isPrivate": true, + "isMember": true, + "memberCount": 2, + "type": "app_dm" + } + ] + operationId: getChannelsApiSlackChannelsGet + parameters: + - + description: Include bot/app DM conversations alongside channels + in: query + name: include_apps + required: false + schema: + default: true + description: Include bot/app DM conversations alongside channels + title: Include Apps + type: boolean + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Get Channels + tags: + - Slack OAuth + /api/slack/connect/complete: + post: + description: Complete the Slack-to-Anypoint connection flow by storing auth credentials. + operationId: slackConnectCompleteApiSlackConnectCompletePost + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: Slack Connect Complete + tags: + - Slack + /api/slack/credentials: + delete: + description: |- + Uninstall Slack integration for the authenticated user's organization. + + Revokes credentials in Flash API and marks installation as revoked in database. + + Returns: + {"status": "success", "message": "Slack integration uninstalled"} + operationId: uninstallSlackApiSlackCredentialsDelete + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: Uninstall Slack + tags: + - Slack OAuth + /api/slack/events: + post: + description: Receive and dispatch Slack Events API payloads to the Bolt handler. + operationId: slackEventsApiSlackEventsPost + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: Slack Events + tags: + - Slack + /api/slack/installation/status: + get: + description: |- + Get Slack installation status for the authenticated user's organization. + + Checks database for installation status (instant, no Flash API dependency). + + Returns: + { + "status": "not_installed" | "pending_approval" | "installed" | "error", + "teamName": "Workspace Name", # if installed + "teamId": "T01234567" # if installed + } + operationId: getInstallationStatusApiSlackInstallationStatusGet + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: Get Installation Status + tags: + - Slack OAuth + /api/slack/interactions: + post: + description: Receive and dispatch Slack interactive component payloads (buttons, modals, menus). + operationId: slackInteractionsApiSlackInteractionsPost + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: Slack Interactions + tags: + - Slack + /api/slack/oauth/callback: + get: + description: |- + Handle Slack OAuth callback. + + Slack redirects here after user authorizes the app. + + Query params: + state: State token (carrier UUID or custom state ID) - always present + code: OAuth authorization code - present on success + error: Error code if authorization failed - present on denial + + Redirects back to the frontend Notifications page with success/error status. + operationId: handleOauthCallbackApiSlackOauthCallbackGet + parameters: + - + description: State token for CSRF protection + in: query + name: state + required: true + schema: + description: State token for CSRF protection + title: State + type: string + - + description: OAuth authorization code from Slack + in: query + name: code + required: false + schema: + anyOf: + - + type: string + - + type: "null" + description: OAuth authorization code from Slack + title: Code + - + description: Error code if user denied authorization + in: query + name: error + required: false + schema: + anyOf: + - + type: string + - + type: "null" + description: Error code if user denied authorization + title: Error + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/HTTPValidationError" + description: Validation Error + summary: Handle Oauth Callback + tags: + - Slack OAuth + /api/slack/oauth/start: + post: + description: |- + Start Slack OAuth flow for an organization. + + Extracts organization ID from the authenticated user's session. + Creates a state token for CSRF protection and returns the Slack authorization URL. + + Usage: + POST /api/slack/oauth/start + Headers: + Authorization: Bearer + + Returns: + { + "oauth_url": "https://slack.com/oauth/v2/authorize?...", + "state_id": "uuid-..." + } + + Frontend should redirect user to oauth_url. + No request body needed - org_id extracted from auth token. + operationId: startOauthFlowApiSlackOauthStartPost + responses: + "200": + content: + application/json: + schema: + allOf: + - + $ref: "#/components/schemas/SlackOAuthStartResponse" + example: + oauth_url: Oauth Url + state_id: State Id + description: Successful Response + summary: Start Oauth Flow + tags: + - Slack OAuth + /api/slack/status: + get: + description: Expose Slack adapter readiness for local verification. + operationId: slackStatusApiSlackStatusGet + responses: + "200": + content: + application/json: + schema: + example: + {} + description: Successful Response + summary: Slack Status + tags: + - Slack +servers: + - + description: Current deployment + url: / +tags: + - + description: Agent chat, tool invocation, and streaming conversations + name: Agent + - + description: API instance lifecycle, governance reports, and base-path validation + name: API Instances + - + description: Apigee gateway integration — connections, proxies, and policy templates + name: Apigee + - + description: Exchange asset search, metadata retrieval, and spec overview + name: Assets + - + description: Anypoint authentication and user profile + name: Auth + - + description: Platform cost overview, instance costs, and time-series analytics + name: Cost Management + - + description: Flex Gateway discovery, configuration, metrics, and lifecycle + name: Gateways + - + description: Governance conformance, strategy settings, and guardrail management + name: Governance + - + description: Governance insights jobs, reports, and maturity assessment + name: Governance Insights + - + description: Kong Konnect integration — connections, plugins, and control planes + name: Kong + - + description: MCP server provisioning and registration + name: MCP Provisioning + - + description: Runtime monitoring — summaries, charts, entities, alerts, and KPIs + name: Monitoring + - + description: Policy templates, application, validation, and removal + name: Policies + - + description: Third-party gateway provider connections + name: Providers + - + description: PAPI registry asset status and zip uploads + name: Registry + - + description: Time-series analytics and reporting + name: Reports + - + description: API discovery scanners — configuration, execution, and run history + name: Scanner + - + description: Slack adapter status, events, and interactive payloads + name: Slack + - + description: Slack-to-Anypoint OAuth connection flow + name: Slack OAuth + - + description: RFC 9728 OAuth protected-resource metadata + name: Well-Known \ No newline at end of file diff --git a/apis/omni-xapi/exchange.json b/apis/omni-xapi/exchange.json new file mode 100644 index 00000000..142ff816 --- /dev/null +++ b/apis/omni-xapi/exchange.json @@ -0,0 +1,14 @@ +{ + "main": "api.yaml", + "name": "Omni API", + "organizationId": "8bfc8bbf-5508-419e-aadc-77dfe18a8172", + "groupId": "f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform", + "assetId": "omni-api", + "version": "1.0.8", + "metadata": {}, + "apiVersion": "v1", + "classifier": "oas", + "dependencies": [], + "tags": [], + "originalFormatVersion": "3.0" +} \ No newline at end of file From 28840302f8d39db0532bd88c886f9a4daee175a1 Mon Sep 17 00:00:00 2001 From: Mariano de Achaval Date: Fri, 24 Apr 2026 18:11:16 -0300 Subject: [PATCH 2/2] Fix spec --- apis/omni-xapi/api.yaml | 4 ---- 1 file changed, 4 deletions(-) diff --git a/apis/omni-xapi/api.yaml b/apis/omni-xapi/api.yaml index bb681b21..e311d17b 100644 --- a/apis/omni-xapi/api.yaml +++ b/apis/omni-xapi/api.yaml @@ -6634,10 +6634,6 @@ paths: summary: Slack Status tags: - Slack -servers: - - - description: Current deployment - url: / tags: - description: Agent chat, tool invocation, and streaming conversations