# API Manager API

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 ...

- **Version:** 1.0.0
- **Category:** API Management
- **OpenAPI Spec:** [api.yaml](https://dev-portal.mulesoft.com/apis/api-manager/api.yaml)

## Servers
- `https://anypoint.mulesoft.com/apimanager/api/v1`
- `https://{region}.anypoint.mulesoft.com/apimanager/api/v1`
- `https://{region}.platform.mulesoft.com/apimanager/api/v1`

## Operations (118)
### POST /organizations/{organizationId}/applications

**Operation ID:** `createOrganizationsApplications`
Imports a Client Application from an external client provider
Connected Apps require Manage Client Applications scope


**Parameters:**
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### GET /organizations/{organizationId}/environments/{environmentId}/apis

**Operation ID:** `listOrganizationsEnvironmentsApis`
Retrieves a collection of APIs

Connected Apps require the following scopes:
  - View APIs Configuration


**Parameters:**
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |
| `query` | query | A string that will be checked for a partial or similar matches of the name, description, label and tags | optional |
| `groupId` | query | Exact match on Exchange group id (Maven groupId of the asset). | optional |
| `assetId` | query | Exact match on Exchange asset id (pairs with groupId for a published API spec). | optional |
| `assetVersion` | query | Exact match on published asset version string. | optional |
| `instanceLabel` | query | A string that will be checked for an exact match of the instanceLabel | optional |
| `productVersion` | query | A string that will be checked for an exact match of the productVersion | optional |
| `autodiscoveryInstanceName` | query | A string that will be checked for an exact match of the autodiscoveryInstanceName | optional |
| `autodiscoveryApiName` | query | A string that will be checked for an exact match of the autodiscoveryApiName | optional |
| `family` | query | Filter API instances by family type. Use "agentic" to list MCP server instances, "llm" for LLM-based APIs, or "api" for standard APIs. | optional |
| `filters` | query | Comma-separated list of filters, which can be "active" and/or "pinned" | optional |
| `offset` | query | Offset on the amount of assets (each of which has all its apis) | optional |
| `limit` | query | Limit on the amount of assets (each of which has all its apis) | optional |
| `sort` | query | Field to sort results by. Determines the ordering of the returned API list. | optional |
| `ascending` | query | Sort direction. When true, sorts in ascending order; when false, sorts in descending order. | optional |

### POST /organizations/{organizationId}/environments/{environmentId}/apis

**Operation ID:** `createOrganizationsEnvironmentsApis`
Creates a new API

Connected Apps require the following scopes:
  - Manage APIs Configuration
  - Exchange Viewer


**Parameters:**
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### GET /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}

**Operation ID:** `getOrganizationsEnvironmentsApis`
Returns an API

Connected Apps require the following scopes:
  - View APIs Configuration


**Parameters:**
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |
| `includeProxyTemplate` | query | Include the configured proxyTemplate to its associated endpoint | optional |
| `includeValidation` | query | Include the configured validation to its associated endpoint | optional |
| `includeTlsContexts` | query | Include the configured TLS contexts | optional |

### PUT /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}

**Operation ID:** `updateOrganizationsEnvironmentsApis`
Updates an API

Connected Apps require the following scopes:
  - Manage APIs Configuration


**Parameters:**
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### PATCH /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}

**Operation ID:** `patchOrganizationsEnvironmentsApis`
Updates an API

Connected Apps require the following scopes:
  - Manage APIs Configuration


**Parameters:**
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |
| `force` | query | Allows patching the API autodiscoveryInstanceName. You may want to change the 'api.version' configuration on all Mule 2 & Mule 3 applications tracking this API. | optional |
| `updateApisInSamePort` | query | For APIs deployed to Flex, if endpoint proxyUri or inbound TLS Contexts are being updated, apis in the same port are also updated | optional |

### DELETE /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}

**Operation ID:** `deleteOrganizationsEnvironmentsApis`
Deletes an API

Connected Apps require the following scopes:
  - Manage APIs Configuration


**Parameters:**
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### PUT /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/pin

**Operation ID:** `updateOrganizationsEnvironmentsApisPin`
Pins an environment API version

Connected Apps require the following scopes:
  - View APIs Configuration


**Parameters:**
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### DELETE /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/pin

**Operation ID:** `deleteOrganizationsEnvironmentsApisPin`
Unpins an environment API version

Connected Apps require the following scopes:
  - View APIs Configuration


**Parameters:**
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### GET /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/upstreams

**Operation ID:** `listOrganizationsEnvironmentsApisUpstreams`
Get API version upstreams

Connected Apps require the following scopes:
  - View APIs Configuration


**Parameters:**
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### POST /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/upstreams

**Operation ID:** `createOrganizationsEnvironmentsApisUpstreams`
Create an upstream for an API version

Connected Apps require the following scopes:
  - Manage APIs Configuration


**Parameters:**
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### GET /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/upstreams/{upstreamId}

**Operation ID:** `getOrganizationsEnvironmentsApisUpstreams`
Get an upstream

Connected Apps require the following scopes:
  - View APIs Configuration


**Parameters:**
| `upstreamId` | query | Upstream target id for this managed API instance. | required |
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### PATCH /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/upstreams/{upstreamId}

**Operation ID:** `updateOrganizationsEnvironmentsApisUpstreams`
Patch an upstream

Connected Apps require the following scopes:
  - Manage APIs Configuration


**Parameters:**
| `upstreamId` | query | Upstream target id for this managed API instance. | required |
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### DELETE /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/upstreams/{upstreamId}

**Operation ID:** `deleteOrganizationsEnvironmentsApisUpstreams`
Delete an upstream

Connected Apps require the following scopes:
  - Manage APIs Configuration


**Parameters:**
| `upstreamId` | query | Upstream target id for this managed API instance. | required |
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### GET /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/policies

**Operation ID:** `listOrganizationsEnvironmentsApisPolicies`
Gets a collection of API Policies

Connected Apps require the following scopes:
  - View Policies


**Parameters:**
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |
| `if-modified-since` | query | Last modification date (EPOC) | optional |
| `standalone` | query | When true, returns only standalone policies. When false (default), returns all policies regardless of deployment mode. | optional |
| `version` | query | Policy template version to filter by. Format is semantic versioning (e.g., v1, v1.2, v1.2.3). Defaults to v1. | optional |
| `fullInfo` | query | if fullInfo = true, Fetches only active policies, with template and configuration data. (Default) if fullInfo = false,  Fetches all policies (active + disabled), without template. | optional |

### POST /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/policies

**Operation ID:** `createOrganizationsEnvironmentsApisPolicies`
Applies a new API Policy

Connected Apps require the following scopes:
  - Manage Policies


**Parameters:**
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### PATCH /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/policies

**Operation ID:** `updateOrganizationsEnvironmentsApisPoliciesBulk`
Updates multiple policies. Currently, only updates in order field are supported.

Connected Apps require the following scopes:
  - Manage Policies


**Parameters:**
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### GET /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/policies/{policyId}

**Operation ID:** `getOrganizationsEnvironmentsApisPolicies`
Retrieves a specific policy for the API

Connected Apps require the following scopes:
  - View Policies


**Parameters:**
| `policyId` | query | Applied policy instance id on this API instance. | required |
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### PATCH /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/policies/{policyId}

**Operation ID:** `patchOrganizationsEnvironmentsApisPolicy`
Updates an API policy

Connected Apps require the following scopes:
  - Manage Policies


**Parameters:**
| `policyId` | query | Applied policy instance id on this API instance. | required |
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### DELETE /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/policies/{policyId}

**Operation ID:** `deleteOrganizationsEnvironmentsApisPolicies`
Unapplies a policy

Connected Apps require the following scopes:
  - Manage Policies


**Parameters:**
| `policyId` | query | Applied policy instance id on this API instance. | required |
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### POST /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/policies/{policyId}/implementationAsset

**Operation ID:** `createOrganizationsEnvironmentsApisPoliciesImplementationasset`
Updates the implementation asset

Connected Apps require the following scopes:
  - Manage Policies


**Parameters:**
| `policyId` | query | Applied policy instance id on this API instance. | required |
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |
| `dryRun` | query | Perform a dry run of the implementation update | optional |

### GET /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/tiers

**Operation ID:** `listOrganizationsEnvironmentsApisTiers`
Retrieves a list of tiers for the supplied API

Connected Apps require the following scopes:
  - View Contracts


**Parameters:**
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |
| `active` | query | Retrieve only active tiers if set to true. | optional |
| `offset` | query | Skip over a number of elements by specifying an offset value for the query. | optional |
| `limit` | query | Limit the number of elements on the response. | optional |
| `sort` | query | Property to sort by. | optional |
| `ascending` | query | Order for sorting. | optional |
| `query` | query | Search criteria. | optional |

### POST /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/tiers

**Operation ID:** `createOrganizationsEnvironmentsApisTiers`
Creates a sla tier for the API

Connected Apps require the following scopes:
  - Manage Contracts


**Parameters:**
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### HEAD /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/tiers

**Operation ID:** `checkOrganizationsEnvironmentsApisTiers`
Retrieves a count tiers of the API version

**Parameters:**
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### PUT /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/tiers/{tierId}

**Operation ID:** `updateOrganizationsEnvironmentsApisTiers`
Updates a tier associated with an API

Connected Apps require the following scopes:
  - Manage Contracts


**Parameters:**
| `tierId` | query | SLA tier id on this API instance or API group instance tier (integer). | required |
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### DELETE /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/tiers/{tierId}

**Operation ID:** `deleteOrganizationsEnvironmentsApisTiers`
Deletes a tier that has no active applications

Connected Apps require the following scopes:
  - Manage Contracts


**Parameters:**
| `tierId` | query | SLA tier id on this API instance or API group instance tier (integer). | required |
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### GET /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/group-tiers

**Operation ID:** `listOrganizationsEnvironmentsApisGrouptiers`
Returns a list of elements.

**Parameters:**
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### POST /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/group-tiers

**Operation ID:** `createOrganizationsEnvironmentsApisGrouptiers`
Creates a new element.

**Parameters:**
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### HEAD /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/group-tiers

**Operation ID:** `checkOrganizationsEnvironmentsApisGrouptiers`
Retrieves a count group tiers of the API version

**Parameters:**
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### GET /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/group-contracts

**Operation ID:** `listOrganizationsEnvironmentsApisGroupcontracts`
Retrieves a list of group contracts of the API version

Connected Apps require the following scopes:
  - View Contracts


**Parameters:**
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### POST /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/group-contracts

**Operation ID:** `createOrganizationsEnvironmentsApisGroupcontracts`
Creates a new element.

**Parameters:**
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### GET /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/contracts

**Operation ID:** `listOrganizationsEnvironmentsApisContracts`
Retrieves a list of applications with contracts with the API

Connected Apps require the following scopes:
  - View Contracts


**Parameters:**
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |
| `includeExtraApplicationData` | query | When true, includes additional metadata about the client applications in the response. Defaults to false. | optional |
| `includeExtraRedirections` | query | When true, includes OAuth redirect URI information for each application. Defaults to false. | optional |
| `coreServicesId` | query | Filter contracts by the core services identifier of the client application. | optional |
| `status` | query | Filter contracts by status (e.g., approved, pending, revoked). | optional |
| `offset` | query | Skip over a number of elements by specifying an offset value for the query. | optional |
| `limit` | query | Limit the number of elements on the response. | optional |
| `sort` | query | Property to sort by. | optional |
| `ascending` | query | Order for sorting. | optional |
| `query` | query | Search criteria. | optional |

### POST /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/contracts

**Operation ID:** `createOrganizationsEnvironmentsApisContracts`
Creates new contract between an API and the application

Connected Apps require the following scopes:
  - Manage Contracts
  - Exchange Viewer


**Parameters:**
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### GET /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/contracts/{contractId}

**Operation ID:** `getOrganizationsEnvironmentsApisContracts`
Retrieves a specific contract for the API

Connected Apps require the following scopes:
  - View Contracts


**Parameters:**
| `contractId` | query | Client contract id for this API instance. | required |
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### PATCH /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/contracts/{contractId}

**Operation ID:** `updateOrganizationsEnvironmentsApisContracts`
Patches contract conditions.

Connected Apps require the following scopes:
  - Manage Contracts
  - Exchange Viewer


**Parameters:**
| `contractId` | query | Client contract id for this API instance. | required |
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### DELETE /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/contracts/{contractId}

**Operation ID:** `deleteOrganizationsEnvironmentsApisContracts`
Deletes the contract

Connected Apps require the following scopes:
  - Manage Contracts


**Parameters:**
| `contractId` | query | Client contract id for this API instance. | required |
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### GET /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/alerts

**Operation ID:** `listOrganizationsEnvironmentsApisAlerts`
Retrieves a list of API alerts

Connected Apps require the following scopes:
  - Manage API Alerts


**Parameters:**
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### POST /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/alerts

**Operation ID:** `createOrganizationsEnvironmentsApisAlerts`
Creates an API alert

Connected Apps require the following scopes:
  - Manage API Alerts


**Parameters:**
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### GET /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/alerts/{alertId}

**Operation ID:** `getOrganizationsEnvironmentsApisAlerts`
Retrieves an API alert

Connected Apps require the following scopes:
  - Manage API Alerts


**Parameters:**
| `alertId` | query | Alert configuration id for this API instance. | required |
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### PATCH /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/alerts/{alertId}

**Operation ID:** `updateOrganizationsEnvironmentsApisAlerts`
Updates an API alert

Connected Apps require the following scopes:
  - Manage API Alerts


**Parameters:**
| `alertId` | query | Alert configuration id for this API instance. | required |
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### DELETE /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/alerts/{alertId}

**Operation ID:** `deleteOrganizationsEnvironmentsApisAlerts`
Deletes the specified alert definition

Connected Apps require the following scopes:
  - Manage API Alerts


**Parameters:**
| `alertId` | query | Alert configuration id for this API instance. | required |
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### GET /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/bundle

**Operation ID:** `listOrganizationsEnvironmentsApisBundle`
A zip with all the api's information - Equivalent to exporting the api

Connected Apps require the following scopes:
  - View APIs Configuration


**Parameters:**
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |
| `slaTiers` | query | Include SLA tiers. | optional |
| `endpoint` | query | Include endpoint definition and policies. | optional |
| `omitPoliciesWithSensitiveFields` | query | Omit policies with sensitive fields. | optional |

### PUT /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/tags/{tag}

**Operation ID:** `updateOrganizationsEnvironmentsApisTags`
Adds a new API tag

Connected Apps require the following scopes:
  - Manage APIs Configuration


**Parameters:**
| `tag` | query | The tag to identify the target resource. | required |
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### DELETE /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/tags/{tag}

**Operation ID:** `deleteOrganizationsEnvironmentsApisTags`
Deletes an API tag

Connected Apps require the following scopes:
  - Manage APIs Configuration


**Parameters:**
| `tag` | query | The tag to identify the target resource. | required |
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### GET /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/autodiscoveryProperties

**Operation ID:** `listOrganizationsEnvironmentsApisAutodiscoveryproperties`
Gets the autodiscovery properties required for a gateway to track the API

Connected Apps require the following scopes:
  - View APIs Configuration


**Parameters:**
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |
| `gatewayVersion` | query | The version of the gateway that will use the autodiscovery properties to track this API, written in semver. | required |

### GET /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/tls-contexts

**Operation ID:** `listOrganizationsEnvironmentsApisTlscontexts`
Retrieves TLS Contexts configuration for a given API endpoint

**Parameters:**
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### POST /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/tls-contexts

**Operation ID:** `createOrganizationsEnvironmentsApisTlscontexts`
Creates TLS Contexts configuration

**Parameters:**
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### PUT /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/tls-contexts

**Operation ID:** `updateOrganizationsEnvironmentsApisTlscontexts`
Updates TLS Contexts configuration

**Parameters:**
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### DELETE /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/tls-contexts

**Operation ID:** `deleteOrganizationsEnvironmentsApisTlscontexts`
Deletes TLS Contexts configuration

**Parameters:**
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### GET /organizations/{organizationId}/environments/{environmentId}/groupInstances

**Operation ID:** `listOrganizationsEnvironmentsGroupinstances`
Gets a list of group istances by environmentId

Connected Apps require the following scopes:
  - API Group Administrator


**Parameters:**
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### POST /organizations/{organizationId}/environments/{environmentId}/groupInstances

**Operation ID:** `createOrganizationsEnvironmentsGroupinstances`
Creates a Group instance

Connected Apps require the following scopes:
  - API Group Administrator


**Parameters:**
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### GET /organizations/{organizationId}/environments/{environmentId}/groupInstances/{groupInstanceId}

**Operation ID:** `getOrganizationsEnvironmentsGroupinstances`
Gets a group instance

Connected Apps require the following scopes:
  - API Group Administrator


**Parameters:**
| `groupInstanceId` | query | API group instance id in this environment. | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### PATCH /organizations/{organizationId}/environments/{environmentId}/groupInstances/{groupInstanceId}

**Operation ID:** `updateOrganizationsEnvironmentsGroupinstances`
Updates a group instance

Connected Apps require the following scopes:
  - API Group Administrator


**Parameters:**
| `groupInstanceId` | query | API group instance id in this environment. | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### DELETE /organizations/{organizationId}/environments/{environmentId}/groupInstances/{groupInstanceId}

**Operation ID:** `deleteOrganizationsEnvironmentsGroupinstances`
Deletes a group instance

Connected Apps require the following scopes:
  - API Group Administrator


**Parameters:**
| `groupInstanceId` | query | API group instance id in this environment. | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### GET /organizations/{organizationId}/environments/{environmentId}/groupInstances/{groupInstanceId}/contracts

**Operation ID:** `listOrganizationsEnvironmentsGroupinstancesContracts`
Retrieves the list of contracts of a group instances

Connected Apps require the following scopes:
  - API Group Administrator


**Parameters:**
| `groupInstanceId` | query | API group instance id in this environment. | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### POST /organizations/{organizationId}/environments/{environmentId}/groupInstances/{groupInstanceId}/contracts

**Operation ID:** `createOrganizationsEnvironmentsGroupinstancesContracts`
Creates new contract between a group instance and a application

Connected Apps require the following scopes:
  - API Group Administrator
  - Exchange Viewer


**Parameters:**
| `groupInstanceId` | query | API group instance id in this environment. | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### HEAD /organizations/{organizationId}/environments/{environmentId}/groupInstances/{groupInstanceId}/contracts

**Operation ID:** `checkOrganizationsEnvironmentsGroupinstancesContracts`
Retrieves the count of contracts of a group instances

Connected Apps require the following scopes:
  - API Group Administrator


**Parameters:**
| `groupInstanceId` | query | API group instance id in this environment. | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### GET /organizations/{organizationId}/environments/{environmentId}/groupInstances/{groupInstanceId}/contracts/{contractId}

**Operation ID:** `getOrganizationsEnvironmentsGroupinstancesContracts`
Retrieves a specific contract for the group instance

Connected Apps require the following scopes:
  - API Group Administrator


**Parameters:**
| `contractId` | query | Contract id on API group instance or managed service API (string form). | required |
| `groupInstanceId` | query | API group instance id in this environment. | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### PATCH /organizations/{organizationId}/environments/{environmentId}/groupInstances/{groupInstanceId}/contracts/{contractId}

**Operation ID:** `updateOrganizationsEnvironmentsGroupinstancesContracts`
Updates a group instance contract

Connected Apps require the following scopes:
  - API Group Administrator


**Parameters:**
| `contractId` | query | Contract id on API group instance or managed service API (string form). | required |
| `groupInstanceId` | query | API group instance id in this environment. | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### DELETE /organizations/{organizationId}/environments/{environmentId}/groupInstances/{groupInstanceId}/contracts/{contractId}

**Operation ID:** `deleteOrganizationsEnvironmentsGroupinstancesContracts`
Deletes a group instance contract that is not currently applied

Connected Apps require the following scopes:
  - API Group Administrator


**Parameters:**
| `contractId` | query | Contract id on API group instance or managed service API (string form). | required |
| `groupInstanceId` | query | API group instance id in this environment. | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### GET /organizations/{organizationId}/environments/{environmentId}/groupInstances/{groupInstanceId}/tiers

**Operation ID:** `listOrganizationsEnvironmentsGroupinstancesTiers`
Retrieves the tiers of a Group instance

Connected Apps require the following scopes:
  - API Group Administrator


**Parameters:**
| `groupInstanceId` | query | API group instance id in this environment. | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### POST /organizations/{organizationId}/environments/{environmentId}/groupInstances/{groupInstanceId}/tiers

**Operation ID:** `createOrganizationsEnvironmentsGroupinstancesTiers`
Creates a Group instance tier

Connected Apps require the following scopes:
  - API Group Administrator


**Parameters:**
| `groupInstanceId` | query | API group instance id in this environment. | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### GET /organizations/{organizationId}/environments/{environmentId}/groupInstances/{groupInstanceId}/tiers/{tierId}

**Operation ID:** `getOrganizationsEnvironmentsGroupinstancesTiers`
Retrieves a group instance tier

Connected Apps require the following scopes:
  - API Group Administrator


**Parameters:**
| `tierId` | query | SLA tier id on this API instance or API group instance tier (integer). | required |
| `groupInstanceId` | query | API group instance id in this environment. | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### PUT /organizations/{organizationId}/environments/{environmentId}/groupInstances/{groupInstanceId}/tiers/{tierId}

**Operation ID:** `updateOrganizationsEnvironmentsGroupinstancesTiers`
Updates a group instance tier

Connected Apps require the following scopes:
  - API Group Administrator


**Parameters:**
| `tierId` | query | SLA tier id on this API instance or API group instance tier (integer). | required |
| `groupInstanceId` | query | API group instance id in this environment. | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### PATCH /organizations/{organizationId}/environments/{environmentId}/groupInstances/{groupInstanceId}/tiers/{tierId}

**Operation ID:** `patchOrganizationsEnvironmentsGroupinstancesTiers`
Patches a single element.

**Parameters:**
| `tierId` | query | SLA tier id on this API instance or API group instance tier (integer). | required |
| `groupInstanceId` | query | API group instance id in this environment. | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### DELETE /organizations/{organizationId}/environments/{environmentId}/groupInstances/{groupInstanceId}/tiers/{tierId}

**Operation ID:** `deleteOrganizationsEnvironmentsGroupinstancesTiers`
Deletes a tier that has no active applications

Connected Apps require the following scopes:
  - API Group Administrator


**Parameters:**
| `tierId` | query | SLA tier id on this API instance or API group instance tier (integer). | required |
| `groupInstanceId` | query | API group instance id in this environment. | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### GET /organizations/{organizationId}/environments/{environmentId}/groupInstances/{groupInstanceId}/apiInstances

**Operation ID:** `listOrganizationsEnvironmentsGroupinstancesApiinstances`
Gets API instances of a group instances

Connected Apps require the following scopes:
  - API Group Administrator


**Parameters:**
| `groupInstanceId` | query | API group instance id in this environment. | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### GET /organizations/{organizationId}/environments/{environmentId}/managedServiceApis

**Operation ID:** `listOrganizationsEnvironmentsManagedserviceapis`
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.


**Parameters:**
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### GET /organizations/{organizationId}/environments/{environmentId}/managedServiceApis/{managedServiceApiId}

**Operation ID:** `getOrganizationsEnvironmentsManagedserviceapis`
Retrieve a specific Managed Service API

**Parameters:**
| `managedServiceApiId` | query | Managed (Flex/evented) API instance id in this environment. | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### PATCH /organizations/{organizationId}/environments/{environmentId}/managedServiceApis/{managedServiceApiId}

**Operation ID:** `updateOrganizationsEnvironmentsManagedserviceapis`
Updates endpointUri and providerId of managed service API.

**Parameters:**
| `managedServiceApiId` | query | Managed (Flex/evented) API instance id in this environment. | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### GET /organizations/{organizationId}/environments/{environmentId}/managedServiceApis/{managedServiceApiId}/policies

**Operation ID:** `listOrganizationsEnvironmentsManagedserviceapisPolicies`
Retrieves all policies applied to a specific Managed Service API.
Returns the policy configuration including order, enabled status, and configuration
parameters.


**Parameters:**
| `managedServiceApiId` | query | Managed (Flex/evented) API instance id in this environment. | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |
| `if-none-match` | query | Last modification date (EPOC) | optional |
| `fullInfo` | query | The fullInfo query parameter. | optional |

### POST /organizations/{organizationId}/environments/{environmentId}/managedServiceApis/{managedServiceApiId}/policies

**Operation ID:** `createOrganizationsEnvironmentsManagedserviceapisPolicies`
Creates a Managed Service API Policy

**Parameters:**
| `managedServiceApiId` | query | Managed (Flex/evented) API instance id in this environment. | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### GET /organizations/{organizationId}/environments/{environmentId}/managedServiceApis/{managedServiceApiId}/policies/{policyId}

**Operation ID:** `getOrganizationsEnvironmentsManagedserviceapisPolicies`
Retrieves details of a specific policy applied to a Managed Service API.
Returns the complete policy configuration including template information and
parameter values.


**Parameters:**
| `policyId` | query | Applied policy instance id on this API instance. | required |
| `managedServiceApiId` | query | Managed (Flex/evented) API instance id in this environment. | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### PATCH /organizations/{organizationId}/environments/{environmentId}/managedServiceApis/{managedServiceApiId}/policies/{policyId}

**Operation ID:** `updateOrganizationsEnvironmentsManagedserviceapisPolicies`
Updates a Managed Service API Policy

**Parameters:**
| `policyId` | query | Applied policy instance id on this API instance. | required |
| `managedServiceApiId` | query | Managed (Flex/evented) API instance id in this environment. | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### DELETE /organizations/{organizationId}/environments/{environmentId}/managedServiceApis/{managedServiceApiId}/policies/{policyId}

**Operation ID:** `deleteOrganizationsEnvironmentsManagedserviceapisPolicies`
Unapplies a policy.

**Parameters:**
| `policyId` | query | Applied policy instance id on this API instance. | required |
| `managedServiceApiId` | query | Managed (Flex/evented) API instance id in this environment. | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### GET /organizations/{organizationId}/environments/{environmentId}/managedServiceApis/{managedServiceApiId}/tiers

**Operation ID:** `listOrganizationsEnvironmentsManagedserviceapisTiers`
Retrieves the tiers of a Managed Service API

**Parameters:**
| `managedServiceApiId` | query | Managed (Flex/evented) API instance id in this environment. | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### POST /organizations/{organizationId}/environments/{environmentId}/managedServiceApis/{managedServiceApiId}/tiers

**Operation ID:** `createOrganizationsEnvironmentsManagedserviceapisTiers`
Creates a tier for a Managed Service API

**Parameters:**
| `managedServiceApiId` | query | Managed (Flex/evented) API instance id in this environment. | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### PUT /organizations/{organizationId}/environments/{environmentId}/managedServiceApis/{managedServiceApiId}/tiers/{tierId}

**Operation ID:** `updateOrganizationsEnvironmentsManagedserviceapisTiers`
Edit a tier of a Managed Service API

**Parameters:**
| `tierId` | query | Tier id on managed service API (string in this surface). | required |
| `managedServiceApiId` | query | Managed (Flex/evented) API instance id in this environment. | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### DELETE /organizations/{organizationId}/environments/{environmentId}/managedServiceApis/{managedServiceApiId}/tiers/{tierId}

**Operation ID:** `deleteOrganizationsEnvironmentsManagedserviceapisTiers`
Delete a tier of a Managed Service API

**Parameters:**
| `tierId` | query | Tier id on managed service API (string in this surface). | required |
| `managedServiceApiId` | query | Managed (Flex/evented) API instance id in this environment. | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### GET /organizations/{organizationId}/environments/{environmentId}/managedServiceApis/{managedServiceApiId}/contracts

**Operation ID:** `listOrganizationsEnvironmentsManagedserviceapisContracts`
Retrieves the contracts of a Managed Service API

**Parameters:**
| `managedServiceApiId` | query | Managed (Flex/evented) API instance id in this environment. | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### POST /organizations/{organizationId}/environments/{environmentId}/managedServiceApis/{managedServiceApiId}/contracts

**Operation ID:** `createOrganizationsEnvironmentsManagedserviceapisContracts`
Creates a contract for a Managed Service API

**Parameters:**
| `managedServiceApiId` | query | Managed (Flex/evented) API instance id in this environment. | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### GET /organizations/{organizationId}/environments/{environmentId}/managedServiceApis/{managedServiceApiId}/contracts/{contractId}

**Operation ID:** `getOrganizationsEnvironmentsManagedserviceapisContracts`
Retrieves a contract of a Managed Service API

**Parameters:**
| `contractId` | query | Contract id on API group instance or managed service API (string form). | required |
| `managedServiceApiId` | query | Managed (Flex/evented) API instance id in this environment. | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### PATCH /organizations/{organizationId}/environments/{environmentId}/managedServiceApis/{managedServiceApiId}/contracts/{contractId}

**Operation ID:** `updateOrganizationsEnvironmentsManagedserviceapisContracts`
Edit a contract of a Managed Service API

**Parameters:**
| `contractId` | query | Contract id on API group instance or managed service API (string form). | required |
| `managedServiceApiId` | query | Managed (Flex/evented) API instance id in this environment. | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### DELETE /organizations/{organizationId}/environments/{environmentId}/managedServiceApis/{managedServiceApiId}/contracts/{contractId}

**Operation ID:** `deleteOrganizationsEnvironmentsManagedserviceapisContracts`
Delete a contract of a Managed Service API

**Parameters:**
| `contractId` | query | Contract id on API group instance or managed service API (string form). | required |
| `managedServiceApiId` | query | Managed (Flex/evented) API instance id in this environment. | required |
| `environmentId` | query | Runtime environment GUID. **Source:** **listEnvironments** (GET `/organizations/{organizationId}/environments`)
using the **same** `organizationId` (Business Group) as in this API Manager path—use each **`data[].id`**
from the response. Optional query params (**name**, **isProduction**, **type**, **search**, pagination)
help pick the right environment. **getOrganizations** may also include an **environments** array, but
**listEnvironments** is the authoritative list for resolving **environmentId**.
 | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### GET /organizations/{organizationId}/custom-policy-templates

**Operation ID:** `listOrganizationsCustompolicytemplates`
Retrieves a list of custom policy templates.

**Parameters:**
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |
| `offset` | query | Skip over a number of elements by specifying an offset value for the query. | optional |
| `limit` | query | Limit the number of elements on the response. | optional |
| `sort` | query | Property to sort by. | optional |
| `ascending` | query | Order for sorting. | optional |
| `query` | query | Search criteria. | optional |

### POST /organizations/{organizationId}/custom-policy-templates

**Operation ID:** `createOrganizationsCustompolicytemplates`
Creates a new custom policy.

**Parameters:**
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### GET /organizations/{organizationId}/custom-policy-templates/{customPolicyTemplateId}

**Operation ID:** `getOrganizationsCustompolicytemplates`
Returns an instance of a single element.

**Parameters:**
| `customPolicyTemplateId` | query | Organization-scoped custom policy template id. | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### PUT /organizations/{organizationId}/custom-policy-templates/{customPolicyTemplateId}

**Operation ID:** `updateOrganizationsCustompolicytemplates`
Updates a single element.

**Parameters:**
| `customPolicyTemplateId` | query | Organization-scoped custom policy template id. | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### PATCH /organizations/{organizationId}/custom-policy-templates/{customPolicyTemplateId}

**Operation ID:** `patchOrganizationsCustompolicytemplates`
Patches a single element.

**Parameters:**
| `customPolicyTemplateId` | query | Organization-scoped custom policy template id. | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### DELETE /organizations/{organizationId}/custom-policy-templates/{customPolicyTemplateId}

**Operation ID:** `deleteOrganizationsCustompolicytemplates`
Deletes the instance of the element specified.

**Parameters:**
| `customPolicyTemplateId` | query | Organization-scoped custom policy template id. | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### GET /organizations/{organizationId}/custom-policy-templates/{customPolicyTemplateId}/configuration

**Operation ID:** `listOrganizationsCustompolicytemplatesConfiguration`
The XML configuration for the custom policy template.

**Parameters:**
| `customPolicyTemplateId` | query | Organization-scoped custom policy template id. | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### GET /organizations/{organizationId}/custom-policy-templates/{customPolicyTemplateId}/definition

**Operation ID:** `listOrganizationsCustompolicytemplatesDefinition`
The YAML definition for the custom policy template.

**Parameters:**
| `customPolicyTemplateId` | query | Organization-scoped custom policy template id. | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### GET /organizations/{organizationId}/policy-templates

**Operation ID:** `listOrganizationsPolicytemplates`
Retrieves a list of policy templates

Connected Apps require the following scopes:
  - View Policies


**Parameters:**
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |
| `apiInstanceId` | query | The apiInstance ID query parameter. | optional |
| `version` | query | The version query parameter. | optional |

### GET /organizations/{organizationId}/policy-templates/{policyTemplateId}

**Operation ID:** `getOrganizationsPolicytemplates`
Retrieve specific details from the policy template, including the full XML
that is being injected as well as all of its configuration parameters.


**Parameters:**
| `policyTemplateId` | query | Catalog policy template identifier (org-level). | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |
| `version` | query | The version query parameter. | optional |

### GET /organizations/{organizationId}/automated-policies

**Operation ID:** `listOrganizationsAutomatedpolicies`
Searches for a list of Automated Policies that apply to a certain scope

Connected Apps require the following scopes:
  - View Policies


**Parameters:**
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |
| `environmentId` | query | A string that will be checked for an exact match of the Environment ID | required |
| `runtimeVersion` | query | A semver string that will be checked for an exact match of Runtime Version | optional |

### POST /organizations/{organizationId}/automated-policies

**Operation ID:** `createOrganizationsAutomatedpolicies`
Creates an Automated Policy

Connected Apps require the following scopes:
  - Manage Policies


**Parameters:**
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### HEAD /organizations/{organizationId}/automated-policies

**Operation ID:** `checkOrganizationsAutomatedpolicies`
Gets count of Automated Policies that apply to a certain scope

Connected Apps require the following scopes:
  - View Policies


**Parameters:**
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |
| `environmentId` | query | A string that will be checked for an exact match of the Environment ID | required |
| `runtimeVersion` | query | A semver string that will be checked for an exact match of Runtime Version | optional |

### GET /organizations/{organizationId}/automated-policies/{automatedPolicyId}

**Operation ID:** `getOrganizationsAutomatedpolicies`
Retrieves an Automated Policy.

Connected Apps require the following scopes:
  - View Policies


**Parameters:**
| `automatedPolicyId` | query | Automated policy rule id for the organization. | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### PUT /organizations/{organizationId}/automated-policies/{automatedPolicyId}

**Operation ID:** `updateOrganizationsAutomatedpolicies`
Updates a single element.

**Parameters:**
| `automatedPolicyId` | query | Automated policy rule id for the organization. | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### PATCH /organizations/{organizationId}/automated-policies/{automatedPolicyId}

**Operation ID:** `patchOrganizationsAutomatedpolicies`
Updates an Automated Policy

Connected Apps require the following scopes:
  - Manage Policies


**Parameters:**
| `automatedPolicyId` | query | Automated policy rule id for the organization. | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### DELETE /organizations/{organizationId}/automated-policies/{automatedPolicyId}

**Operation ID:** `deleteOrganizationsAutomatedpolicies`
Deletes an Automated Policy

Connected Apps require the following scopes:
  - Manage Policies


**Parameters:**
| `automatedPolicyId` | query | Automated policy rule id for the organization. | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### GET /organizations/{organizationId}/automated-policies/{automatedPolicyId}/apis

**Operation ID:** `listOrganizationsAutomatedpoliciesApis`
Gets deployed APIs affected by Automated Policy

Connected Apps require the following scopes:
  - View Policies


**Parameters:**
| `automatedPolicyId` | query | Automated policy rule id for the organization. | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |
| `type` | query | Type of query. | optional |
| `deployedOnly` | query | Type of requested APIs. | optional |
| `runtimes` | query | The runtimes query parameter. | optional |
| `offset` | query | Offset on the amount of assets (each of which has all its apis) | optional |
| `limit` | query | Limit on the amount of assets (each of which has all its apis) | optional |

### DELETE /organizations/{organizationId}/automated-policies/{automatedPolicyId}/incompatible-apis/{environmentApiId}

**Operation ID:** `deleteOrganizationsAutomatedpoliciesIncompatibleapis`
Delete Automated Policy coverage over the apiVersion specified due to incompatible implementation for the proxy version.

**Parameters:**
| `environmentApiId` | query | Managed API instance id in this environment (API Manager deployment). | required |
| `automatedPolicyId` | query | Automated policy rule id for the organization. | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |
| `environmentId` | query | A string that will be checked for an exact match of the Environment ID | required |

### POST /organizations/{organizationId}/automated-policies/{automatedPolicyId}/implementationAssets

**Operation ID:** `createOrganizationsAutomatedpoliciesImplementationassets`
Updates implementation assets

Connected Apps require the following scopes:
  - Manage Policies


**Parameters:**
| `automatedPolicyId` | query | Automated policy rule id for the organization. | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |
| `dryRun` | query | Perform a dry run of the implementation update | optional |

### GET /organizations/{organizationId}/groups

**Operation ID:** `listOrganizationsGroups`
Retrieves all groups within an organization

Connected Apps require the following scopes:
  - API Group Administrator


**Parameters:**
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |
| `name` | query | Search groups by name | optional |

### POST /organizations/{organizationId}/groups

**Operation ID:** `createOrganizationsGroups`
Creates a Group

Connected Apps require the following scopes:
  - API Group Administrator


**Parameters:**
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### GET /organizations/{organizationId}/groups/{groupId}

**Operation ID:** `getOrganizationsGroups`
Retrieves a Group

Connected Apps require the following scopes:
  - API Group Administrator


**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### PUT /organizations/{organizationId}/groups/{groupId}

**Operation ID:** `updateOrganizationsGroups`
Updates a single element.

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### PATCH /organizations/{organizationId}/groups/{groupId}

**Operation ID:** `patchOrganizationsGroups`
Updates a Group

Connected Apps require the following scopes:
  - API Group Administrator


**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### DELETE /organizations/{organizationId}/groups/{groupId}

**Operation ID:** `deleteOrganizationsGroups`
Deletes the instance of the element specified.

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### POST /organizations/{organizationId}/groups/{groupId}/assets

**Operation ID:** `createOrganizationsGroupsAssets`
Creates a group asset

Connected Apps require the following scopes:
  - API Group Administrator


**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### GET /organizations/{organizationId}/groups/{groupId}/versions

**Operation ID:** `listOrganizationsGroupsVersions`
Retrieves all versions of a Group

Connected Apps require the following scopes:
  - API Group Administrator


**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### POST /organizations/{organizationId}/groups/{groupId}/versions

**Operation ID:** `createOrganizationsGroupsVersions`
Creates a Group Version

Connected Apps require the following scopes:
  - API Group Administrator


**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### GET /organizations/{organizationId}/groups/{groupId}/versions/{groupVersionId}

**Operation ID:** `getOrganizationsGroupsVersions`
Retrieves a Group Version

Connected Apps require the following scopes:
  - API Group Administrator


**Parameters:**
| `groupVersionId` | query | Published version id of an API group. | required |
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### PUT /organizations/{organizationId}/groups/{groupId}/versions/{groupVersionId}

**Operation ID:** `updateOrganizationsGroupsVersions`
Updates a single element.

**Parameters:**
| `groupVersionId` | query | Published version id of an API group. | required |
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### PATCH /organizations/{organizationId}/groups/{groupId}/versions/{groupVersionId}

**Operation ID:** `patchOrganizationsGroupsVersions`
Updates a Group Version

Connected Apps require the following scopes:
  - API Group Administrator


**Parameters:**
| `groupVersionId` | query | Published version id of an API group. | required |
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### DELETE /organizations/{organizationId}/groups/{groupId}/versions/{groupVersionId}

**Operation ID:** `deleteOrganizationsGroupsVersions`
Deletes the instance of the element specified.

**Parameters:**
| `groupVersionId` | query | Published version id of an API group. | required |
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |

### GET /organizations/{organizationId}/groups/{groupId}/versions/{groupVersionId}/instances

**Operation ID:** `listOrganizationsGroupsVersionsInstances`
Retrieves the instances contained in a Group Version

Connected Apps require the following scopes:
  - API Group Administrator


**Parameters:**
| `groupVersionId` | query | Published version id of an API group. | required |
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `organizationId` | query | **Business group** GUID. API Manager scopes resources by Anypoint Business Group, which may be:
- **`id`** — the organization returned by **getOrganizations** (GET `/organizations/{organizationId}`), or
- **any element of `subOrganizationIds`** — a **child Business Group** under that org.
The same UUID shape is used for root and sub-orgs. Resolve **environmentId** via **listEnvironments**
for the same Business Group (see **param_environment_id**).
 | required |


## Related Skills
- [apply-policy-to-api-instance](https://dev-portal.mulesoft.com/skills/apply-policy-to-api-instance.md) — Apply a policy to an existing API Manager instance. Use when the user wants to
add a policy, enforce security, configure rate limiting, apply OAuth2, set up
IP allowlisting, or protect an API with any policy template from the catalog.
- [secure-agent](https://dev-portal.mulesoft.com/skills/secure-agent.md) — Secure an agent by applying a policy from the catalog. Handles multiple
starting points: from an existing API Manager instance, from an agent asset
in Exchange, or from scratch by publishing the agent first. Use when the user
wants to secure an agent, add rate limiting, apply OAuth2, enforce IP
allowlisting, or protect any agent with a policy — regardless of where they
are in the setup process.
- [secure-api](https://dev-portal.mulesoft.com/skills/secure-api.md) — Secure an API by applying a policy from the catalog. Handles multiple starting
points: from an existing API Manager instance, from an Exchange asset that needs
an instance, or from scratch. Use when the user wants to secure an API, add
rate limiting, apply OAuth2, enforce IP allowlisting, or protect any API with
a policy — regardless of where they are in the setup process.
- [secure-mcp-server](https://dev-portal.mulesoft.com/skills/secure-mcp-server.md) — Secure an MCP server by applying a policy from the catalog. Handles multiple
starting points: from an existing API Manager instance, from an MCP server asset
in Exchange, or from scratch by publishing the MCP server first. Use when the user
wants to secure an MCP server, add rate limiting, apply OAuth2, enforce IP
allowlisting, or protect any MCP server with a policy — regardless of where they
are in the setup process.