# Exchange Experience API

Manage assets, reviews, ratings, and portal customizations in Anypoint Exchange. Search, publish, and consume reusable API and integration assets.

- **Version:** 2.0.1
- **Category:** Exchange
- **OpenAPI Spec:** [api.yaml](https://dev-portal.mulesoft.com/apis/exchange-experience/api.yaml)

## Servers
- `https://anypoint.mulesoft.com/exchange/api/v2` — Anypoint URL
- `https://{region}.anypoint.mulesoft.com/exchange/api/v2` — Regional Anypoint URL
- `https://{region}.platform.mulesoft.com/exchange/api/v2` — Regional Anypoint URL
- `/api/v2` — Base URI

## Operations (152)
### POST /assets

**Operation ID:** `createAssets`
Uploads an asset

**Parameters:**
| `Content-Type` | query | The Content Type header value. | optional |
| `x-allowed-api-spec-formats` | query | The x allowed api spec formats header value. | optional |
| `x-file-validation` | query | The x file validation header value. | optional |
| `x-strict-package` | query | Indicates if file is immutable. | optional |
| `x-user-id` | query | The x user id header value. | optional |
| `x-snapshots-allowed` | query | Indicates if snapshot publicataion is enabled. | optional |

### GET /assets/search

**Operation ID:** `getAssetsSearch`
Gets a paginated set of assets

**Parameters:**
| `limit` | query | Amount of objects retrieved in the response | optional |
| `offset` | query | The offset specifies the offset of the first row to return | optional |
| `sort` | query | Property to sort by | optional |
| `ascending` | query | Order for sorting | optional |
| `sharedWithMe` | query | Filter assets that are shared with me | optional |
| `types` | query | Filter assets by type | optional |
| `rootOrganizationId` | query | Root organization ID to scope the asset search | optional |

### PATCH /assets/{groupId}/{assetId}

**Operation ID:** `patchAssetsByGroupidByAssetid`
Updates asset metadata (name and description)

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |

### DELETE /assets/{groupId}/{assetId}

**Operation ID:** `deleteAssetsByGroupidByAssetid`
Deletes an asset

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `X-Delete-Type` | query | The X Delete Type header value. | optional |

### GET /assets/{groupId}/{assetId}/metrics

**Operation ID:** `getAssetsByGroupidByAssetidMetrics`
Gets metrics given a groupId and assetId

**Parameters:**
| `periodType` | query | The periodType query parameter. | optional |
| `format` | query | The format query parameter. | optional |
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |

### GET /assets/{groupId}/{assetId}/metrics/versions

**Operation ID:** `getAssetsByGroupidByAssetidMetricsVersions`
Gets metrics by version given a groupId and assetId

**Parameters:**
| `format` | query | The format query parameter. | optional |
| `periodType` | query | The periodType query parameter. | optional |
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `accept` | query | The accept header value. | optional |

### PUT /assets/{groupId}/{assetId}/icon

**Operation ID:** `updateAssetsByGroupidByAssetidIcon`
Uploads an icon as a binary file

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |

### DELETE /assets/{groupId}/{assetId}/icon

**Operation ID:** `deleteAssetsByGroupidByAssetidIcon`
Delete an icon for the whole ga

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |

### PUT /assets/{groupId}/{assetId}/public

**Operation ID:** `updateAssetsByGroupidByAssetidPublic`
Sets the public versions for the asset

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |

### GET /assets/{groupId}/{assetId}/asset

**Operation ID:** `getAssetsByGroupidByAssetidAsset`
Gets an asset

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |

### GET /assets/{groupId}/{assetId}/minorVersions/{minorVersion}/portal/search

**Operation ID:** `getAssetsByGroupidByAssetidMinorversionsByMinorversionPortalSearch`
Retrieves a search.

**Parameters:**
| `term` | query | The term query parameter. | required |
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `minorVersion` | query | Minor version | required |

### GET /assets/{groupId}/{assetId}/versionGroups

**Operation ID:** `getAssetsByGroupidByAssetidVersiongroups`
Gets asset version groups

**Parameters:**
| `status` | query | Filter versions that matches the status indicated. Should be one of deprecated, development or published | optional |
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |

### GET /assets/{groupId}/{assetId}/versionGroups/{versionGroup}/apiGroupInstances

**Operation ID:** `getAssetsByGroupidByAssetidVersiongroupsByVersiongroupApigroupinstances`
Gets API Group Instance

**Parameters:**
| `limit` | query | Amount of objects retrieved in the response | optional |
| `offset` | query | The offset specifies the offset of the first row to return | optional |
| `sort` | query | Property to sort by | optional |
| `ascending` | query | Order for sorting | optional |
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `versionGroup` | query | Version group of the asset | required |

### PATCH /assets/{groupId}/{assetId}/versionGroups/{versionGroup}/environments/{environmentId}/apiGroupInstances/{apiGroupInstanceId}

**Operation ID:** `patchAssetsByGroupidByAssetidVersiongroupsByVersiongroupEnvironmentsByEnvironmentidApigroupinstancesByApigroupinstanceid`
Updates API Group visibility

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `versionGroup` | query | Version group of the asset | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `apiGroupInstanceId` | query | The apiGroupInstance ID to identify the target resource. | required |

### GET /assets/{groupId}/{assetId}/versionGroups/{versionGroup}/environments/{environmentId}/apiGroupInstances/{apiGroupInstanceId}/tiers

**Operation ID:** `getAssetsByGroupidByAssetidVersiongroupsByVersiongroupEnvironmentsByEnvironmentidApigroupinstancesByApigroupinstanceidTiers`
Gets a list of tiers

**Parameters:**
| `versionGroup` | query | Version group of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `groupId` | query | groupId of the asset | required |
| `apiGroupInstanceId` | query | The apiGroupInstance ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |

### GET /assets/{groupId}/{assetId}/versionGroups/{versionGroup}/terms

**Operation ID:** `getAssetsByGroupidByAssetidVersiongroupsByVersiongroupTerms`
Gets Terms and Conditions associated to the API

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `versionGroup` | query | Version group of the asset | required |

### GET /assets/{groupId}/{assetId}/versionGroups/{versionGroup}/instances

**Operation ID:** `getAssetsByGroupidByAssetidVersiongroupsByVersiongroupInstances`
Gets API instances

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `versionGroup` | query | Version group of the asset | required |

### GET /assets/{groupId}/{assetId}/versionGroups/{versionGroup}/instances/{apiInstanceId}/relatedApiGroupInstances

**Operation ID:** `getAssetsByGroupidByAssetidVersiongroupsByVersiongroupInstancesByApiinstanceidRelatedapigroupinstances`
Gets API group instances that include an API instance

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `versionGroup` | query | Version group of the asset | required |
| `apiInstanceId` | query | The apiInstance ID to identify the target resource. | required |

### GET /assets/{groupId}/{assetId}/versionGroups/{versionGroup}/instances/{apiId}/tiers

**Operation ID:** `getAssetsByGroupidByAssetidVersiongroupsByVersiongroupInstancesByApiidTiers`
Gets a list of tiers

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `versionGroup` | query | Version group of the asset | required |
| `apiId` | query | The api ID to identify the target resource. | required |

### POST /assets/{groupId}/{assetId}/versionGroups/{versionGroup}/instances/evented-apis/external

**Operation ID:** `createAssetsByGroupidByAssetidVersiongroupsByVersiongroupInstancesEventedApisExternal`
Creates a new external API instance for an evented API

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `versionGroup` | query | Version group of the asset | required |

### PATCH /assets/{groupId}/{assetId}/versionGroups/{versionGroup}/instances/evented-apis/external/{id}

**Operation ID:** `patchAssetsByGroupidByAssetidVersiongroupsByVersiongroupInstancesEventedApisExternalById`
Updates an existing external API instance

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `versionGroup` | query | Version group of the asset | required |
| `id` | query | The id to identify the target resource. | required |

### POST /assets/{groupId}/{assetId}/versionGroups/{versionGroup}/instances/external

**Operation ID:** `createAssetsByGroupidByAssetidVersiongroupsByVersiongroupInstancesExternal`
Creates a new external API instance

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `versionGroup` | query | Version group of the asset | required |

### DELETE /assets/{groupId}/{assetId}/versionGroups/{versionGroup}/instances/external

**Operation ID:** `deleteAssetsByGroupidByAssetidVersiongroupsByVersiongroupInstancesExternal`
Deletes all instance instances from Version Group

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `versionGroup` | query | Version group of the asset | required |

### PATCH /assets/{groupId}/{assetId}/versionGroups/{versionGroup}/instances/external/{id}

**Operation ID:** `patchAssetsByGroupidByAssetidVersiongroupsByVersiongroupInstancesExternalById`
Updates an existing external API instance

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `versionGroup` | query | Version group of the asset | required |
| `id` | query | The id to identify the target resource. | required |

### DELETE /assets/{groupId}/{assetId}/versionGroups/{versionGroup}/instances/external/{id}

**Operation ID:** `deleteAssetsByGroupidByAssetidVersiongroupsByVersiongroupInstancesExternalById`
Deletes an existing external API instance

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `versionGroup` | query | Version group of the asset | required |
| `id` | query | The id to identify the target resource. | required |

### PATCH /assets/{groupId}/{assetId}/versionGroups/{versionGroup}/instances/managed/{id}

**Operation ID:** `patchAssetsByGroupidByAssetidVersiongroupsByVersiongroupInstancesManagedById`
Updates an existing managed API instance

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `versionGroup` | query | Version group of the asset | required |
| `id` | query | The id to identify the target resource. | required |

### GET /assets/{groupId}/{assetId}/identities

**Operation ID:** `getAssetsByGroupidByAssetidIdentities`
A collection of identities assigned to an asset with their role

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `search` | query | Search parameter used to filter facets | optional |

### PUT /assets/{groupId}/{assetId}/identities

**Operation ID:** `updateAssetsByGroupidByAssetidIdentities`
Assigns identities to an asset

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `x-skip-notifications` | query | The x skip notifications header value. | optional |

### GET /assets/{groupId}/{assetId}/domain

**Operation ID:** `getAssetsByGroupidByAssetidDomain`
Gets domain

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |

### GET /assets/{groupId}/{assetId}/{version}

**Operation ID:** `getAssetsByGroupidByAssetidByVersion`
Get a particular asset by its id

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |
| `includeSnapshots` | query | Filters results depending on whether the snapshots is enabled or not | optional |
| `status` | query | Filter versions that matches the status indicated. Should be one of deprecated, development or published | optional |
| `strict` | query | Asset related versions populated into `otherVersions` property will also have the filters for this query applied, e.g.: if status filter is applied, then related versions will have the status filter also applied, otherwise all possible status will be returned. Defaults to `true` | optional |

### DELETE /assets/{groupId}/{assetId}/{version}

**Operation ID:** `deleteAssetsByGroupidByAssetidByVersion`
Deletes an asset by its ID

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |
| `X-Delete-Type` | query | The X Delete Type header value. | optional |

### PUT /assets/{groupId}/{assetId}/{version}/icon

**Operation ID:** `updateAssetsByGroupidByAssetidByVersionIcon`
Uploads an icon as a binary file.
- Body should be application/json. This is not specified in the raml as it conflicts with Osprey.


**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |

### GET /assets/{groupId}/{assetId}/{version}/asset

**Operation ID:** `getAssetsByGroupidByAssetidByVersionAsset`
Gets an asset

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |

### GET /assets/{groupId}/{assetId}/{version}/rating

**Operation ID:** `getAssetsByGroupidByAssetidByVersionRating`
Gets the asset rating

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |

### GET /assets/{groupId}/{assetId}/{version}/reviews

**Operation ID:** `getAssetsByGroupidByAssetidByVersionReviews`
Gets a list of reviews

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |
| `includeComments` | query | Indicates to include comments or not in reviews | optional |

### POST /assets/{groupId}/{assetId}/{version}/reviews

**Operation ID:** `createAssetsByGroupidByAssetidByVersionReviews`
Creates a new asset review

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |

### PATCH /assets/{groupId}/{assetId}/{version}/reviews/{reviewId}

**Operation ID:** `patchAssetsByGroupidByAssetidByVersionReviewsByReviewid`
Edits an asset review

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |
| `reviewId` | query | The review ID to identify the target resource. | required |

### DELETE /assets/{groupId}/{assetId}/{version}/reviews/{reviewId}

**Operation ID:** `deleteAssetsByGroupidByAssetidByVersionReviewsByReviewid`
Deletes an specific asset review.

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |
| `reviewId` | query | The review ID to identify the target resource. | required |

### GET /assets/{groupId}/{assetId}/{version}/api/model

**Operation ID:** `getAssetsByGroupidByAssetidByVersionApiModel`
Gets the JSON-LD model for this API

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |

### GET /assets/{groupId}/{assetId}/{version}/api/root

**Operation ID:** `getAssetsByGroupidByAssetidByVersionApiRoot`
Redirects to path of root file for this API

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |

### GET /assets/{groupId}/{assetId}/{version}/api/{filePath}*

**Operation ID:** `getAssetsByGroupidByAssetidByVersionApiFilepath`
Gets the API file content

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |
| `filePath` | query | The filePath to identify the target resource. | required |

### GET /assets/{groupId}/{assetId}/{version}/domain

**Operation ID:** `getAssetsByGroupidByAssetidByVersionDomain`
Gets domain

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |

### GET /assets/{groupId}/{assetId}/{version}/portal

**Operation ID:** `getAssetsByGroupidByAssetidByVersionPortal`
Gets an asset portal

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |

### PATCH /assets/{groupId}/{assetId}/{version}/portal

**Operation ID:** `patchAssetsByGroupidByAssetidByVersionPortal`
Publishes draft version.
This endpoint should be executed without specifying any body.


**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |

### GET /assets/{groupId}/{assetId}/{version}/portal/pages

**Operation ID:** `getAssetsByGroupidByAssetidByVersionPortalPages`
Gets a list of pages

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |

### GET /assets/{groupId}/{assetId}/{version}/portal/pages/{pagePath}*

**Operation ID:** `getAssetsByGroupidByAssetidByVersionPortalPagesPagepath`
Gets a particular page

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |
| `pagePath` | query | The pagePath to identify the target resource. | required |
| `x-public-portal-domain` | query | The x public portal domain header value. | optional |
| `x-forwarded-host` | query | The x forwarded host header value. | optional |
| `x-forwarded-path` | query | The x forwarded path header value. | optional |

### GET /assets/{groupId}/{assetId}/{version}/portal/resources

**Operation ID:** `getAssetsByGroupidByAssetidByVersionPortalResources`
Gets portals resources

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |

### GET /assets/{groupId}/{assetId}/{version}/portal/resources/{resourceId}

**Operation ID:** `getAssetsByGroupidByAssetidByVersionPortalResourcesByResourceid`
Gets portals resource

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |
| `resourceId` | query | The resource ID to identify the target resource. | required |

### GET /assets/{groupId}/{assetId}/{version}/portal/draft

**Operation ID:** `getAssetsByGroupidByAssetidByVersionPortalDraft`
Gets an asset portal

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |

### PUT /assets/{groupId}/{assetId}/{version}/portal/draft

**Operation ID:** `updateAssetsByGroupidByAssetidByVersionPortalDraft`
Publishes asset documentation draft.
This endpoint should be executed without specifying any body.


**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |

### DELETE /assets/{groupId}/{assetId}/{version}/portal/draft

**Operation ID:** `deleteAssetsByGroupidByAssetidByVersionPortalDraft`
Discards asset documentation draft

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |

### GET /assets/{groupId}/{assetId}/{version}/portal/draft/pages

**Operation ID:** `getAssetsByGroupidByAssetidByVersionPortalDraftPages`
Gets a list of pages

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |

### POST /assets/{groupId}/{assetId}/{version}/portal/draft/pages

**Operation ID:** `createAssetsByGroupidByAssetidByVersionPortalDraftPages`
Creates an empty page for a draft version. Remember that:
- A page cannot be moved/created to/in a path that already contains another page with the same name.


**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |
| `x-move-source` | query | The x move source header value. | optional |

### GET /assets/{groupId}/{assetId}/{version}/portal/draft/pages/{pagePath}*

**Operation ID:** `getAssetsByGroupidByAssetidByVersionPortalDraftPagesPagepath`
Gets particular pages for a specific version of an asset

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |
| `pagePath` | query | The pagePath to identify the target resource. | required |
| `x-public-portal-domain` | query | The x public portal domain header value. | optional |
| `x-forwarded-host` | query | The x forwarded host header value. | optional |
| `x-forwarded-path` | query | The x forwarded path header value. | optional |

### PUT /assets/{groupId}/{assetId}/{version}/portal/draft/pages/{pagePath}*

**Operation ID:** `updateAssetsByGroupidByAssetidByVersionPortalDraftPagesPagepath`
Updates a page for a version of an asset portal

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |
| `pagePath` | query | The pagePath to identify the target resource. | required |

### DELETE /assets/{groupId}/{assetId}/{version}/portal/draft/pages/{pagePath}*

**Operation ID:** `deleteAssetsByGroupidByAssetidByVersionPortalDraftPagesPagepath`
Deletes a page of a version of an asset portal

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |
| `pagePath` | query | The pagePath to identify the target resource. | required |

### PUT /assets/{groupId}/{assetId}/{version}/portal/draft/pagesOrder

**Operation ID:** `updateAssetsByGroupidByAssetidByVersionPortalDraftPagesorder`
Saves the pages order for portal

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |
| `X-Pages-Order-Revision` | query | The X Pages Order Revision header value. | optional |

### GET /assets/{groupId}/{assetId}/{version}/portal/draft/resources

**Operation ID:** `getAssetsByGroupidByAssetidByVersionPortalDraftResources`
Gets portals resources

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |

### POST /assets/{groupId}/{assetId}/{version}/portal/draft/resources

**Operation ID:** `createAssetsByGroupidByAssetidByVersionPortalDraftResources`
Creates a resource for the portal draft.
The required multipart fields in the body are the path of the resource and the content type. Ex:
-F "Content-Type=image/png"
-F "file=@/Users/llucas/Documents/image.png"


**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |

### GET /assets/{groupId}/{assetId}/{version}/portal/draft/resources/{resourceId}

**Operation ID:** `getAssetsByGroupidByAssetidByVersionPortalDraftResourcesByResourceid`
Gets portals resource

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |
| `resourceId` | query | The resource ID to identify the target resource. | required |

### DELETE /assets/{groupId}/{assetId}/{version}/portal/draft/resources/{resourceId}

**Operation ID:** `deleteAssetsByGroupidByAssetidByVersionPortalDraftResourcesByResourceid`
Deletes a resource

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |
| `resourceId` | query | The resource ID to identify the target resource. | required |

### GET /assets/{groupId}/{assetId}/{version}/policies/instances

**Operation ID:** `getAssetsByGroupidByAssetidByVersionPoliciesInstances`
Gets an array of API instances affected by the policy

**Parameters:**
| `limit` | query | Amount of objects retrieved in the response | optional |
| `offset` | query | The offset specifies the offset of the first row to return | optional |
| `sort` | query | Property to sort by | optional |
| `ascending` | query | Order for sorting | optional |
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |

### GET /assets/{groupId}/{assetId}/{version}/policies/implementations

**Operation ID:** `getAssetsByGroupidByAssetidByVersionPoliciesImplementations`
Gets an array with implementations of a specific policy

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |

### GET /assets/{groupId}/{assetId}/{version}/policies/environments

**Operation ID:** `getAssetsByGroupidByAssetidByVersionPoliciesEnvironments`
Gets an array with environments affected by the policy

**Parameters:**
| `limit` | query | Amount of objects retrieved in the response | optional |
| `offset` | query | The offset specifies the offset of the first row to return | optional |
| `sort` | query | Property to sort by | optional |
| `ascending` | query | Order for sorting | optional |
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |

### PUT /assets/{groupId}/{assetId}/{version}/tags

**Operation ID:** `updateAssetsByGroupidByAssetidByVersionTags`
Upserts asset tags

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |

### PUT /assets/{groupId}/{assetId}/{version}/tags/fields/{tagKey}

**Operation ID:** `updateAssetsByGroupidByAssetidByVersionTagsFieldsByTagkey`
Update or create a custom field

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |
| `tagKey` | query | The tagKey to identify the target resource. | required |

### DELETE /assets/{groupId}/{assetId}/{version}/tags/fields/{tagKey}

**Operation ID:** `deleteAssetsByGroupidByAssetidByVersionTagsFieldsByTagkey`
Delete a custom field

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |
| `tagKey` | query | The tagKey to identify the target resource. | required |

### PUT /assets/{groupId}/{assetId}/{version}/tags/categories/{tagKey}

**Operation ID:** `updateAssetsByGroupidByAssetidByVersionTagsCategoriesByTagkey`
Updates or creates a category.

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |
| `tagKey` | query | The tagKey to identify the target resource. | required |

### DELETE /assets/{groupId}/{assetId}/{version}/tags/categories/{tagKey}

**Operation ID:** `deleteAssetsByGroupidByAssetidByVersionTagsCategoriesByTagkey`
Deletes a category

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |
| `tagKey` | query | The tagKey to identify the target resource. | required |

### PUT /assets/{groupId}/{assetId}/{version}/status

**Operation ID:** `updateAssetsByGroupidByAssetidByVersionStatus`
Updates asset status

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |

### GET /assets/{groupId}/{assetId}/{version}/actions

**Operation ID:** `getAssetsByGroupidByAssetidByVersionActions`
Returns list of available actions for this asset version

**Parameters:**
| `include` | query | The include query parameter. | required |
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |

### PUT /assets/{groupId}/{assetId}/{version}/owner

**Operation ID:** `updateAssetsByGroupidByAssetidByVersionOwner`
Update Asset ownership

**Parameters:**
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |

### POST /organizations/metrics/top

**Operation ID:** `createOrganizationsMetricsTop`
Creates top.

**Parameters:**
| `content-type` | query | The content type header value. | optional |
| `accept` | query | The accept header value. | optional |

### GET /organizations/{masterOrganizationId}/clientProviders/{clientProviderId}/grantTypes

**Operation ID:** `getOrganizationsByMasterorganizationidClientprovidersByClientprovideridGranttypes`
Gets the grant types for the client provider

**Parameters:**
| `masterOrganizationId` | query | The masterOrganization ID to identify the target resource. | required |
| `clientProviderId` | query | The clientProvider ID to identify the target resource. | required |

### GET /organizations/{organizationId}/identities

**Operation ID:** `getOrganizationsByOrganizationidIdentities`
Gets identities for an organization

**Parameters:**
| `search` | query | Search parameter used to filter facets | optional |
| `organizationId` | query | Id of the organization | required |

### POST /organizations/{organizationId}/identities/{identityId}/assets/authorize

**Operation ID:** `createOrganizationsByOrganizationidIdentitiesByIdentityidAssetsAuthorize`
return all assets a given identity has permission

**Parameters:**
| `organizationId` | query | Id of the organization | required |
| `identityId` | query | The identity ID to identify the target resource. | required |

### GET /organizations/{masterOrganizationId}/applications

**Operation ID:** `getOrganizationsByMasterorganizationidApplications`
Retrieves a list of client applications

**Parameters:**
| `masterOrganizationId` | query | The masterOrganization ID to identify the target resource. | required |
| `groupInstanceId` | query | This field is used to filter by API Group instance. | optional |
| `query` | query | Search or filter expression to narrow results. | optional |
| `includeContractsForApiVersion` | query | This field is used to filter by API version | optional |
| `ascending` | query | Order for sorting | optional |
| `apiInstanceId` | query | id of the api instance | optional |
| `offset` | query | The offset specifies the offset of the first row to return | optional |
| `limit` | query | Amount of objects retrieved in the response | optional |
| `sort` | query | Property to sort by | optional |
| `literalMatch` | query | Literal match | optional |

### POST /organizations/{masterOrganizationId}/applications

**Operation ID:** `createOrganizationsByMasterorganizationidApplications`
Adds a client application

**Parameters:**
| `masterOrganizationId` | query | The masterOrganization ID to identify the target resource. | required |
| `apiGroupInstanceId` | query | The apiGroupInstance ID query parameter. | optional |
| `apiInstanceId` | query | id of the api instance | optional |

### GET /organizations/{masterOrganizationId}/applications/{applicationId}

**Operation ID:** `getOrganizationsByMasterorganizationidApplicationsByApplicationid`
Gets a client application

**Parameters:**
| `masterOrganizationId` | query | The masterOrganization ID to identify the target resource. | required |
| `applicationId` | query | The application ID to identify the target resource. | required |

### PATCH /organizations/{masterOrganizationId}/applications/{applicationId}

**Operation ID:** `patchOrganizationsByMasterorganizationidApplicationsByApplicationid`
Updates a client application

**Parameters:**
| `masterOrganizationId` | query | The masterOrganization ID to identify the target resource. | required |
| `applicationId` | query | The application ID to identify the target resource. | required |

### DELETE /organizations/{masterOrganizationId}/applications/{applicationId}

**Operation ID:** `deleteOrganizationsByMasterorganizationidApplicationsByApplicationid`
Deletes a client application

**Parameters:**
| `masterOrganizationId` | query | The masterOrganization ID to identify the target resource. | required |
| `applicationId` | query | The application ID to identify the target resource. | required |

### GET /organizations/{masterOrganizationId}/applications/{applicationId}/environments/{environmentId}/apiGroupInstances/{apiGroupInstanceId}/limits

**Operation ID:** `getOrganizationsByMasterorganizationidApplicationsByApplicationidEnvironmentsByEnvironmentidApigroupinstancesByApigroupinstanceidLimits`
Gets the list of instances of the API Group with their corresponding limit

**Parameters:**
| `tierId` | query | The tier ID query parameter. | required |
| `masterOrganizationId` | query | The masterOrganization ID to identify the target resource. | required |
| `applicationId` | query | The application ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `apiGroupInstanceId` | query | The apiGroupInstance ID to identify the target resource. | required |

### GET /organizations/{masterOrganizationId}/applications/{applicationId}/instances

**Operation ID:** `getOrganizationsByMasterorganizationidApplicationsByApplicationidInstances`
Gets the list of API instances for the application

**Parameters:**
| `masterOrganizationId` | query | The masterOrganization ID to identify the target resource. | required |
| `applicationId` | query | The application ID to identify the target resource. | required |

### GET /organizations/{masterOrganizationId}/applications/{applicationId}/instances/{instanceId}/contracts

**Operation ID:** `getOrganizationsByMasterorganizationidApplicationsByApplicationidInstancesByInstanceidContracts`
Gets the list of contracts for an API instance

**Parameters:**
| `masterOrganizationId` | query | The masterOrganization ID to identify the target resource. | required |
| `applicationId` | query | The application ID to identify the target resource. | required |
| `instanceId` | query | The instance ID to identify the target resource. | required |

### GET /organizations/{masterOrganizationId}/applications/{applicationId}/contracts

**Operation ID:** `getOrganizationsByMasterorganizationidApplicationsByApplicationidContracts`
Gets a list of applications with contracts with the application

**Parameters:**
| `masterOrganizationId` | query | The masterOrganization ID to identify the target resource. | required |
| `applicationId` | query | The application ID to identify the target resource. | required |
| `includeContractsForApiVersion` | query | This field is used to filter by API version | optional |

### POST /organizations/{masterOrganizationId}/applications/{applicationId}/contracts

**Operation ID:** `createOrganizationsByMasterorganizationidApplicationsByApplicationidContracts`
Creates a contract for an API or an API Group

**Parameters:**
| `masterOrganizationId` | query | The masterOrganization ID to identify the target resource. | required |
| `applicationId` | query | The application ID to identify the target resource. | required |

### PATCH /organizations/{masterOrganizationId}/applications/{applicationId}/contracts/{contractId}

**Operation ID:** `patchOrganizationsByMasterorganizationidApplicationsByApplicationidContractsByContractid`
Updates contract SLA tier for an API or an API Group

**Parameters:**
| `masterOrganizationId` | query | The masterOrganization ID to identify the target resource. | required |
| `applicationId` | query | The application ID to identify the target resource. | required |
| `contractId` | query | The contract ID to identify the target resource. | required |

### POST /organizations/{masterOrganizationId}/applications/{applicationId}/secret/reset

**Operation ID:** `createOrganizationsByMasterorganizationidApplicationsByApplicationidSecretReset`
Resets the client secret for the application.
This endpoint should be executed without specifying any body.


**Parameters:**
| `masterOrganizationId` | query | The masterOrganization ID to identify the target resource. | required |
| `applicationId` | query | The application ID to identify the target resource. | required |

### DELETE /organizations/{organizationId}

**Operation ID:** `deleteOrganizationsByOrganizationid`
Unconditional delete organization

**Parameters:**
| `organizationId` | query | Id of the organization | required |

### POST /organizations/{organizationId}/assets/{groupId}/{assetId}/{version}

**Operation ID:** `createOrganizationsByOrganizationidAssetsByGroupidByAssetidByVersion`
Uploads an asset.
Available fields for describing the asset are: "name", "description", "type", "dependencies", "keywords", "files" and "status".
You can also add properties by prefixing them with “properties”, e.g: properties.apiVersion, properties.mainFile.


**Parameters:**
| `organizationId` | query | Id of the organization | required |
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |
| `x-sync-publication` | query | The x sync publication header value. | optional |
| `x-allowed-api-spec-formats` | query | The x allowed api spec formats header value. | optional |
| `x-file-validation` | query | The x file validation header value. | optional |
| `x-snapshots-allowed` | query | Indicates if snapshot publicataion is enabled. | optional |
| `x-strict-package` | query | Indicates if file is immutable. | optional |
| `Content-Type` | query | The Content Type header value. | required |
| `x-user-id` | query | The x user id header value. | optional |
| `x-assign-roles` | query | The x assign roles header value. | optional |

### PATCH /organizations/{organizationId}/assets/{groupId}/{assetId}/{version}/mutabledata

**Operation ID:** `patchOrganizationsByOrganizationidAssetsByGroupidByAssetidByVersionMutabledata`
Patch an asset mutable data

**Parameters:**
| `organizationId` | query | Id of the organization | required |
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |
| `Content-Type` | query | The Content Type header value. | required |

### GET /organizations/{organizationId}/groups/{groupId}/assets/{assetId}/nextAvailableVersion

**Operation ID:** `getOrganizationsByOrganizationidGroupsByGroupidAssetsByAssetidNextavailableversion`
Returns the highest next available version, considering soft-deleted and snapshot versions

**Parameters:**
| `organizationId` | query | Id of the organization | required |
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `versionOrder` | query | Specifies the position by which the version should be increased (PATCH, MINOR, MAJOR) | optional |

### GET /organizations/{organizationId}/assets/{groupId}/{assetId}/{version}/mutabledata/status/{runId}

**Operation ID:** `getOrganizationsByOrganizationidAssetsByGroupidByAssetidByVersionMutabledataStatusByRunid`
Gets asset publication status

**Parameters:**
| `assetId` | query | assetId of the asset | required |
| `groupId` | query | groupId of the asset | required |
| `version` | query | version of the asset | required |
| `organizationId` | query | Id of the organization | required |
| `runId` | query | The run ID to identify the target resource. | required |

### GET /organizations/{organizationId}/assets/{groupId}/{assetId}/{version}/publication/extendedStatus/{runId}

**Operation ID:** `getOrganizationsByOrganizationidAssetsByGroupidByAssetidByVersionPublicationExtendedstatusByRunid`
Gets extended asset publication extended status by runId

**Parameters:**
| `assetId` | query | assetId of the asset | required |
| `groupId` | query | groupId of the asset | required |
| `version` | query | version of the asset | required |
| `organizationId` | query | Id of the organization | required |
| `runId` | query | The run ID to identify the target resource. | required |

### GET /organizations/{organizationId}/assets/{groupId}/{assetId}/{version}/publication/status

**Operation ID:** `getOrganizationsByOrganizationidAssetsByGroupidByAssetidByVersionPublicationStatus`
Gets asset publication status

**Parameters:**
| `organizationId` | query | Id of the organization | required |
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |

### GET /organizations/{organizationId}/assets/{groupId}/{assetId}/{version}/publication/status/{runId}

**Operation ID:** `getOrganizationsByOrganizationidAssetsByGroupidByAssetidByVersionPublicationStatusByRunid`
Gets asset publication status

**Parameters:**
| `assetId` | query | assetId of the asset | required |
| `groupId` | query | groupId of the asset | required |
| `version` | query | version of the asset | required |
| `organizationId` | query | Id of the organization | required |
| `runId` | query | The run ID to identify the target resource. | required |

### GET /organizations/{organizationId}/fields

**Operation ID:** `getOrganizationsByOrganizationidFields`
Gets field configurations available for the organization

**Parameters:**
| `organizationId` | query | Id of the organization | required |
| `limit` | query | Amount of objects retrieved in the response | optional |
| `offset` | query | The offset specifies the offset of the first row to return | optional |

### POST /organizations/{organizationId}/fields

**Operation ID:** `createOrganizationsByOrganizationidFields`
Adds a field configuration to the organization.
- Body should be application/json. This is not specified in the raml as it conflicts with Osprey.


**Parameters:**
| `organizationId` | query | Id of the organization | required |

### PATCH /organizations/{organizationId}/fields/{id}

**Operation ID:** `patchOrganizationsByOrganizationidFieldsById`
Updates a custom field configuration

**Parameters:**
| `organizationId` | query | Id of the organization | required |
| `id` | query | The id to identify the target resource. | required |
| `X-Force-Update` | query | Enforce update operation (possibly affecting many resources) to avoid Conflict response (409) | optional |

### DELETE /organizations/{organizationId}/fields/{id}

**Operation ID:** `deleteOrganizationsByOrganizationidFieldsById`
Deletes a custom field configuration

**Parameters:**
| `organizationId` | query | Id of the organization | required |
| `id` | query | The id to identify the target resource. | required |
| `X-Force-Delete` | query | The X Force Delete header value. | optional |

### GET /organizations/{organizationId}/categories

**Operation ID:** `getOrganizationsByOrganizationidCategories`
Get categories configurations available for the organization

**Parameters:**
| `organizationId` | query | Id of the organization | required |
| `limit` | query | Amount of objects retrieved in the response | optional |
| `offset` | query | The offset specifies the offset of the first row to return | optional |

### POST /organizations/{organizationId}/categories

**Operation ID:** `createOrganizationsByOrganizationidCategories`
Add a category configuration to the organization

**Parameters:**
| `organizationId` | query | Id of the organization | required |

### PATCH /organizations/{organizationId}/categories/{id}

**Operation ID:** `patchOrganizationsByOrganizationidCategoriesById`
Updates a category configuration
- Body should be application/json. This is not specified in the raml as it conflicts with Osprey.


**Parameters:**
| `organizationId` | query | Id of the organization | required |
| `id` | query | The id to identify the target resource. | required |
| `X-Force-Update` | query | Enforce update operation (possibly affecting many resources) to avoid Conflict response (409) | optional |

### DELETE /organizations/{organizationId}/categories/{id}

**Operation ID:** `deleteOrganizationsByOrganizationidCategoriesById`
Deletes a category configuration

**Parameters:**
| `organizationId` | query | Id of the organization | required |
| `id` | query | The id to identify the target resource. | required |
| `X-Force-Delete` | query | The X Force Delete header value. | optional |

### GET /organizations/{organizationId}/queries

**Operation ID:** `getOrganizationsByOrganizationidQueries`
Gets a list of queries

**Parameters:**
| `organizationId` | query | Id of the organization | required |
| `limit` | query | Amount of objects retrieved in the response | optional |
| `offset` | query | The offset specifies the offset of the first row to return | optional |
| `sort` | query | Property to sort by | optional |
| `ascending` | query | Order for sorting | optional |

### POST /organizations/{organizationId}/queries

**Operation ID:** `createOrganizationsByOrganizationidQueries`
Creates a new query
Creates a new query

**Parameters:**
| `organizationId` | query | Id of the organization | required |

### GET /organizations/{organizationId}/softDeleted

**Operation ID:** `getOrganizationsByOrganizationidSoftdeleted`
Get organization's soft deleted assets

**Parameters:**
| `organizationId` | query | Id of the organization | required |
| `limit` | query | Amount of objects retrieved in the response | optional |
| `offset` | query | The offset specifies the offset of the first row to return | optional |

### GET /organizations/{organizationId}/settings

**Operation ID:** `getOrganizationsByOrganizationidSettings`
Gets root organization level settings

**Parameters:**
| `organizationId` | query | UUID | required |
| `settings` | query | Settings to be retrieved | required |

### PATCH /organizations/{organizationId}/settings

**Operation ID:** `patchOrganizationsByOrganizationidSettings`
Updates root organization level settings

**Parameters:**
| `organizationId` | query | UUID | required |

### PATCH /organizations/{organizationId}/queries/{queryId}

**Operation ID:** `patchOrganizationsByOrganizationidQueriesByQueryid`
Edits a saved search query

**Parameters:**
| `organizationId` | query | Id of the organization | required |
| `queryId` | query | The query ID to identify the target resource. | required |

### DELETE /organizations/{organizationId}/queries/{queryId}

**Operation ID:** `deleteOrganizationsByOrganizationidQueriesByQueryid`
Deletes the query

**Parameters:**
| `organizationId` | query | Id of the organization | required |
| `queryId` | query | The query ID to identify the target resource. | required |

### GET /portals/{organizationDomain}

**Operation ID:** `getPortalsByOrganizationdomain`
Gets the customization portal

**Parameters:**
| `organizationDomain` | query | Domain of the root organization | required |

### PATCH /portals/{organizationDomain}

**Operation ID:** `patchPortalsByOrganizationdomain`
Publishes draft portal customization.
This endpoint should be executed without specifying any body.


**Parameters:**
| `organizationDomain` | query | Domain of the root organization | required |

### GET /portals/{organizationDomain}/metadata

**Operation ID:** `getPortalsByOrganizationdomainMetadata`
Gets organization domain metadata from authentication service

**Parameters:**
| `organizationDomain` | query | Domain of the root organization | required |

### GET /portals/{organizationDomain}/resources

**Operation ID:** `getPortalsByOrganizationdomainResources`
Gets portals resources

**Parameters:**
| `organizationDomain` | query | Domain of the root organization | required |

### GET /portals/{organizationDomain}/resources/{resourceId}

**Operation ID:** `getPortalsByOrganizationdomainResourcesByResourceid`
Gets portals resource

**Parameters:**
| `organizationDomain` | query | Domain of the root organization | required |
| `resourceId` | query | The resource ID to identify the target resource. | required |

### GET /portals/{organizationDomain}/assets/search

**Operation ID:** `getPortalsByOrganizationdomainAssetsSearch`
Gets a paginated set of assets

**Parameters:**
| `limit` | query | Amount of objects retrieved in the response | optional |
| `offset` | query | The offset specifies the offset of the first row to return | optional |
| `sort` | query | Property to sort by | optional |
| `ascending` | query | Order for sorting | optional |
| `organizationDomain` | query | Domain of the root organization | required |

### GET /portals/{organizationDomain}/assets/{groupId}/{assetId}

**Operation ID:** `getPortalsByOrganizationdomainAssetsByGroupidByAssetid`
Retrieves a assets.

**Parameters:**
| `status` | query | Filter versions that matches the status indicated. Should be one of deprecated, development or published | optional |
| `strict` | query | Asset related versions populated into `otherVersions` property will also have the filters for this query applied, e.g.: if status filter is applied, then related versions will have the status filter also applied, otherwise all possible status will be returned. Defaults to `true` | optional |
| `organizationDomain` | query | Domain of the root organization | required |
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |

### GET /portals/{organizationDomain}/assets/{groupId}/{assetId}/asset

**Operation ID:** `getPortalsByOrganizationdomainAssetsByGroupidByAssetidAsset`
Gets an asset

**Parameters:**
| `organizationDomain` | query | Domain of the root organization | required |
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |

### GET /portals/{organizationDomain}/assets/{groupId}/{assetId}/versionGroups/{versionGroup}/apiGroupInstances

**Operation ID:** `getPortalsByOrganizationdomainAssetsByGroupidByAssetidVersiongroupsByVersiongroupApigroupinstances`
Gets API Group Instance

**Parameters:**
| `limit` | query | Amount of objects retrieved in the response | optional |
| `offset` | query | The offset specifies the offset of the first row to return | optional |
| `sort` | query | Property to sort by | optional |
| `ascending` | query | Order for sorting | optional |
| `organizationDomain` | query | Domain of the root organization | required |
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `versionGroup` | query | Version group of the asset | required |

### GET /portals/{organizationDomain}/assets/{groupId}/{assetId}/versionGroups/{versionGroup}/environments/{environmentId}/apiGroupInstances/{apiGroupInstanceId}/tiers

**Operation ID:** `getPortalsByOrganizationdomainAssetsByGroupidByAssetidVersiongroupsByVersiongroupEnvironmentsByEnvironmentidApigroupinstancesByApigroupinstanceidTiers`
Gets a list of tiers

**Parameters:**
| `versionGroup` | query | Version group of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `groupId` | query | groupId of the asset | required |
| `organizationDomain` | query | Domain of the root organization | required |
| `apiGroupInstanceId` | query | The apiGroupInstance ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |

### GET /portals/{organizationDomain}/assets/{groupId}/{assetId}/versionGroups/{versionGroup}/terms

**Operation ID:** `getPortalsByOrganizationdomainAssetsByGroupidByAssetidVersiongroupsByVersiongroupTerms`
Gets Terms and Conditions associated to the API

**Parameters:**
| `organizationDomain` | query | Domain of the root organization | required |
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `versionGroup` | query | Version group of the asset | required |

### GET /portals/{organizationDomain}/assets/{groupId}/{assetId}/{version}/asset

**Operation ID:** `getPortalsByOrganizationdomainAssetsByGroupidByAssetidByVersionAsset`
Gets an asset

**Parameters:**
| `organizationDomain` | query | Domain of the root organization | required |
| `groupId` | query | groupId of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |

### GET /portals/{organizationDomain}/applications/{applicationId}/instances

**Operation ID:** `getPortalsByOrganizationdomainApplicationsByApplicationidInstances`
Gets the list of API instances for the application

**Parameters:**
| `organizationDomain` | query | Domain of the root organization | required |
| `applicationId` | query | The application ID to identify the target resource. | required |

### GET /portals/{organizationDomain}/domain

**Operation ID:** `getPortalsByOrganizationdomainDomain`
Gets domain

**Parameters:**
| `organizationDomain` | query | Domain of the root organization | required |

### PUT /portals/{organizationDomain}/domain

**Operation ID:** `updatePortalsByOrganizationdomainDomain`
Updates a domain for an organization

**Parameters:**
| `organizationDomain` | query | Domain of the root organization | required |

### DELETE /portals/{organizationDomain}/domain

**Operation ID:** `deletePortalsByOrganizationdomainDomain`
Removes a domain

**Parameters:**
| `organizationDomain` | query | Domain of the root organization | required |

### GET /portals/{organizationDomain}/cookieConsentId

**Operation ID:** `getPortalsByOrganizationdomainCookieconsentid`
Gets cookie consent id

**Parameters:**
| `organizationDomain` | query | Domain of the root organization | required |

### PUT /portals/{organizationDomain}/cookieConsentId

**Operation ID:** `updatePortalsByOrganizationdomainCookieconsentid`
Updates a cookie consent id for an organization

**Parameters:**
| `organizationDomain` | query | Domain of the root organization | required |

### DELETE /portals/{organizationDomain}/cookieConsentId

**Operation ID:** `deletePortalsByOrganizationdomainCookieconsentid`
Removes a cookie consent id

**Parameters:**
| `organizationDomain` | query | Domain of the root organization | required |

### GET /portals/{organizationDomain}/status

**Operation ID:** `getPortalsByOrganizationdomainStatus`
Gets a public portal status

**Parameters:**
| `organizationDomain` | query | Domain of the root organization | required |

### PUT /portals/{organizationDomain}/status

**Operation ID:** `updatePortalsByOrganizationdomainStatus`
Updates a public portal status for an organization

**Parameters:**
| `organizationDomain` | query | Domain of the root organization | required |

### GET /portals/{organizationDomain}/draft

**Operation ID:** `getPortalsByOrganizationdomainDraft`
Gets the customization portal

**Parameters:**
| `organizationDomain` | query | Domain of the root organization | required |

### PUT /portals/{organizationDomain}/draft

**Operation ID:** `updatePortalsByOrganizationdomainDraft`
Updates the portal customization draft

**Parameters:**
| `organizationDomain` | query | Domain of the root organization | required |

### DELETE /portals/{organizationDomain}/draft

**Operation ID:** `deletePortalsByOrganizationdomainDraft`
Deletes the portal customization draft

**Parameters:**
| `organizationDomain` | query | Domain of the root organization | required |

### POST /portals/{organizationDomain}/draft/pages

**Operation ID:** `createPortalsByOrganizationdomainDraftPages`
Creates an empty page for a draft version. Remember that:
- A page cannot be moved/created to/in a path that already contains another page with the same name.


**Parameters:**
| `organizationDomain` | query | Domain of the root organization | required |
| `x-move-source` | query | The x move source header value. | optional |

### GET /portals/{organizationDomain}/draft/pages/{pagePath}*

**Operation ID:** `getPortalsByOrganizationdomainDraftPagesPagepath`
Gets a particular page

**Parameters:**
| `organizationDomain` | query | Domain of the root organization | required |
| `pagePath` | query | The pagePath to identify the target resource. | required |
| `x-public-portal-domain` | query | The x public portal domain header value. | optional |
| `x-forwarded-host` | query | The x forwarded host header value. | optional |
| `x-forwarded-path` | query | The x forwarded path header value. | optional |

### PUT /portals/{organizationDomain}/draft/pages/{pagePath}*

**Operation ID:** `updatePortalsByOrganizationdomainDraftPagesPagepath`
Updates a page for a custom draft portal

**Parameters:**
| `organizationDomain` | query | Domain of the root organization | required |
| `pagePath` | query | The pagePath to identify the target resource. | required |

### DELETE /portals/{organizationDomain}/draft/pages/{pagePath}*

**Operation ID:** `deletePortalsByOrganizationdomainDraftPagesPagepath`
Deletes a page of a custom draft portal

**Parameters:**
| `organizationDomain` | query | Domain of the root organization | required |
| `pagePath` | query | The pagePath to identify the target resource. | required |

### PUT /portals/{organizationDomain}/draft/pagesOrder

**Operation ID:** `updatePortalsByOrganizationdomainDraftPagesorder`
Saves the pages order for portal

**Parameters:**
| `organizationDomain` | query | Domain of the root organization | required |
| `X-Pages-Order-Revision` | query | The X Pages Order Revision header value. | optional |

### GET /portals/{organizationDomain}/draft/resources

**Operation ID:** `getPortalsByOrganizationdomainDraftResources`
Gets portals resources

**Parameters:**
| `organizationDomain` | query | Domain of the root organization | required |

### POST /portals/{organizationDomain}/draft/resources

**Operation ID:** `createPortalsByOrganizationdomainDraftResources`
Creates a resource for the portal draft.
The required multipart fields in the body are the path of the resource and the content type. Ex:
-F "Content-Type=image/png"
-F "file=@/Users/llucas/Documents/image.png"


**Parameters:**
| `organizationDomain` | query | Domain of the root organization | required |

### GET /portals/{organizationDomain}/draft/resources/{resourceId}

**Operation ID:** `getPortalsByOrganizationdomainDraftResourcesByResourceid`
Gets portals resource

**Parameters:**
| `organizationDomain` | query | Domain of the root organization | required |
| `resourceId` | query | The resource ID to identify the target resource. | required |

### DELETE /portals/{organizationDomain}/draft/resources/{resourceId}

**Operation ID:** `deletePortalsByOrganizationdomainDraftResourcesByResourceid`
Deletes portals resource

**Parameters:**
| `organizationDomain` | query | Domain of the root organization | required |
| `resourceId` | query | The resource ID to identify the target resource. | required |

### GET /portals/{organizationDomain}/pages/{pagePath}*

**Operation ID:** `getPortalsByOrganizationdomainPagesPagepath`
Gets a particular page

**Parameters:**
| `organizationDomain` | query | Domain of the root organization | required |
| `pagePath` | query | The pagePath to identify the target resource. | required |
| `x-public-portal-domain` | query | The x public portal domain header value. | optional |
| `x-forwarded-host` | query | The x forwarded host header value. | optional |
| `x-forwarded-path` | query | The x forwarded path header value. | optional |

### GET /users/me/queries

**Operation ID:** `getUsersMeQueries`
Gets a list of queries

**Parameters:**
| `limit` | query | Amount of objects retrieved in the response | optional |
| `offset` | query | The offset specifies the offset of the first row to return | optional |
| `sort` | query | Property to sort by | optional |
| `ascending` | query | Order for sorting | optional |

### POST /users/me/queries

**Operation ID:** `createUsersMeQueries`
Creates a new query

### PATCH /users/me/queries/{queryId}

**Operation ID:** `patchUsersMeQueriesByQueryid`
Edits a saved search query

**Parameters:**
| `queryId` | query | The query ID to identify the target resource. | required |

### DELETE /users/me/queries/{queryId}

**Operation ID:** `deleteUsersMeQueriesByQueryid`
Deletes the query

**Parameters:**
| `queryId` | query | The query ID to identify the target resource. | required |

### GET /featureFlags

**Operation ID:** `getFeatureflags`
Lists featureFlags.

### GET /graphql

**Operation ID:** `getGraphql`
Lists graphql.

### POST /graphql

**Operation ID:** `postGraphql`
Creates graphql.


## Related Skills
- [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.