openapi: 3.0.0 info: title: API Manager API version: 1.0.0 description: Manage APIs, policies, contracts, and SLA tiers within Anypoint Platform. Create, configure, deploy, and monitor APIs across organizations and environments, including API policies, client application contracts, automated policies, API groups, upstream configurations, and TLS contexts. servers: - url: https://anypoint.mulesoft.com/apimanager/api/v1 description: US - url: https://eu1.anypoint.mulesoft.com/apimanager/api/v1 description: EU - url: https://ca1.platform.mulesoft.com/apimanager/api/v1 description: CA - url: https://jp1.platform.mulesoft.com/apimanager/api/v1 description: JP - url: https://in1.platform.mulesoft.com/apimanager/api/v1 description: IN - url: https://au1.platform.mulesoft.com/apimanager/api/v1 description: AU security: - bearerAuth: [] - clientAuth: [] paths: /organizations/{organizationId}: parameters: - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/applications: post: description: 'Imports a Client Application from an external client provider Connected Apps require Manage Client Applications scope ' responses: '201': description: Application succesfully imported content: application/json: example: id: 550e8400-e29b-41d4-a716-446655440000 message: Resource created successfully '400': description: Invalid request body. Provider might not have import feature enabled content: application/json: example: error: Bad Request message: Invalid request parameters '404': description: Client or provider not found content: application/json: example: error: Not Found message: Resource not found requestBody: content: application/json: schema: $ref: ./apimanager/schemas/application-import.json example: apimanager/examples/responses/application-import.json required: true description: Request body containing the data needed for this operation. summary: Import a client application operationId: importApplication parameters: - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/environments/{environmentId}/apis: get: responses: '200': description: Success. Returns the requested resource. content: application/json: schema: $ref: ./apimanager/schemas/responses/apisSearch.yaml examples: Apis: $ref: ./apimanager/examples/responses/apisSearch.json description: "Retrieves a collection of APIs\n\nConnected Apps require the following scopes:\n - View APIs Configuration\n" parameters: - name: query in: query description: A string that will be checked for a partial or similar matches of the name, description, label and tags allowReserved: true schema: type: string - $ref: '#/components/parameters/param_exchange_group_id_query' - $ref: '#/components/parameters/param_exchange_asset_id_query' - $ref: '#/components/parameters/param_exchange_asset_version_query' - name: instanceLabel in: query description: A string that will be checked for an exact match of the instanceLabel allowReserved: true schema: type: string - name: productVersion in: query description: A string that will be checked for an exact match of the productVersion allowReserved: true schema: type: string - name: autodiscoveryInstanceName in: query description: A string that will be checked for an exact match of the autodiscoveryInstanceName allowReserved: true schema: type: string - name: autodiscoveryApiName in: query description: A string that will be checked for an exact match of the autodiscoveryApiName allowReserved: true schema: type: string - name: family in: query description: Filter API instances by family type. Use "agentic" to list MCP server instances, "llm" for LLM-based APIs, or "api" for standard APIs. schema: type: string enum: - api - agentic - llm - name: filters in: query allowReserved: true description: Comma-separated list of filters, which can be "active" and/or "pinned" schema: type: string - name: offset in: query description: Offset on the amount of assets (each of which has all its apis) schema: default: 0 type: integer - name: limit in: query description: Limit on the amount of assets (each of which has all its apis) schema: default: 100 type: integer - name: sort in: query description: Field to sort results by. Determines the ordering of the returned API list. schema: default: name enum: - id - name - createdDate - updatedDate type: string - name: ascending in: query description: Sort direction. When true, sorts in ascending order; when false, sorts in descending order. schema: default: true allOf: - x-force-coercion-to: boolean - type: boolean summary: List APIs operationId: listApiInstances post: responses: '201': description: Created. The resource was successfully created. content: application/json: schema: $ref: ./apimanager/schemas/responses/promoteApi.yaml examples: Promote: $ref: ./apimanager/examples/responses/promoteApi.json '409': description: Conflict. The request conflicts with the current state of the resource. content: application/json: example: error: Conflict message: Resource already exists or conflicts with existing state description: "Creates a new API\n\nConnected Apps require the following scopes:\n - Manage APIs Configuration\n - Exchange Viewer\n" requestBody: content: application/json: schema: $ref: ./apimanager/schemas/api-oas.json examples: Api: $ref: ./apimanager/examples/apiSpecBody.json multipart/form-data: schema: type: object properties: file: type: string format: binary description: Binary file with the API package in ZIP/Bundle archive. May include tiers, endpoint settings, and policies. instanceLabel: type: string minLength: 1 description: User-defined label that identifies this API instance. Should be unique in the environment. endpoint: type: object description: JSON of endpoint, which will override any enpoint passed in the file and the policies (if any) properties: uri: type: string nullable: true description: The backend implementation URI where the API is deployed (e.g., http://example.com/api). This is the actual service endpoint. proxyUri: type: string nullable: true description: The proxy endpoint URI exposed to consumers through API Manager (e.g., http://proxy.example.com/api). This is the public-facing endpoint. isCloudHub: type: boolean nullable: true description: Indicates whether the API is deployed on CloudHub (true) or on-premises/RTF (false). required: - uri - proxyUri - isCloudHub providerId: type: string description: Client identity system ID. When empty, defaults to CS. required: [] required: true description: Request body containing the data needed for this operation. summary: Create an API operationId: createApiInstance parameters: - $ref: '#/components/parameters/param_environment_id' - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}: get: responses: '200': description: Success. Returns the requested resource. content: application/json: schema: $ref: ./apimanager/schemas/responses/getEnvironmentApi.yaml examples: Api: $ref: ./apimanager/examples/responses/getEnvironmentApi.json description: "Returns an API\n\nConnected Apps require the following scopes:\n - View APIs Configuration\n" parameters: - name: includeProxyTemplate in: query description: Include the configured proxyTemplate to its associated endpoint schema: allOf: - x-force-coercion-to: boolean - type: boolean default: false - name: includeValidation in: query description: Include the configured validation to its associated endpoint schema: allOf: - x-force-coercion-to: boolean - type: boolean default: false - name: includeTlsContexts in: query description: Include the configured TLS contexts schema: allOf: - x-force-coercion-to: boolean - type: boolean default: false summary: Get an API operationId: getApiInstance put: responses: '201': description: Created. The resource was successfully created. content: application/json: schema: $ref: ./apimanager/schemas/responses/updatedApiVersion.yaml examples: Api: $ref: ./apimanager/examples/responses/updatedApiVersion.json description: "Updates an API\n\nConnected Apps require the following scopes:\n - Manage APIs Configuration\n" requestBody: content: application/json: schema: type: object example: name: Updated Resource description: Updated description required: true description: Request body containing the data needed for this operation. summary: Update an API operationId: updateApiInstance patch: responses: '200': description: Success. Returns the requested resource. content: application/json: schema: $ref: ./apimanager/schemas/responses/updatedApiVersion.yaml examples: Api: $ref: ./apimanager/examples/responses/updatedApiVersion.json description: "Updates an API\n\nConnected Apps require the following scopes:\n - Manage APIs Configuration\n" requestBody: content: application/json: schema: type: object example: name: Updated Resource description: Updated description required: true description: Request body containing the data needed for this operation. parameters: - name: force in: query description: Allows patching the API autodiscoveryInstanceName. You may want to change the 'api.version' configuration on all Mule 2 & Mule 3 applications tracking this API. schema: allOf: - x-force-coercion-to: boolean - type: boolean default: false - name: updateApisInSamePort in: query description: For APIs deployed to Flex, if endpoint proxyUri or inbound TLS Contexts are being updated, apis in the same port are also updated schema: allOf: - x-force-coercion-to: boolean - type: boolean default: false summary: Update an API operationId: patchApiInstance delete: responses: '204': description: No Content. The operation completed successfully with no response body. description: "Deletes an API\n\nConnected Apps require the following scopes:\n - Manage APIs Configuration\n" summary: Delete an API operationId: deleteApiInstance parameters: - $ref: '#/components/parameters/param_environment_api_id' - $ref: '#/components/parameters/param_environment_id' - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/pin: put: responses: '201': description: Created. The resource was successfully created. content: application/json: example: id: 550e8400-e29b-41d4-a716-446655440000 message: Resource created successfully description: "Pins an environment API version\n\nConnected Apps require the following scopes:\n - View APIs Configuration\n" summary: Pin an API version operationId: pinApiInstance delete: responses: '204': description: No Content. The operation completed successfully with no response body. description: "Unpins an environment API version\n\nConnected Apps require the following scopes:\n - View APIs Configuration\n" summary: Unpin an API version operationId: unpinApiInstance parameters: - $ref: '#/components/parameters/param_environment_api_id' - $ref: '#/components/parameters/param_environment_id' - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/upstreams: post: responses: '201': description: Created. The resource was successfully created. content: application/json: example: id: 550e8400-e29b-41d4-a716-446655440000 message: Resource created successfully description: "Create an upstream for an API version\n\nConnected Apps require the following scopes:\n - Manage APIs Configuration\n" requestBody: content: application/json: example: uri: https://example.com label: my-upstream schema: $ref: ./apimanager/schemas/upstreamPOST-oas.json required: true description: Request body containing the data needed for this operation. summary: Create an API upstream operationId: createApiInstanceUpstream get: responses: '200': description: Success. Returns the requested resource. content: application/json: schema: $ref: ./apimanager/schemas/responses/upstreams.yaml examples: Upstreams: $ref: ./apimanager/examples/responses/upstreams.json description: "Get API version upstreams\n\nConnected Apps require the following scopes:\n - View APIs Configuration\n" summary: List API upstreams operationId: listApiInstanceUpstreams parameters: - $ref: '#/components/parameters/param_environment_api_id' - $ref: '#/components/parameters/param_environment_id' - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/upstreams/{upstreamId}: get: responses: '200': description: Success. Returns the requested resource. content: application/json: schema: $ref: ./apimanager/schemas/responses/upstream.yaml examples: Upstream: $ref: ./apimanager/examples/responses/upstream.json description: "Get an upstream\n\nConnected Apps require the following scopes:\n - View APIs Configuration\n" summary: Get an API upstream operationId: getApiInstanceUpstream patch: responses: '200': description: Success. Returns the requested resource. content: application/json: schema: $ref: ./apimanager/schemas/responses/upstream.yaml examples: Upstream: $ref: ./apimanager/examples/responses/upstream.json description: "Patch an upstream\n\nConnected Apps require the following scopes:\n - Manage APIs Configuration\n" requestBody: content: application/json: example: uri: https://example.com label: my-upstream schema: $ref: ./apimanager/schemas/upstreamPATCH-oas.json required: true description: Request body containing the data needed for this operation. summary: Update an API upstream operationId: updateApiInstanceUpstream delete: responses: default: description: Response with status code default. content: application/json: example: message: Success description: "Delete an upstream\n\nConnected Apps require the following scopes:\n - Manage APIs Configuration\n" summary: Delete an API upstream operationId: deleteApiInstanceUpstream parameters: - $ref: '#/components/parameters/param_upstream_id' - $ref: '#/components/parameters/param_environment_api_id' - $ref: '#/components/parameters/param_environment_id' - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/policies: get: responses: '200': description: Success. Returns the requested resource. content: application/json: schema: $ref: ./apimanager/schemas/responses/policies.yaml examples: Policies: $ref: ./apimanager/examples/responses/policies.json '304': description: Not Modified. The resource has not been modified since the last request. description: "Gets a collection of API Policies\n\nConnected Apps require the following scopes:\n - View Policies\n" parameters: - name: if-modified-since in: header description: Last modification date (EPOC) schema: type: number - name: standalone in: query description: When true, returns only standalone policies. When false (default), returns all policies regardless of deployment mode. schema: allOf: - x-force-coercion-to: boolean - type: boolean default: false - name: version in: query description: Policy template version to filter by. Format is semantic versioning (e.g., v1, v1.2, v1.2.3). Defaults to v1. allowReserved: true schema: default: v1 pattern: ^v\d+(.\d+)?(.\d+)?$ type: string - name: fullInfo in: query description: if fullInfo = true, Fetches only active policies, with template and configuration data. (Default) if fullInfo = false, Fetches all policies (active + disabled), without template. schema: default: true allOf: - x-force-coercion-to: boolean - type: boolean summary: List API policies operationId: listApiInstancePolicies post: responses: '201': description: The new element has been successfully created. content: application/json: example: id: 550e8400-e29b-41d4-a716-446655440000 message: Resource created successfully description: "Applies a new API Policy\n\nConnected Apps require the following scopes:\n - Manage Policies\n" requestBody: content: application/json: schema: $ref: ./apimanager/schemas/apiPolicy.json example: name: Example Resource description: Example description required: true description: Request body containing the data needed for this operation. summary: Apply a new API policy operationId: applyApiInstancePolicy patch: responses: '200': description: Success. Returns the requested resource. content: application/json: example: message: Resource updated successfully '400': description: Bad Request. The request was invalid or cannot be processed. content: application/json: example: error: Bad Request message: Invalid request parameters description: "Updates multiple policies. Currently, only updates in order field are supported.\n\nConnected Apps require the following scopes:\n - Manage Policies\n" requestBody: content: application/json: example: - id: 51 order: 1 - id: 63 order: 2 schema: type: array items: type: object required: true description: Request body containing the data needed for this operation. summary: Reorder API policies operationId: reorderApiInstancePolicies parameters: - $ref: '#/components/parameters/param_environment_api_id' - $ref: '#/components/parameters/param_environment_id' - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/policies/{policyId}: get: responses: '200': description: Success. Returns the requested resource. content: application/json: schema: $ref: ./apimanager/schemas/responses/policies.yaml examples: Policies: $ref: ./apimanager/examples/responses/policies.json description: "Retrieves a specific policy for the API\n\nConnected Apps require the following scopes:\n - View Policies\n" summary: Get an API policy operationId: getApiInstancePolicy patch: responses: '200': description: Success. Returns the requested resource. content: application/json: example: message: Resource updated successfully description: "Updates an API policy\n\nConnected Apps require the following scopes:\n - Manage Policies\n" requestBody: content: application/json: schema: type: object example: name: Updated Resource description: Updated description required: true description: Request body containing the data needed for this operation. summary: Update an API policy operationId: updateApiInstancePolicy delete: responses: '204': description: No Content. The operation completed successfully with no response body. description: "Unapplies a policy\n\nConnected Apps require the following scopes:\n - Manage Policies\n" summary: Unapply an API policy operationId: unapplyApiInstancePolicy parameters: - $ref: '#/components/parameters/param_policy_id' - $ref: '#/components/parameters/param_environment_api_id' - $ref: '#/components/parameters/param_environment_id' - $ref: '#/components/parameters/param_organization_id' ? /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/policies/{policyId}/implementationAsset : post: responses: '201': description: Created. The resource was successfully created. content: application/json: example: id: 550e8400-e29b-41d4-a716-446655440000 message: Resource created successfully '404': description: Not Found. The requested resource does not exist. content: application/json: example: error: Not Found message: Resource not found description: "Updates the implementation asset\n\nConnected Apps require the following scopes:\n - Manage Policies\n" parameters: - name: dryRun in: query description: Perform a dry run of the implementation update schema: allOf: - x-force-coercion-to: boolean - type: boolean default: false summary: Update policy implementation asset operationId: updateApiInstancePolicyImplementationAsset parameters: - $ref: '#/components/parameters/param_policy_id' - $ref: '#/components/parameters/param_environment_api_id' - $ref: '#/components/parameters/param_environment_id' - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/tiers: get: responses: '200': description: Success. Returns the requested resource. content: application/json: schema: $ref: ./apimanager/schemas/responses/tiers.yaml examples: Tiers: $ref: ./apimanager/examples/responses/tiers.json description: "Retrieves a list of tiers for the supplied API\n\nConnected Apps require the following scopes:\n - View Contracts\n" parameters: - name: active in: query description: Retrieve only active tiers if set to true. schema: allOf: - x-force-coercion-to: boolean - type: boolean default: false - $ref: '#/components/parameters/trait_searchable_offset' - $ref: '#/components/parameters/trait_searchable_limit' - $ref: '#/components/parameters/trait_searchable_sort' - $ref: '#/components/parameters/trait_searchable_ascending' - $ref: '#/components/parameters/trait_searchable_query' summary: List API tiers operationId: listApiInstanceTiers post: responses: '201': description: The new element has been successfully created. content: application/json: schema: $ref: ./apimanager/schemas/responses/tiers.yaml examples: Tiers: $ref: ./apimanager/examples/responses/tiers.json '400': description: Bad Request. The request was invalid or cannot be processed. content: application/json: example: error: Bad Request message: Invalid request parameters '409': description: Conflict. The request conflicts with the current state of the resource. content: application/json: example: error: Conflict message: Resource already exists or conflicts with existing state description: "Creates a sla tier for the API\n\nConnected Apps require the following scopes:\n - Manage Contracts\n" requestBody: content: application/json: schema: $ref: ./apimanager/schemas/tierPOST.json examples: Tier: $ref: ./apimanager/examples/requests/tier.json required: true description: Request body containing the data needed for this operation. summary: Create an SLA tier for the API operationId: createApiInstanceTier head: responses: '200': description: Success. Returns the requested resource. description: Retrieves a count tiers of the API version summary: Count API tiers operationId: checkApiInstanceTiers parameters: - $ref: '#/components/parameters/param_environment_api_id' - $ref: '#/components/parameters/param_environment_id' - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/tiers/{tierId}: put: responses: '201': description: Created. The resource was successfully created. content: application/json: schema: $ref: ./apimanager/schemas/responses/tier.yaml examples: Tier: $ref: ./apimanager/examples/responses/tier.json '400': description: Bad Request. The request was invalid or cannot be processed. content: application/json: example: error: Bad Request message: Invalid request parameters '409': description: Conflict. The request conflicts with the current state of the resource. content: application/json: example: error: Conflict message: Resource already exists or conflicts with existing state description: "Updates a tier associated with an API\n\nConnected Apps require the following scopes:\n - Manage Contracts\n" requestBody: content: application/json: schema: $ref: ./apimanager/schemas/tierPUT.json examples: Tier: $ref: ./apimanager/examples/requests/tier.json required: true description: Request body containing the data needed for this operation. summary: Update an API tier operationId: updateApiInstanceTier delete: responses: '204': description: No Content. The operation completed successfully with no response body. description: "Deletes a tier that has no active applications\n\nConnected Apps require the following scopes:\n - Manage Contracts\n" summary: Delete an API tier operationId: deleteApiInstanceTier parameters: - $ref: '#/components/parameters/param_tier_id' - $ref: '#/components/parameters/param_environment_api_id' - $ref: '#/components/parameters/param_environment_id' - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/group-tiers: head: responses: '200': description: Success. Returns the requested resource. description: Retrieves a count group tiers of the API version summary: Count API group tiers operationId: checkApiInstanceGroupTiers get: responses: '200': description: Success. Returns the requested resource. content: application/json: example: total: 0 data: [] description: Returns a list of elements. summary: List API group tiers operationId: listApiInstanceGroupTiers post: responses: '201': description: The new element has been successfully created. content: application/json: example: id: 550e8400-e29b-41d4-a716-446655440000 message: Resource created successfully description: Creates a new element. requestBody: content: application/json: schema: type: object example: name: Example Resource description: Example description required: true description: Request body containing the data needed for this operation. summary: Create an API group tier operationId: createApiInstanceGroupTier parameters: - $ref: '#/components/parameters/param_environment_api_id' - $ref: '#/components/parameters/param_environment_id' - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/group-contracts: get: responses: '200': description: Success. Returns the requested resource. content: application/json: schema: $ref: ./apimanager/schemas/responses/contracts.yaml examples: Contracts: $ref: ./apimanager/examples/responses/contracts.json description: "Retrieves a list of group contracts of the API version\n\nConnected Apps require the following scopes:\n - View Contracts\n" summary: List API group contracts operationId: listApiInstanceGroupContracts post: responses: '201': description: The new element has been successfully created. content: application/json: example: id: 550e8400-e29b-41d4-a716-446655440000 message: Resource created successfully description: Creates a new element. requestBody: content: application/json: schema: type: object example: name: Example Resource description: Example description required: true description: Request body containing the data needed for this operation. summary: Create an API group contract operationId: createApiInstanceGroupContract parameters: - $ref: '#/components/parameters/param_environment_api_id' - $ref: '#/components/parameters/param_environment_id' - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/contracts: post: responses: '201': description: The new element has been successfully created. content: application/json: schema: $ref: ./apimanager/schemas/responses/contractCreation.yaml examples: Contract: $ref: ./apimanager/examples/responses/contractCreation.json '409': description: Conflict. The request conflicts with the current state of the resource. content: application/json: example: error: Conflict message: Resource already exists or conflicts with existing state description: "Creates new contract between an API and the application\n\nConnected Apps require the following scopes:\n - Manage Contracts\n - Exchange Viewer\n" requestBody: content: application/json: schema: $ref: ./apimanager/schemas/contractPOST.json examples: Contract: $ref: ./apimanager/examples/requests/contractThroughApi.json required: true description: Request body containing the data needed for this operation. summary: Create an API contract operationId: createApiInstanceContract get: responses: '200': description: Success. Returns the requested resource. content: application/json: schema: $ref: ./apimanager/schemas/responses/contracts.yaml examples: Contracts: $ref: ./apimanager/examples/responses/contracts.json description: "Retrieves a list of applications with contracts with the API\n\nConnected Apps require the following scopes:\n - View Contracts\n" parameters: - name: includeExtraApplicationData in: query description: When true, includes additional metadata about the client applications in the response. Defaults to false. schema: allOf: - x-force-coercion-to: boolean - type: boolean default: false - name: includeExtraRedirections in: query description: When true, includes OAuth redirect URI information for each application. Defaults to false. schema: allOf: - x-force-coercion-to: boolean - type: boolean default: false - name: coreServicesId in: query description: Filter contracts by the core services identifier of the client application. schema: type: string - name: status in: query description: Filter contracts by status (e.g., approved, pending, revoked). allowReserved: true schema: type: string - $ref: '#/components/parameters/trait_searchable_offset' - $ref: '#/components/parameters/trait_searchable_limit' - $ref: '#/components/parameters/trait_searchable_sort' - $ref: '#/components/parameters/trait_searchable_ascending' - $ref: '#/components/parameters/trait_searchable_query' summary: List API contracts operationId: listApiInstanceContracts parameters: - $ref: '#/components/parameters/param_environment_api_id' - $ref: '#/components/parameters/param_environment_id' - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/contracts/{contractId}: get: responses: '200': description: Success. Returns the requested resource. content: application/json: schema: $ref: ./apimanager/schemas/responses/contracts.yaml examples: Contracts: $ref: ./apimanager/examples/responses/contracts.json description: "Retrieves a specific contract for the API\n\nConnected Apps require the following scopes:\n - View Contracts\n" summary: Get an API contract operationId: getApiInstanceContract patch: responses: '200': description: Success. Returns the requested resource. content: application/json: schema: $ref: ./apimanager/schemas/responses/contractCreation.yaml examples: Contract: $ref: ./apimanager/examples/responses/contractCreation.json description: "Patches contract conditions.\n\nConnected Apps require the following scopes:\n - Manage Contracts\n - Exchange Viewer\n" requestBody: content: application/json: schema: $ref: ./apimanager/schemas/contractPATCH.json example: name: Updated Resource description: Updated description required: true description: Request body containing the data needed for this operation. summary: Update API contract conditions operationId: updateApiInstanceContract delete: responses: '204': description: No Content. The operation completed successfully with no response body. description: "Deletes the contract\n\nConnected Apps require the following scopes:\n - Manage Contracts\n" summary: Delete an API contract operationId: deleteApiInstanceContract parameters: - $ref: '#/components/parameters/param_contract_id' - $ref: '#/components/parameters/param_environment_api_id' - $ref: '#/components/parameters/param_environment_id' - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/alerts: get: responses: '200': description: Successfully retrieved an API's alert definitions. content: application/json: schema: $ref: ./apimanager/schemas/responses/alerts.yaml examples: Contract: $ref: ./apimanager/examples/responses/alerts.json description: "Retrieves a list of API alerts\n\nConnected Apps require the following scopes:\n - Manage API Alerts\n" summary: List API alerts operationId: listApiInstanceAlerts post: responses: '201': description: Successfully created alert definition. content: application/json: schema: $ref: ./apimanager/schemas/responses/alerts.yaml examples: Contract: $ref: ./apimanager/examples/responses/alerts.json description: "Creates an API alert\n\nConnected Apps require the following scopes:\n - Manage API Alerts\n" requestBody: content: application/json: schema: $ref: ./apimanager/schemas/alert.json examples: Alert: $ref: ./apimanager/examples/requests/alert.json required: true description: Request body containing the data needed for this operation. summary: Create an API alert operationId: createApiInstanceAlert parameters: - $ref: '#/components/parameters/param_environment_api_id' - $ref: '#/components/parameters/param_environment_id' - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/alerts/{alertId}: get: responses: '200': description: Successfully retrieved alert definition. content: application/json: schema: $ref: ./apimanager/schemas/responses/alert.yaml examples: Contract: $ref: ./apimanager/examples/responses/alert.json '401': description: Authentication requirements not fulfilled. content: application/json: example: message: Success '403': description: Insufficient permissions. content: application/json: example: message: Success '404': description: Specified alert not found. content: application/json: example: error: Not Found message: Resource not found description: "Retrieves an API alert\n\nConnected Apps require the following scopes:\n - Manage API Alerts\n" summary: Get an API alert operationId: getApiInstanceAlert patch: responses: '200': description: Successfully updated alert definition. content: application/json: schema: $ref: ./apimanager/schemas/responses/alert.yaml examples: Contract: $ref: ./apimanager/examples/responses/alert.json '400': description: Invalid alert payload. content: application/json: example: error: Bad Request message: Invalid request parameters '401': description: Authentication requirements not fulfilled. content: application/json: example: message: Success '403': description: Insufficient permissions. content: application/json: example: message: Success '404': description: Specified alert not found. content: application/json: example: error: Not Found message: Resource not found description: "Updates an API alert\n\nConnected Apps require the following scopes:\n - Manage API Alerts\n" requestBody: content: application/json: schema: $ref: ./apimanager/schemas/alert.json examples: Alert: $ref: ./apimanager/examples/requests/alert.json required: true description: Request body containing the data needed for this operation. summary: Update an API alert operationId: updateApiInstanceAlert delete: responses: '204': description: Successfully deleted alert definition. '401': description: Authentication requirements not fulfilled. content: application/json: example: message: Success '403': description: Insufficient permissions. content: application/json: example: message: Success '404': description: alert not found. content: application/json: example: error: Not Found message: Resource not found description: "Deletes the specified alert definition\n\nConnected Apps require the following scopes:\n - Manage API Alerts\n" summary: Delete an API alert operationId: deleteApiInstanceAlert parameters: - $ref: '#/components/parameters/param_alert_id' - $ref: '#/components/parameters/param_environment_api_id' - $ref: '#/components/parameters/param_environment_id' - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/bundle: get: responses: '200': description: Success. Returns the requested resource. content: application/json: example: total: 0 data: [] description: "A zip with all the api's information - Equivalent to exporting the api\n\nConnected Apps require the following scopes:\n - View APIs Configuration\n" parameters: - name: slaTiers in: query description: Include SLA tiers. schema: default: false allOf: - x-force-coercion-to: boolean - type: boolean default: false - name: endpoint in: query description: Include endpoint definition and policies. schema: default: false allOf: - x-force-coercion-to: boolean - type: boolean default: false - name: omitPoliciesWithSensitiveFields in: query description: Omit policies with sensitive fields. schema: default: false allOf: - x-force-coercion-to: boolean - type: boolean default: false summary: Export the API bundle operationId: exportApiInstanceBundle parameters: - $ref: '#/components/parameters/param_environment_api_id' - $ref: '#/components/parameters/param_environment_id' - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/tags/{tag}: put: responses: '201': description: Created. The resource was successfully created. content: application/json: example: id: 550e8400-e29b-41d4-a716-446655440000 message: Resource created successfully description: "Adds a new API tag\n\nConnected Apps require the following scopes:\n - Manage APIs Configuration\n" summary: Add a new API tag operationId: addApiInstanceTag delete: responses: '204': description: No Content. The operation completed successfully with no response body. description: "Deletes an API tag\n\nConnected Apps require the following scopes:\n - Manage APIs Configuration\n" summary: Delete an API tag operationId: deleteApiInstanceTag parameters: - name: tag in: path required: true schema: type: string description: The tag to identify the target resource. - $ref: '#/components/parameters/param_environment_api_id' - $ref: '#/components/parameters/param_environment_id' - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/autodiscoveryProperties: get: responses: '200': description: Success. Returns the requested resource. content: application/json: example: total: 0 data: [] description: "Gets the autodiscovery properties required for a gateway to track the API\n\nConnected Apps require the following scopes:\n - View APIs Configuration\n" parameters: - name: gatewayVersion in: query allowReserved: true required: true description: The version of the gateway that will use the autodiscovery properties to track this API, written in semver. schema: type: string summary: Get API autodiscovery properties operationId: getApiInstanceAutodiscoveryProperties parameters: - $ref: '#/components/parameters/param_environment_api_id' - $ref: '#/components/parameters/param_environment_id' - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/tls-contexts: get: responses: '200': description: Successful content: application/json: schema: $ref: ./apimanager/schemas/responses/tlsContexts.yaml examples: Tls: $ref: ./apimanager/examples/responses/tlsContexts.json '400': description: Bad request content: application/json: example: error: Bad Request message: Invalid request parameters '404': description: No TLS Contexts found content: application/json: example: error: Not Found message: Resource not found description: Retrieves TLS Contexts configuration for a given API endpoint summary: Get API TLS context configuration operationId: getApiInstanceTlsContexts post: responses: '201': description: TLS Contexts configuration was created successfully content: application/json: example: id: 550e8400-e29b-41d4-a716-446655440000 message: Resource created successfully '400': description: Bad request content: application/json: example: error: Bad Request message: Invalid request parameters '409': description: TLS Contexts for that API endpoint already existed content: application/json: example: error: Conflict message: Resource already exists or conflicts with existing state description: Creates TLS Contexts configuration requestBody: content: application/json: schema: type: object examples: Tls: $ref: ./apimanager/examples/tlsContextsRequest.json required: true description: Request body containing the data needed for this operation. summary: Create API TLS context configuration operationId: createApiInstanceTlsContexts put: responses: '200': description: TLS Contexts configuration was successfully updated content: application/json: example: message: Resource updated successfully description: Updates TLS Contexts configuration requestBody: content: application/json: schema: type: object examples: Tls: $ref: ./apimanager/examples/tlsContextsRequest.json required: true description: Request body containing the data needed for this operation. summary: Update API TLS context configuration operationId: updateApiInstanceTlsContexts delete: responses: '204': description: TLS Contexts successfully deleted description: Deletes TLS Contexts configuration summary: Delete API TLS context configuration operationId: deleteApiInstanceTlsContexts parameters: - $ref: '#/components/parameters/param_environment_api_id' - $ref: '#/components/parameters/param_environment_id' - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/environments/{environmentId}/groupInstances: post: responses: '201': description: Group instance was created successfully content: application/json: example: id: 550e8400-e29b-41d4-a716-446655440000 message: Resource created successfully '400': description: Bad request content: application/json: example: error: Bad Request message: Invalid request parameters description: "Creates a Group instance\n\nConnected Apps require the following scopes:\n - API Group Administrator\n" requestBody: content: application/json: schema: $ref: ./apimanager/schemas/apiGroups/groupInstance-oas.json examples: GroupContract: $ref: ./apimanager/examples/requests/apiGroups/groupInstanceCreation.json required: true description: Request body containing the data needed for this operation. summary: Create a group instance operationId: createGroupInstance get: responses: '200': description: Success. Returns the requested resource. content: application/json: example: total: 0 data: [] description: "Gets a list of group istances by environmentId\n\nConnected Apps require the following scopes:\n - API Group Administrator\n" summary: List group instances operationId: listGroupInstances parameters: - $ref: '#/components/parameters/param_environment_id' - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/environments/{environmentId}/groupInstances/{groupInstanceId}: get: responses: '200': description: Successful content: application/json: example: id: 550e8400-e29b-41d4-a716-446655440000 name: Example Resource '404': description: Group instance not found content: application/json: example: error: Not Found message: Resource not found description: "Gets a group instance\n\nConnected Apps require the following scopes:\n - API Group Administrator\n" summary: Get a group instance operationId: getGroupInstance patch: responses: '200': description: Success. Returns the requested resource. content: application/json: example: message: Resource updated successfully description: "Updates a group instance\n\nConnected Apps require the following scopes:\n - API Group Administrator\n" requestBody: content: application/json: schema: $ref: ./apimanager/schemas/apiGroups/groupInstanceUpdate-oas.json example: name: Updated Resource description: Updated description required: true description: Request body containing the data needed for this operation. summary: Update a group instance operationId: updateGroupInstance delete: responses: '201': description: Created. The resource was successfully created. content: application/json: example: id: 550e8400-e29b-41d4-a716-446655440000 message: Resource created successfully description: "Deletes a group instance\n\nConnected Apps require the following scopes:\n - API Group Administrator\n" summary: Delete a group instance operationId: deleteGroupInstance parameters: - $ref: '#/components/parameters/param_group_instance_id' - $ref: '#/components/parameters/param_environment_id' - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/environments/{environmentId}/groupInstances/{groupInstanceId}/contracts: post: responses: '201': description: The new element has been successfully created. content: application/json: schema: $ref: ./apimanager/schemas/responses/apiGroups/contractCreation.yaml examples: Contract: $ref: ./apimanager/examples/responses/apiGroups/contractCreation.json '409': description: Conflict. The request conflicts with the current state of the resource. content: application/json: example: error: Conflict message: Resource already exists or conflicts with existing state description: "Creates new contract between a group instance and a application\n\nConnected Apps require the following scopes:\n - API Group Administrator\n - Exchange Viewer\n" requestBody: content: application/json: schema: $ref: ./apimanager/schemas/contractGroupPOST.json examples: Contract: $ref: ./apimanager/examples/requests/contractThroughApi.json required: true description: Request body containing the data needed for this operation. summary: Create a group instance contract operationId: createGroupInstanceContract get: responses: '200': description: Success. Returns the requested resource. content: application/json: schema: $ref: ./apimanager/schemas/responses/apiGroups/groupInstanceContractsRetrieve.yaml examples: GroupContract: $ref: ./apimanager/examples/responses/apiGroups/groupInstanceContractsRetrieve.json description: "Retrieves the list of contracts of a group instances\n\nConnected Apps require the following scopes:\n - API Group Administrator\n" summary: List group instance contracts operationId: listGroupInstanceContracts head: responses: '200': description: Success. Returns the requested resource. description: "Retrieves the count of contracts of a group instances\n\nConnected Apps require the following scopes:\n - API Group Administrator\n" summary: Count group instance contracts operationId: checkGroupInstanceContracts parameters: - $ref: '#/components/parameters/param_group_instance_id' - $ref: '#/components/parameters/param_environment_id' - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/environments/{environmentId}/groupInstances/{groupInstanceId}/contracts/{contractId}: get: responses: '200': description: Success. Returns the requested resource. content: application/json: schema: $ref: ./apimanager/schemas/responses/apiGroups/groupInstanceContractsRetrieve.yaml examples: GroupContract: $ref: ./apimanager/examples/responses/apiGroups/groupInstanceContractsRetrieve.json description: "Retrieves a specific contract for the group instance\n\nConnected Apps require the following scopes:\n - API Group Administrator\n" summary: Get a group instance contract operationId: getGroupInstanceContract delete: responses: '204': description: No Content. The operation completed successfully with no response body. description: "Deletes a group instance contract that is not currently applied\n\nConnected Apps require the following scopes:\n - API Group Administrator\n" summary: Delete a group instance contract operationId: deleteGroupInstanceContract patch: responses: '200': description: Success. Returns the requested resource. content: application/json: example: message: Resource updated successfully description: "Updates a group instance contract\n\nConnected Apps require the following scopes:\n - API Group Administrator\n" summary: Update a group instance contract operationId: updateGroupInstanceContract parameters: - $ref: '#/components/parameters/param_contract_id_string' - $ref: '#/components/parameters/param_group_instance_id' - $ref: '#/components/parameters/param_environment_id' - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/environments/{environmentId}/groupInstances/{groupInstanceId}/tiers: get: responses: '200': description: Successful content: application/json: schema: $ref: ./apimanager/schemas/responses/apiGroups/groupInstanceTiersRetrieve.yaml examples: GroupTier: $ref: ./apimanager/examples/responses/apiGroups/groupInstanceTiersRetrieve.json description: "Retrieves the tiers of a Group instance\n\nConnected Apps require the following scopes:\n - API Group Administrator\n" summary: List group instance tiers operationId: listGroupInstanceTiers post: responses: '201': description: Successful content: application/json: schema: $ref: ./apimanager/schemas/responses/apiGroups/groupInstanceTierCreation.yaml examples: GroupTier: $ref: ./apimanager/examples/responses/apiGroups/groupInstanceTierCreation.json '400': description: Bad request content: application/json: example: error: Bad Request message: Invalid request parameters description: "Creates a Group instance tier\n\nConnected Apps require the following scopes:\n - API Group Administrator\n" requestBody: content: application/json: schema: $ref: ./apimanager/schemas/apiGroups/groupInstanceTier-oas.json examples: GroupTier: $ref: ./apimanager/examples/requests/apiGroups/groupInstanceTierCreation.json required: true description: Request body containing the data needed for this operation. summary: Create a group instance tier operationId: createGroupInstanceTier parameters: - $ref: '#/components/parameters/param_group_instance_id' - $ref: '#/components/parameters/param_environment_id' - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/environments/{environmentId}/groupInstances/{groupInstanceId}/tiers/{tierId}: get: responses: '200': description: Succesful content: application/json: schema: $ref: ./apimanager/schemas/responses/apiGroups/groupInstanceTierRetrieve.yaml examples: GroupTier: $ref: ./apimanager/examples/responses/apiGroups/groupInstanceTierRetrieve.json '404': description: Group instance tier not found content: application/json: example: error: Not Found message: Resource not found description: "Retrieves a group instance tier\n\nConnected Apps require the following scopes:\n - API Group Administrator\n" summary: Get a group instance tier operationId: getGroupInstanceTier delete: responses: '204': description: The element has been deleted successfully. description: "Deletes a tier that has no active applications\n\nConnected Apps require the following scopes:\n - API Group Administrator\n" summary: Delete a group instance tier operationId: deleteGroupInstanceTier put: responses: '200': description: Succesful content: application/json: schema: $ref: ./apimanager/schemas/responses/apiGroups/groupInstanceTierRetrieve.yaml examples: GroupTier: $ref: ./apimanager/examples/responses/apiGroups/groupInstanceTierRetrieve.json '201': description: Created. The resource was successfully created. content: application/json: example: id: 550e8400-e29b-41d4-a716-446655440000 message: Resource created successfully '400': description: Bad request content: application/json: example: error: Bad Request message: Invalid request parameters '404': description: Group instance tier not found content: application/json: example: error: Not Found message: Resource not found description: "Updates a group instance tier\n\nConnected Apps require the following scopes:\n - API Group Administrator\n" requestBody: content: application/json: schema: $ref: ./apimanager/schemas/apiGroups/groupInstanceTierUpdate-oas.json example: name: Updated Resource description: Updated description required: true description: Request body containing the data needed for this operation. summary: Replace a group instance tier operationId: updateGroupInstanceTier patch: responses: '200': description: Success. Returns the requested resource. content: application/json: example: message: Resource updated successfully description: Patches a single element. requestBody: content: application/json: schema: type: object example: name: Updated Resource description: Updated description required: true description: Request body containing the data needed for this operation. summary: Update a group instance tier operationId: patchGroupInstanceTier parameters: - $ref: '#/components/parameters/param_tier_id' - $ref: '#/components/parameters/param_group_instance_id' - $ref: '#/components/parameters/param_environment_id' - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/environments/{environmentId}/groupInstances/{groupInstanceId}/apiInstances: get: responses: '200': description: Success. Returns the requested resource. content: application/json: example: total: 0 data: [] description: "Gets API instances of a group instances\n\nConnected Apps require the following scopes:\n - API Group Administrator\n" summary: List group instance APIs operationId: listGroupInstanceApiInstances parameters: - $ref: '#/components/parameters/param_group_instance_id' - $ref: '#/components/parameters/param_environment_id' - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/environments/{environmentId}/managedServiceApis: get: description: 'Retrieves a collection of Managed Service APIs in the specified environment. Managed Service APIs are deployed and managed through API Manager''s service mesh capabilities. ' responses: '200': description: Success. Returns the requested resource. content: application/json: schema: $ref: ./apimanager/schemas/responses/managedServices/apiList.yaml examples: ApiList: $ref: ./apimanager/examples/responses/managedServices/apiList.json summary: List managed service APIs operationId: listManagedServiceApis parameters: - $ref: '#/components/parameters/param_environment_id' - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/environments/{environmentId}/managedServiceApis/{managedServiceApiId}: get: responses: '200': description: Success. Returns the requested resource. content: application/json: schema: $ref: ./apimanager/schemas/responses/managedServices/managedServiceApiGet.yaml examples: Api: $ref: ./apimanager/examples/responses/managedServices/managedServiceApiGet.json description: Retrieve a specific Managed Service API summary: Get a managed service API operationId: getManagedServiceApi patch: responses: '200': description: Success. Returns the requested resource. content: application/json: schema: $ref: ./apimanager/schemas/responses/managedServices/managedAPI.yaml examples: Api: $ref: ./apimanager/examples/responses/managedServices/managedAPI.json description: Updates endpointUri and providerId of managed service API. requestBody: content: application/json: schema: $ref: ./apimanager/schemas/managedServices/managedServiceApiPatch-oas.json example: name: Updated Resource description: Updated description required: true description: Request body containing the data needed for this operation. summary: Update managed service API details operationId: updateManagedServiceApi parameters: - $ref: '#/components/parameters/param_managed_service_api_id' - $ref: '#/components/parameters/param_environment_id' - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/environments/{environmentId}/managedServiceApis/{managedServiceApiId}/policies: post: responses: '201': description: Created. The resource was successfully created. content: application/json: schema: $ref: ./apimanager/schemas/responses/managedServices/policyPost.yaml examples: Policy: $ref: ./apimanager/examples/responses/managedServices/policyPost.json description: Creates a Managed Service API Policy requestBody: content: application/json: schema: $ref: ./apimanager/schemas/managedServices/managedServiceApiPolicyPost.json example: name: Example Resource description: Example description required: true description: Request body containing the data needed for this operation. summary: Create a managed service API policy operationId: createManagedServiceApiPolicy get: description: 'Retrieves all policies applied to a specific Managed Service API. Returns the policy configuration including order, enabled status, and configuration parameters. ' responses: '200': description: Success. Returns the requested resource. content: application/json: schema: $ref: ./apimanager/schemas/responses/managedServices/policies.yaml examples: Policies: $ref: ./apimanager/examples/responses/managedServices/policies.json '304': description: Not Modified. The resource has not been modified since the last request. parameters: - name: if-none-match in: header description: Last modification date (EPOC) schema: type: number - name: fullInfo in: query schema: default: true allOf: - x-force-coercion-to: boolean - type: boolean description: The fullInfo query parameter. summary: List managed service API policies operationId: listManagedServiceApiPolicies parameters: - $ref: '#/components/parameters/param_managed_service_api_id' - $ref: '#/components/parameters/param_environment_id' - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/environments/{environmentId}/managedServiceApis/{managedServiceApiId}/policies/{policyId}: get: description: 'Retrieves details of a specific policy applied to a Managed Service API. Returns the complete policy configuration including template information and parameter values. ' responses: '200': description: Success. Returns the requested resource. content: application/json: schema: $ref: ./apimanager/schemas/responses/managedServices/policy.yaml examples: Policy: $ref: ./apimanager/examples/responses/managedServices/policy.json summary: Get a managed service API policy operationId: getManagedServiceApiPolicy patch: responses: '200': description: Success. Returns the requested resource. content: application/json: schema: $ref: ./apimanager/schemas/responses/managedServices/policyPatch.yaml examples: Policy: $ref: ./apimanager/examples/responses/managedServices/policyPatch.json description: Updates a Managed Service API Policy requestBody: content: application/json: schema: $ref: ./apimanager/schemas/managedServices/managedServiceApiPolicyPatch.json example: name: Updated Resource description: Updated description required: true description: Request body containing the data needed for this operation. summary: Update a managed service API policy operationId: updateManagedServiceApiPolicy delete: responses: '204': description: No Content. The operation completed successfully with no response body. description: Unapplies a policy. summary: Unapply a managed service API policy operationId: unapplyManagedServiceApiPolicy parameters: - $ref: '#/components/parameters/param_policy_id' - $ref: '#/components/parameters/param_managed_service_api_id' - $ref: '#/components/parameters/param_environment_id' - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/environments/{environmentId}/managedServiceApis/{managedServiceApiId}/tiers: get: responses: '200': description: Success. Returns the requested resource. content: application/json: schema: $ref: ./apimanager/schemas/responses/managedServices/managedServiceApiTiersRetrieve.yaml examples: Tiers: $ref: ./apimanager/examples/responses/managedServices/managedServiceApiTiersRetrieve.json description: Retrieves the tiers of a Managed Service API summary: List managed service API tiers operationId: listManagedServiceApiTiers post: responses: '201': description: Created. The resource was successfully created. content: application/json: schema: $ref: ./apimanager/schemas/responses/managedServices/managedServiceApiTier.yaml examples: Tier: $ref: ./apimanager/examples/responses/managedServices/managedServiceApiTier.json description: Creates a tier for a Managed Service API requestBody: content: application/json: schema: $ref: ./apimanager/schemas/managedServices/managedServiceApiTier-oas.json examples: Tier: $ref: ./apimanager/examples/requests/managedServices/managedServiceApiTier.json required: true description: Request body containing the data needed for this operation. summary: Create a managed service API tier operationId: createManagedServiceApiTier parameters: - $ref: '#/components/parameters/param_managed_service_api_id' - $ref: '#/components/parameters/param_environment_id' - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/environments/{environmentId}/managedServiceApis/{managedServiceApiId}/tiers/{tierId}: put: responses: '201': description: Created. The resource was successfully created. content: application/json: schema: $ref: ./apimanager/schemas/responses/managedServices/managedServiceApiTier.yaml examples: Tier: $ref: ./apimanager/examples/responses/managedServices/managedServiceApiTier.json description: Edit a tier of a Managed Service API requestBody: content: application/json: schema: $ref: ./apimanager/schemas/managedServices/managedServiceApiTierPut-oas.json examples: Tier: $ref: ./apimanager/examples/requests/managedServices/managedServiceApiTier.json required: true description: Request body containing the data needed for this operation. summary: Edit a managed service API tier operationId: updateManagedServiceApiTier delete: responses: '204': description: No Content. The operation completed successfully with no response body. description: Delete a tier of a Managed Service API summary: Delete a managed service API tier operationId: deleteManagedServiceApiTier parameters: - $ref: '#/components/parameters/param_tier_id_managed_service' - $ref: '#/components/parameters/param_managed_service_api_id' - $ref: '#/components/parameters/param_environment_id' - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/environments/{environmentId}/managedServiceApis/{managedServiceApiId}/contracts: get: responses: '200': description: Success. Returns the requested resource. content: application/json: schema: $ref: ./apimanager/schemas/responses/managedServices/managedServiceApiContractsRetrieve.yaml examples: Contracts: $ref: ./apimanager/examples/responses/managedServices/managedServiceApiContractsRetrieve.json description: Retrieves the contracts of a Managed Service API summary: List managed service API contracts operationId: listManagedServiceApiContracts post: responses: '201': description: Created. The resource was successfully created. content: application/json: schema: $ref: ./apimanager/schemas/responses/managedServices/managedServiceApiContract.yaml examples: Contract: $ref: ./apimanager/examples/responses/managedServices/managedServiceApiContract.json description: Creates a contract for a Managed Service API requestBody: content: application/json: schema: $ref: ./apimanager/schemas/managedServices/managedServiceApiContract.json examples: Contract: $ref: ./apimanager/examples/requests/managedServices/managedServiceApiContract.json required: true description: Request body containing the data needed for this operation. summary: Create a managed service API contract operationId: createManagedServiceApiContract parameters: - $ref: '#/components/parameters/param_managed_service_api_id' - $ref: '#/components/parameters/param_environment_id' - $ref: '#/components/parameters/param_organization_id' ? /organizations/{organizationId}/environments/{environmentId}/managedServiceApis/{managedServiceApiId}/contracts/{contractId} : get: responses: '200': description: Success. Returns the requested resource. content: application/json: schema: $ref: ./apimanager/schemas/responses/managedServices/managedServiceApiContractRetrieve.yaml examples: Contract: $ref: ./apimanager/examples/responses/managedServices/managedServiceApiContractRetrieve.json description: Retrieves a contract of a Managed Service API summary: Get a managed service API contract operationId: getManagedServiceApiContract patch: responses: '201': description: Created. The resource was successfully created. content: application/json: schema: $ref: ./apimanager/schemas/responses/managedServices/managedServiceApiContract.yaml examples: Contract: $ref: ./apimanager/examples/responses/managedServices/managedServiceApiContract.json description: Edit a contract of a Managed Service API requestBody: content: application/json: schema: $ref: ./apimanager/schemas/managedServices/managedServiceApiContractPatch.json examples: Contract: $ref: ./apimanager/examples/requests/managedServices/managedServiceApiContractPatch.json required: true description: Request body containing the data needed for this operation. summary: Edit a managed service API contract operationId: updateManagedServiceApiContract delete: responses: '204': description: No Content. The operation completed successfully with no response body. description: Delete a contract of a Managed Service API summary: Delete a managed service API contract operationId: deleteManagedServiceApiContract parameters: - $ref: '#/components/parameters/param_contract_id_string' - $ref: '#/components/parameters/param_managed_service_api_id' - $ref: '#/components/parameters/param_environment_id' - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/custom-policy-templates: get: responses: '200': description: Success. Returns the requested resource. content: application/json: example: total: 0 data: [] description: Retrieves a list of custom policy templates. parameters: - $ref: '#/components/parameters/trait_searchable_offset' - $ref: '#/components/parameters/trait_searchable_limit' - $ref: '#/components/parameters/trait_searchable_sort' - $ref: '#/components/parameters/trait_searchable_ascending' - $ref: '#/components/parameters/trait_searchable_query' summary: List custom policy templates operationId: listCustomPolicyTemplates post: responses: '201': description: The new element has been successfully created. content: application/json: example: id: 550e8400-e29b-41d4-a716-446655440000 message: Resource created successfully '409': description: Conflict. The request conflicts with the current state of the resource. content: application/json: example: error: Conflict message: Resource already exists or conflicts with existing state description: Creates a new custom policy. requestBody: content: multipart/form-data: schema: type: object properties: definition: type: string format: binary description: Policy template definition file in YAML with the implementation and execution logic. configuration: type: string format: binary description: Policy configuration schema file in YAML/JSON defining the configurable parameters. name: type: string description: Unique name identifying the custom policy template. gatewayVersion: type: string description: Target Mule Gateway version (e.g., 4.x, 3.x) determining compatibility. required: [] required: true description: Request body containing the data needed for this operation. summary: Create a custom policy template operationId: createCustomPolicyTemplate parameters: - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/custom-policy-templates/{customPolicyTemplateId}: get: responses: '200': description: Success. Returns the requested resource. content: application/json: example: id: 550e8400-e29b-41d4-a716-446655440000 name: Example Resource description: Returns an instance of a single element. summary: Get a custom policy template operationId: getCustomPolicyTemplate put: responses: '201': description: Created. The resource was successfully created. content: application/json: example: id: 550e8400-e29b-41d4-a716-446655440000 message: Resource created successfully description: Updates a single element. requestBody: content: application/json: schema: type: object example: name: Updated Resource description: Updated description required: true description: Request body containing the data needed for this operation. summary: Replace a custom policy template operationId: updateCustomPolicyTemplate patch: responses: '200': description: Success. Returns the requested resource. content: application/json: example: message: Resource updated successfully description: Patches a single element. requestBody: content: application/json: schema: type: object example: name: Updated Resource description: Updated description required: true description: Request body containing the data needed for this operation. summary: Update a custom policy template operationId: patchCustomPolicyTemplate delete: responses: '204': description: The element has been deleted successfully. description: Deletes the instance of the element specified. summary: Delete a custom policy template operationId: deleteCustomPolicyTemplate parameters: - $ref: '#/components/parameters/param_custom_policy_template_id' - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/custom-policy-templates/{customPolicyTemplateId}/configuration: get: responses: '200': description: Success. Returns the requested resource. content: application/json: example: total: 0 data: [] description: The XML configuration for the custom policy template. summary: Get custom policy template configuration operationId: getCustomPolicyTemplateConfiguration parameters: - $ref: '#/components/parameters/param_custom_policy_template_id' - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/custom-policy-templates/{customPolicyTemplateId}/definition: get: responses: '200': description: Success. Returns the requested resource. content: application/json: example: total: 0 data: [] description: The YAML definition for the custom policy template. summary: Get custom policy template definition operationId: getCustomPolicyTemplateDefinition parameters: - $ref: '#/components/parameters/param_custom_policy_template_id' - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/policy-templates: get: responses: '200': description: Successful. content: application/json: example: total: 0 data: [] '400': description: Bad Request. content: application/json: example: error: Bad Request message: Invalid request parameters '406': description: The requested accept type is not supported. content: application/json: example: message: Success '500': description: An unknown error occurred. content: application/json: example: message: Success description: "Retrieves a list of policy templates\n\nConnected Apps require the following scopes:\n - View Policies\n" parameters: - name: apiInstanceId in: query schema: minimum: 0 maximum: 2147483647 type: integer description: The apiInstance ID query parameter. - name: version in: query allowReserved: true schema: pattern: ^v\d+(.\d+)?(.\d+)?$ type: string description: The version query parameter. summary: List policy templates operationId: listPolicyTemplates parameters: - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/policy-templates/{policyTemplateId}: get: responses: '200': description: Successful. content: application/json: example: id: 550e8400-e29b-41d4-a716-446655440000 name: Example Resource '400': description: Bad Request. content: application/json: example: error: Bad Request message: Invalid request parameters '404': description: There is no policy template defined under the specified id. content: application/json: example: error: Not Found message: Resource not found '406': description: The requested accept type is not supported. content: application/json: example: message: Success '500': description: An unknown error occurred. content: application/json: example: message: Success description: 'Retrieve specific details from the policy template, including the full XML that is being injected as well as all of its configuration parameters. ' parameters: - name: version in: query allowReserved: true schema: pattern: ^v\d+(.\d+)?(.\d+)?$ type: string description: The version query parameter. summary: Get a policy template operationId: getPolicyTemplate parameters: - $ref: '#/components/parameters/param_policy_template_id' - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/automated-policies: head: responses: '200': description: Successful description: "Gets count of Automated Policies that apply to a certain scope\n\nConnected Apps require the following scopes:\n - View Policies\n" parameters: - $ref: '#/components/parameters/XOrigin_environmentId_Query' - name: runtimeVersion in: query allowReserved: true description: A semver string that will be checked for an exact match of Runtime Version schema: type: string summary: Count automated policies operationId: checkAutomatedPolicies get: responses: '200': description: Successful content: application/json: schema: $ref: ./apimanager/schemas/responses/automatedPolicies/automatedPoliciesSearch.yaml examples: AutomatedPolicies: $ref: ./apimanager/examples/responses/automatedPolicies/automatedPoliciesSearch.json '400': description: Bad request content: application/json: example: error: Bad Request message: Invalid request parameters description: "Searches for a list of Automated Policies that apply to a certain scope\n\nConnected Apps require the following scopes:\n - View Policies\n" parameters: - $ref: '#/components/parameters/XOrigin_environmentId_Query' - name: runtimeVersion in: query allowReserved: true description: A semver string that will be checked for an exact match of Runtime Version schema: type: string summary: List automated policies operationId: listAutomatedPolicies post: responses: '201': description: Automated Policy was created successfully content: application/json: example: id: 550e8400-e29b-41d4-a716-446655440000 message: Resource created successfully '400': description: Bad request content: application/json: example: error: Bad Request message: Invalid request parameters '409': description: Automated Policy creation had a conflict content: application/json: example: error: Conflict message: Resource already exists or conflicts with existing state description: "Creates an Automated Policy\n\nConnected Apps require the following scopes:\n - Manage Policies\n" requestBody: content: application/json: schema: $ref: ./apimanager/schemas/automatedPolicy.json examples: AutomatedPolicy: $ref: ./apimanager/examples/requests/automatedPolicy.json required: true description: Request body containing the data needed for this operation. summary: Create an automated policy operationId: createAutomatedPolicy parameters: - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/automated-policies/{automatedPolicyId}: get: responses: '200': description: Successful content: application/json: schema: $ref: ./apimanager/schemas/responses/automatedPolicies/automatedPoliciesRetrieve.yaml examples: AutomatedPolicies: $ref: ./apimanager/examples/responses/automatedPolicies/automatedPoliciesRetrieve.json description: "Retrieves an Automated Policy.\n\nConnected Apps require the following scopes:\n - View Policies\n" summary: Get an automated policy operationId: getAutomatedPolicy patch: responses: '200': description: Automated Policy successfully updated content: application/json: example: message: Resource updated successfully '400': description: Bad request content: application/json: example: error: Bad Request message: Invalid request parameters description: "Updates an Automated Policy\n\nConnected Apps require the following scopes:\n - Manage Policies\n" requestBody: content: application/json: schema: $ref: ./apimanager/schemas/automatedPolicyPATCH-oas.json examples: AutomatedPolicy: $ref: ./apimanager/examples/requests/automatedPolicy.json required: true description: Request body containing the data needed for this operation. summary: Update an automated policy operationId: patchAutomatedPolicy delete: responses: '204': description: Automated Policy successfully deleted '400': description: Bad request content: application/json: example: error: Bad Request message: Invalid request parameters description: "Deletes an Automated Policy\n\nConnected Apps require the following scopes:\n - Manage Policies\n" summary: Delete an automated policy operationId: deleteAutomatedPolicy put: responses: '201': description: Created. The resource was successfully created. content: application/json: example: id: 550e8400-e29b-41d4-a716-446655440000 message: Resource created successfully description: Updates a single element. requestBody: content: application/json: schema: type: object example: name: Updated Resource description: Updated description required: true description: Request body containing the data needed for this operation. summary: Replace an automated policy operationId: updateAutomatedPolicy parameters: - $ref: '#/components/parameters/param_automated_policy_id' - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/automated-policies/{automatedPolicyId}/apis: get: responses: '200': description: Success. Returns the requested resource. content: application/json: schema: $ref: ./apimanager/schemas/responses/apiDefinitions.yaml examples: AutomatedPolicies: $ref: ./apimanager/examples/responses/apiDefinitions.json description: "Gets deployed APIs affected by Automated Policy\n\nConnected Apps require the following scopes:\n - View Policies\n" parameters: - name: type in: query description: Type of query. schema: default: include enum: - include - exclude - all type: string - name: deployedOnly in: query description: Type of requested APIs. schema: default: true allOf: - x-force-coercion-to: boolean - type: boolean - name: runtimes in: query allowReserved: true schema: default: mule3,mule4,flexGateway type: string description: The runtimes query parameter. - name: offset in: query description: Offset on the amount of assets (each of which has all its apis) schema: default: 0 type: integer - name: limit in: query description: Limit on the amount of assets (each of which has all its apis) schema: default: 100 type: integer summary: List APIs affected by policy operationId: listAutomatedPolicyApis parameters: - $ref: '#/components/parameters/param_automated_policy_id' - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/automated-policies/{automatedPolicyId}/incompatible-apis/{environmentApiId}: delete: responses: '204': description: API left uncovered from Automated Policy '404': description: Not Found. The requested resource does not exist. content: application/json: example: error: Not Found message: Resource not found description: Delete Automated Policy coverage over the apiVersion specified due to incompatible implementation for the proxy version. parameters: - $ref: '#/components/parameters/XOrigin_environmentId_Query' summary: Remove incompatible API from policy operationId: deleteAutomatedPolicyIncompatibleApi parameters: - $ref: '#/components/parameters/param_environment_api_id' - $ref: '#/components/parameters/param_automated_policy_id' - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/automated-policies/{automatedPolicyId}/implementationAssets: post: responses: '201': description: Implementation asset successfully deployed content: application/json: example: id: 550e8400-e29b-41d4-a716-446655440000 message: Resource created successfully '404': description: Not Found. The requested resource does not exist. content: application/json: example: error: Not Found message: Resource not found description: "Updates implementation assets\n\nConnected Apps require the following scopes:\n - Manage Policies\n" parameters: - name: dryRun in: query description: Perform a dry run of the implementation update schema: default: false allOf: - x-force-coercion-to: boolean - type: boolean summary: Update policy implementation assets operationId: setAutomatedPolicyImplementationAssets parameters: - $ref: '#/components/parameters/param_automated_policy_id' - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/groups: get: responses: '200': description: Successful content: application/json: schema: $ref: ./apimanager/schemas/responses/apiGroups/groupsSearch.yaml examples: Groups: $ref: ./apimanager/examples/responses/apiGroups/groupsSearch.json '400': description: Bad request content: application/json: example: error: Bad Request message: Invalid request parameters description: "Retrieves all groups within an organization\n\nConnected Apps require the following scopes:\n - API Group Administrator\n" parameters: - name: name in: query allowReserved: true description: Search groups by name schema: type: string summary: List groups operationId: listGroups post: responses: '201': description: Group was created successfully content: application/json: schema: $ref: ./apimanager/schemas/responses/apiGroups/groupCreation.yaml examples: Groups: $ref: ./apimanager/examples/responses/apiGroups/groupCreation.json '400': description: Bad request content: application/json: example: error: Bad Request message: Invalid request parameters description: "Creates a Group\n\nConnected Apps require the following scopes:\n - API Group Administrator\n" requestBody: content: application/json: schema: $ref: ./apimanager/schemas/apiGroups/group-oas.json examples: Group: $ref: ./apimanager/examples/requests/apiGroups/groupCreation.json required: true description: Request body containing the data needed for this operation. summary: Create a group operationId: createGroup parameters: - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/groups/{groupId}: get: responses: '200': description: Successful content: application/json: schema: $ref: ./apimanager/schemas/responses/apiGroups/groupRetrieve.yaml examples: Group: $ref: ./apimanager/examples/responses/apiGroups/groupRetrieve.json '404': description: Group not found content: application/json: example: error: Not Found message: Resource not found description: "Retrieves a Group\n\nConnected Apps require the following scopes:\n - API Group Administrator\n" summary: Get a group operationId: getGroup patch: responses: '200': description: Group successfully updated content: application/json: example: message: Resource updated successfully '400': description: Bad request content: application/json: example: error: Bad Request message: Invalid request parameters description: "Updates a Group\n\nConnected Apps require the following scopes:\n - API Group Administrator\n" requestBody: content: application/json: schema: $ref: ./apimanager/schemas/apiGroups/groupUpdate.json examples: Group: $ref: ./apimanager/examples/requests/apiGroups/groupUpdate.json required: true description: Request body containing the data needed for this operation. summary: Update a group operationId: patchGroup put: responses: '201': description: Created. The resource was successfully created. content: application/json: example: id: 550e8400-e29b-41d4-a716-446655440000 message: Resource created successfully description: Updates a single element. requestBody: content: application/json: schema: type: object example: name: Updated Resource description: Updated description required: true description: Request body containing the data needed for this operation. summary: Replace a group operationId: updateGroup delete: responses: '204': description: The element has been deleted successfully. description: Deletes the instance of the element specified. summary: Delete a group operationId: deleteGroup parameters: - $ref: '#/components/parameters/param_api_group_id' - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/groups/{groupId}/assets: post: responses: '200': description: Group asset successfully created content: application/json: example: id: 550e8400-e29b-41d4-a716-446655440000 message: Resource created successfully '400': description: Bad request content: application/json: example: error: Bad Request message: Invalid request parameters description: "Creates a group asset\n\nConnected Apps require the following scopes:\n - API Group Administrator\n" requestBody: content: application/json: schema: $ref: ./apimanager/schemas/apiGroups/publishGroupVersion.json example: name: Example Resource description: Example description required: true description: Request body containing the data needed for this operation. summary: Create a group asset operationId: createGroupAsset parameters: - $ref: '#/components/parameters/param_api_group_id' - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/groups/{groupId}/versions: post: responses: '201': description: Group was created successfully content: application/json: schema: $ref: ./apimanager/schemas/responses/apiGroups/groupVersionCreation.yaml examples: Group: $ref: apimanager/examples/responses/apiGroups/groupVersionCreation.json '400': description: Bad request content: application/json: example: error: Bad Request message: Invalid request parameters description: "Creates a Group Version\n\nConnected Apps require the following scopes:\n - API Group Administrator\n" requestBody: content: application/json: schema: $ref: ./apimanager/schemas/apiGroups/groupVersion-oas.json examples: Group: $ref: ./apimanager/examples/requests/apiGroups/groupVersionCreation.json required: true description: Request body containing the data needed for this operation. summary: Create a group version operationId: createGroupVersion get: responses: '200': description: Successful content: application/json: schema: $ref: ./apimanager/schemas/responses/apiGroups/groupVersionsRetrieve.yaml examples: Group: $ref: ./apimanager/examples/responses/apiGroups/groupVersionsRetrieve.json description: "Retrieves all versions of a Group\n\nConnected Apps require the following scopes:\n - API Group Administrator\n" summary: List group versions operationId: listGroupVersions parameters: - $ref: '#/components/parameters/param_api_group_id' - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/groups/{groupId}/versions/{groupVersionId}: get: responses: '200': description: Successful content: application/json: schema: $ref: ./apimanager/schemas/responses/apiGroups/groupVersionRetrieve.yaml examples: Group: $ref: ./apimanager/examples/responses/apiGroups/groupVersionRetrieve.json '404': description: Group Version not found content: application/json: example: error: Not Found message: Resource not found description: "Retrieves a Group Version\n\nConnected Apps require the following scopes:\n - API Group Administrator\n" summary: Get a group version operationId: getGroupVersion patch: responses: '200': description: Group Version successfully updated content: application/json: example: message: Resource updated successfully '400': description: Bad request content: application/json: example: error: Bad Request message: Invalid request parameters '404': description: Group Version not found content: application/json: example: error: Not Found message: Resource not found description: "Updates a Group Version\n\nConnected Apps require the following scopes:\n - API Group Administrator\n" requestBody: content: application/json: schema: $ref: ./apimanager/schemas/apiGroups/groupVersionUpdate.json examples: Group: $ref: ./apimanager/examples/requests/apiGroups/groupVersionUpdate.json required: true description: Request body containing the data needed for this operation. summary: Update a group version operationId: patchGroupVersion put: responses: '201': description: Created. The resource was successfully created. content: application/json: example: id: 550e8400-e29b-41d4-a716-446655440000 message: Resource created successfully description: Updates a single element. requestBody: content: application/json: schema: type: object example: name: Updated Resource description: Updated description required: true description: Request body containing the data needed for this operation. summary: Replace a group version operationId: updateGroupVersion delete: responses: '204': description: The element has been deleted successfully. description: Deletes the instance of the element specified. summary: Delete a group version operationId: deleteGroupVersion parameters: - $ref: '#/components/parameters/param_group_version_id' - $ref: '#/components/parameters/param_api_group_id' - $ref: '#/components/parameters/param_organization_id' /organizations/{organizationId}/groups/{groupId}/versions/{groupVersionId}/instances: get: responses: '200': description: Successful content: application/json: schema: $ref: ./apimanager/schemas/responses/apiGroups/groupInstancesRetrieve.yaml examples: Groups: $ref: ./apimanager/examples/responses/apiGroups/groupInstancesRetrieve.json '404': description: Group Version not found content: application/json: example: error: Not Found message: Resource not found description: "Retrieves the instances contained in a Group Version\n\nConnected Apps require the following scopes:\n - API Group Administrator\n" summary: List group version instances operationId: listGroupVersionInstances parameters: - $ref: '#/components/parameters/param_group_version_id' - $ref: '#/components/parameters/param_api_group_id' - $ref: '#/components/parameters/param_organization_id' components: schemas: {} responses: {} parameters: trait_searchable_offset: name: offset in: query description: Skip over a number of elements by specifying an offset value for the query. schema: default: 0 minimum: 0 maximum: 2147483647 type: integer trait_searchable_limit: name: limit in: query description: Limit the number of elements on the response. schema: default: 100 minimum: 0 maximum: 250 type: integer trait_searchable_sort: name: sort in: query allowReserved: true description: Property to sort by. schema: type: string trait_searchable_ascending: name: ascending in: query description: Order for sorting. schema: allOf: - x-force-coercion-to: boolean - type: boolean trait_searchable_query: name: query in: query allowReserved: true description: Search criteria. schema: type: string param_organization_id: $ref: ../../fragments/anypoint_fragment.yaml#/components/parameters/organizationId_Path param_environment_id: $ref: ../../fragments/anypoint_fragment.yaml#/components/parameters/environmentId_Path param_environment_api_id: $ref: ../../fragments/anypoint_fragment.yaml#/components/parameters/environmentApiId_Path param_exchange_asset_id_query: name: assetId in: query allowReserved: true description: Exact match on Exchange asset id (pairs with groupId for a published API spec). schema: type: string x-origin: - api: urn:api:exchange-experience operation: searchAssets name: getAssetsAssetId values: $[*].assetId labels: $[*].name param_exchange_group_id_query: name: groupId in: query description: Exact match on Exchange group id (Maven groupId of the asset). schema: type: string x-origin: - api: urn:api:exchange-experience operation: searchAssets name: getAssetsGroupId values: $[*].groupId labels: $[*].name param_exchange_asset_version_query: name: assetVersion in: query allowReserved: true description: Exact match on published asset version string. schema: type: string x-origin: - api: urn:api:exchange-experience operation: searchAssets description: Align with Exchange asset version for the same assetId + groupId; exact response shape depends on search results. values: $[*].version labels: $[*].name param_upstream_id: name: upstreamId in: path required: true description: Upstream target id for this managed API instance. schema: pattern: '[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}' type: string x-origin: - api: urn:api:api-manager operation: listApiInstanceUpstreams values: $.id labels: $.name param_policy_id: $ref: ../../fragments/anypoint_fragment.yaml#/components/parameters/policyId_Path param_tier_id: $ref: ../../fragments/anypoint_fragment.yaml#/components/parameters/tierId_Path param_contract_id: $ref: ../../fragments/anypoint_fragment.yaml#/components/parameters/contractId_Path param_contract_id_string: $ref: ../../fragments/anypoint_fragment.yaml#/components/parameters/contractId_Path param_tier_id_managed_service: $ref: ../../fragments/anypoint_fragment.yaml#/components/parameters/tierId_Path param_alert_id: name: alertId in: path required: true description: Alert configuration id for this API instance. schema: type: string x-origin: - api: urn:api:api-manager operation: listApiInstanceAlerts values: $.id labels: $.name param_group_instance_id: name: groupInstanceId in: path required: true description: API group instance id in this environment. schema: minimum: 0 maximum: 2147483647 type: integer x-origin: - api: urn:api:api-manager operation: listGroupInstances values: $.id labels: $.name param_managed_service_api_id: name: managedServiceApiId in: path required: true description: Managed (Flex/evented) API instance id in this environment. schema: minimum: 0 maximum: 2147483647 type: integer x-origin: - api: urn:api:api-manager operation: listManagedServiceApis values: $.id labels: $.name param_custom_policy_template_id: $ref: ../../fragments/anypoint_fragment.yaml#/components/parameters/customPolicyTemplateId_Path param_policy_template_id: name: policyTemplateId in: path required: true description: Catalog policy template identifier (org-level). schema: type: string x-origin: - api: urn:api:api-manager operation: listPolicyTemplates values: $.id labels: $.name param_automated_policy_id: name: automatedPolicyId in: path required: true description: Automated policy rule id for the organization. schema: minimum: 0 maximum: 2147483647 type: integer x-origin: - api: urn:api:api-manager operation: listAutomatedPolicies values: $.id labels: $.name param_api_group_id: $ref: ../../fragments/anypoint_fragment.yaml#/components/parameters/groupId_Path param_group_version_id: name: groupVersionId in: path required: true description: Published version id of an API group. schema: minimum: 0 maximum: 2147483647 type: integer x-origin: - api: urn:api:api-manager operation: listGroupVersions values: $.id labels: $.name XOrigin_environmentId_Query: $ref: ../../fragments/anypoint_fragment.yaml#/components/parameters/environmentId_Query examples: {} requestBodies: {} headers: {} securitySchemes: bearerAuth: $ref: ../../fragments/anypoint_fragment.yaml#/components/securitySchemes/bearerAuth clientAuth: $ref: ../../fragments/anypoint_fragment.yaml#/components/securitySchemes/clientAuth links: {} callbacks: {}