# 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` — US
- `https://eu1.anypoint.mulesoft.com/exchange/api/v2` — EU
- `https://ca1.platform.mulesoft.com/exchange/api/v2` — CA
- `https://jp1.platform.mulesoft.com/exchange/api/v2` — JP
- `/api/v2` — Base URI

## Operations (153)
### POST /assets

**Operation ID:** `uploadAsset`
Upload asset
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:** `searchAssets`
Search assets
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:** `updateAsset`
Update asset metadata
Updates asset metadata (name and description)

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `assetId` | query | assetId of the asset | required |

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

**Operation ID:** `deleteAsset`
Delete asset
Deletes an asset

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `getAssetMetrics`
Get asset metrics
Gets metrics given a groupId and assetId

**Parameters:**
| `periodType` | query | The periodType query parameter. | optional |
| `format` | query | The format query parameter. | optional |
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `assetId` | query | assetId of the asset | required |

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

**Operation ID:** `getAssetMetricsByVersion`
Get asset metrics by version
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 | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `assetId` | query | assetId of the asset | required |
| `accept` | query | The accept header value. | optional |

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

**Operation ID:** `uploadAssetIcon`
Upload asset icon
Uploads an icon as a binary file

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `assetId` | query | assetId of the asset | required |

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

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

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `assetId` | query | assetId of the asset | required |

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

**Operation ID:** `setAssetPublicVersions`
Set asset public versions
Sets the public versions for the asset

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `assetId` | query | assetId of the asset | required |

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

**Operation ID:** `getAssetFiles`
Get asset files
Gets an asset

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `assetId` | query | assetId of the asset | required |

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

**Operation ID:** `searchAssetPortalPages`
Search asset portal pages
Retrieves a search.

**Parameters:**
| `term` | query | The term query parameter. | required |
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `assetId` | query | assetId of the asset | required |
| `minorVersion` | query | Minor version | required |

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

**Operation ID:** `listAssetVersionGroups`
List asset version groups
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 | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `assetId` | query | assetId of the asset | required |

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

**Operation ID:** `listApiGroupInstances`
List API group instances
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 | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `updateApiGroupInstanceVisibility`
Update API group visibility
Updates API Group visibility

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `listApiGroupInstanceTiers`
List API group instance tiers
Gets a list of tiers

**Parameters:**
| `versionGroup` | query | Version group of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `getAssetTerms`
Get asset terms
Gets Terms and Conditions associated to the API

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `listAssetInstances`
List asset instances
Gets API instances

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `listRelatedApiGroupInstances`
List related API group instances
Gets API group instances that include an API instance

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `listInstanceTiers`
List instance tiers
Gets a list of tiers

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `createEventedExternalInstance`
Create evented external instance
Creates a new external API instance for an evented API

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `updateEventedExternalInstance`
Update evented external instance
Updates an existing external API instance

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `createExternalInstance`
Create external instance
Creates a new external API instance

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `deleteExternalInstances`
Delete external instances
Deletes all instance instances from Version Group

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `updateExternalInstance`
Update external instance
Updates an existing external API instance

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `deleteExternalInstance`
Delete external instance
Deletes an existing external API instance

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `updateManagedInstance`
Update managed instance
Updates an existing managed API instance

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `listAssetIdentities`
List asset identities
A collection of identities assigned to an asset with their role

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `assetId` | query | assetId of the asset | required |
| `search` | query | Search parameter used to filter facets | optional |

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

**Operation ID:** `assignAssetIdentities`
Assign asset identities
Assigns identities to an asset

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `getAssetDomain`
Get asset domain
Gets domain

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `assetId` | query | assetId of the asset | required |

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

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

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `deleteAssetVersion`
Delete asset version
Deletes an asset by its ID

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `uploadAssetVersionIcon`
Upload asset version icon
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 | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |

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

**Operation ID:** `getAssetVersionFiles`
Get asset version files
Gets an asset

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |

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

**Operation ID:** `getAssetRating`
Get asset rating
Gets the asset rating

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |

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

**Operation ID:** `listAssetReviews`
List asset reviews
Gets a list of reviews

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `createAssetReview`
Create asset review
Creates a new asset review

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |

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

**Operation ID:** `updateAssetReview`
Update asset review
Edits an asset review

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `deleteAssetReview`
Delete asset review
Deletes an specific asset review.

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `getAssetApiModel`
Get asset API model
Gets the JSON-LD model for this API

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |

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

**Operation ID:** `getAssetApiRoot`
Get asset API root file
Redirects to path of root file for this API

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |

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

**Operation ID:** `getAssetApiFile`
Get asset API file
Gets the API file content

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `getAssetVersionDomain`
Get asset version domain
Gets domain

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |

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

**Operation ID:** `getAssetPortal`
Get asset portal
Gets an asset portal

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |

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

**Operation ID:** `publishAssetPortal`
Publish asset portal
Publishes draft version.
This endpoint should be executed without specifying any body.


**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |

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

**Operation ID:** `listAssetPortalPages`
List asset portal pages
Gets a list of pages

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `getAssetPortalPage`
Get asset portal page
Gets a particular page

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `listAssetPortalResources`
List asset portal resources
Gets portals resources

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `getAssetPortalResource`
Get asset portal resource
Gets portals resource

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `getAssetPortalDraft`
Get asset portal draft
Gets an asset portal

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |

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

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


**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |

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

**Operation ID:** `discardAssetPortalDraft`
Discard asset portal draft
Discards asset documentation draft

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `listAssetPortalDraftPages`
List asset portal draft pages
Gets a list of pages

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `createAssetPortalDraftPage`
Create asset portal draft page
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 | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `getAssetPortalDraftPage`
Get asset portal draft page
Gets particular pages for a specific version of an asset

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `updateAssetPortalDraftPage`
Update asset portal draft page
Updates a page for a version of an asset portal

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `deleteAssetPortalDraftPage`
Delete asset portal draft page
Deletes a page of a version of an asset portal

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `updateAssetPortalDraftPageOrder`
Update asset portal draft page order
Saves the pages order for portal

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `listAssetPortalDraftResources`
List asset portal draft resources
Gets portals resources

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `createAssetPortalDraftResource`
Create asset portal draft resource
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 | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `getAssetPortalDraftResource`
Get asset portal draft resource
Gets portals resource

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `deleteAssetPortalDraftResource`
Delete asset portal draft resource
Deletes a resource

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `listPolicyInstances`
List policy instances
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 | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |

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

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

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |

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

**Operation ID:** `listPolicyEnvironments`
List policy environments
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 | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |

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

**Operation ID:** `updateAssetTags`
Update asset tags
Upserts asset tags

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `updateAssetTagField`
Update asset tag field
Update or create a custom field

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `deleteAssetTagField`
Delete asset tag field
Delete a custom field

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `updateAssetTagCategory`
Update asset tag category
Updates or creates a category.

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `deleteAssetTagCategory`
Delete asset tag category
Deletes a category

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `updateAssetStatus`
Update asset status
Updates asset status

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |

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

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

**Parameters:**
| `include` | query | The include query parameter. | required |
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |

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

**Operation ID:** `updateAssetOwner`
Update asset owner
Update Asset ownership

**Parameters:**
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |

### POST /organizations/metrics/top

**Operation ID:** `listTopAssets`
List top assets by metric
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:** `listClientProviderGrantTypes`
List client provider grant types
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:** `listOrganizationIdentities`
List organization identities
Gets identities for an organization

**Parameters:**
| `search` | query | Search parameter used to filter facets | optional |
| `organizationId` | query | The organization ID to identify the target resource. | required |

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

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

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

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

**Operation ID:** `listClientApplications`
List client applications
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:** `createClientApplication`
Create client application
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:** `getClientApplication`
Get client application
Gets a client application

**Parameters:**
| `masterOrganizationId` | query | The masterOrganization ID to identify the target resource. | required |
| `applicationId` | query | Could be an API Manager application ID or a Core Services client ID. | required |

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

**Operation ID:** `updateClientApplication`
Update client application
Updates a client application

**Parameters:**
| `masterOrganizationId` | query | The masterOrganization ID to identify the target resource. | required |
| `applicationId` | query | Could be an API Manager application ID or a Core Services client ID. | required |

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

**Operation ID:** `deleteClientApplication`
Delete client application
Deletes a client application

**Parameters:**
| `masterOrganizationId` | query | The masterOrganization ID to identify the target resource. | required |
| `applicationId` | query | Could be an API Manager application ID or a Core Services client ID. | required |

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

**Operation ID:** `listApiGroupInstanceLimits`
List API group instance limits
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 | Could be an API Manager application ID or a Core Services client ID. | 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:** `listApplicationInstances`
List application instances
Gets the list of API instances for the application

**Parameters:**
| `masterOrganizationId` | query | The masterOrganization ID to identify the target resource. | required |
| `applicationId` | query | Could be an API Manager application ID or a Core Services client ID. | required |

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

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

**Parameters:**
| `masterOrganizationId` | query | The masterOrganization ID to identify the target resource. | required |
| `applicationId` | query | Could be an API Manager application ID or a Core Services client ID. | required |
| `instanceId` | query | The instance ID to identify the target resource. | required |

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

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

**Parameters:**
| `masterOrganizationId` | query | The masterOrganization ID to identify the target resource. | required |
| `applicationId` | query | Could be an API Manager application ID or a Core Services client ID. | required |
| `includeContractsForApiVersion` | query | This field is used to filter by API version | optional |

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

**Operation ID:** `createApplicationContract`
Create application contract
Creates a contract for an API or an API Group

**Parameters:**
| `masterOrganizationId` | query | The masterOrganization ID to identify the target resource. | required |
| `applicationId` | query | Could be an API Manager application ID or a Core Services client ID. | required |

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

**Operation ID:** `updateApplicationContract`
Update application contract
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 | Could be an API Manager application ID or a Core Services client ID. | required |
| `contractId` | query | The contract ID to identify the target resource. | required |

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

**Operation ID:** `resetApplicationSecret`
Reset application secret
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 | Could be an API Manager application ID or a Core Services client ID. | required |

### DELETE /organizations/{organizationId}

**Operation ID:** `deleteOrganization`
Delete organization
Unconditional delete organization

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

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

**Operation ID:** `uploadOrganizationAssetVersion`
Upload organization asset version
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 | The organization ID to identify the target resource. | required |
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `updateAssetMutableData`
Update asset mutable data
Patch an asset mutable data

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `getNextAvailableVersion`
Get next available version
Returns the highest next available version, considering soft-deleted and snapshot versions

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `getAssetMutableDataStatus`
Get asset mutable data status
Gets asset publication status

**Parameters:**
| `assetId` | query | assetId of the asset | required |
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `version` | query | version of the asset | required |
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `runId` | query | The run ID to identify the target resource. | required |

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

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

**Parameters:**
| `assetId` | query | assetId of the asset | required |
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `version` | query | version of the asset | required |
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `runId` | query | The run ID to identify the target resource. | required |

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

**Operation ID:** `getAssetPublicationStatus`
Get asset publication status
Gets asset publication status

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `getAssetPublicationStatusByRun`
Get asset publication status by run
Gets asset publication status

**Parameters:**
| `assetId` | query | assetId of the asset | required |
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `version` | query | version of the asset | required |
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `runId` | query | The run ID to identify the target resource. | required |

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

**Operation ID:** `generateAssetDocumentation`
Generate asset documentation
Generates AI-powered documentation for an asset version.
Requires Einstein to be enabled for the organization.


**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |

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

**Operation ID:** `listCustomFields`
List custom fields
Gets field configurations available for the organization

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | 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:** `createCustomField`
Create custom field
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 | The organization ID to identify the target resource. | required |

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

**Operation ID:** `updateCustomField`
Update custom field
Updates a custom field configuration

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | 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:** `deleteCustomField`
Delete custom field
Deletes a custom field configuration

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | 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:** `listCategories`
List categories
Get categories configurations available for the organization

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | 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:** `createCategory`
Create category
Add a category configuration to the organization

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

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

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


**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | 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:** `deleteCategory`
Delete category
Deletes a category configuration

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | 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:** `listOrganizationQueries`
List organization queries
Gets a list of queries

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | 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:** `createOrganizationQuery`
Create organization query
Creates a new query

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

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

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

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | 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:** `getOrganizationSettings`
Get organization settings
Gets root organization level settings

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `settings` | query | Settings to be retrieved | required |

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

**Operation ID:** `updateOrganizationSettings`
Update organization settings
Updates root organization level settings

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

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

**Operation ID:** `updateOrganizationQuery`
Update organization query
Edits a saved search query

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

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

**Operation ID:** `deleteOrganizationQuery`
Delete organization query
Deletes the query

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

### GET /portals/{organizationDomain}

**Operation ID:** `getPortalCustomization`
Get portal customization
Gets the customization portal

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

### PATCH /portals/{organizationDomain}

**Operation ID:** `publishPortalCustomization`
Publish portal customization
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:** `getPortalMetadata`
Get portal metadata
Gets organization domain metadata from authentication service

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

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

**Operation ID:** `listPortalResources`
List portal resources
Gets portals resources

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

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

**Operation ID:** `getPortalResource`
Get portal resource
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:** `searchPublicAssets`
Search public assets
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:** `getPublicAsset`
Get public asset
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 | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `assetId` | query | assetId of the asset | required |

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

**Operation ID:** `getPublicAssetFiles`
Get public asset files
Gets an asset

**Parameters:**
| `organizationDomain` | query | Domain of the root organization | required |
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `assetId` | query | assetId of the asset | required |

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

**Operation ID:** `listPublicApiGroupInstances`
List public API group instances
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 | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `listPublicApiGroupInstanceTiers`
List public API group instance tiers
Gets a list of tiers

**Parameters:**
| `versionGroup` | query | Version group of the asset | required |
| `assetId` | query | assetId of the asset | required |
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `getPublicAssetTerms`
Get public asset terms
Gets Terms and Conditions associated to the API

**Parameters:**
| `organizationDomain` | query | Domain of the root organization | required |
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | 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:** `getPublicAssetVersionFiles`
Get public asset version files
Gets an asset

**Parameters:**
| `organizationDomain` | query | Domain of the root organization | required |
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `assetId` | query | assetId of the asset | required |
| `version` | query | version of the asset | required |

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

**Operation ID:** `listPublicApplicationInstances`
List public application instances
Gets the list of API instances for the application

**Parameters:**
| `organizationDomain` | query | Domain of the root organization | required |
| `applicationId` | query | Could be an API Manager application ID or a Core Services client ID. | required |

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

**Operation ID:** `getPortalDomain`
Get portal domain
Gets domain

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

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

**Operation ID:** `updatePortalDomain`
Update portal domain
Updates a domain for an organization

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

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

**Operation ID:** `deletePortalDomain`
Delete portal domain
Removes a domain

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

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

**Operation ID:** `getPortalCookieConsent`
Get portal cookie consent
Gets cookie consent id

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

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

**Operation ID:** `updatePortalCookieConsent`
Update portal cookie consent
Updates a cookie consent id for an organization

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

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

**Operation ID:** `deletePortalCookieConsent`
Delete portal cookie consent
Removes a cookie consent id

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

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

**Operation ID:** `getPortalStatus`
Get portal status
Gets a public portal status

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

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

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

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

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

**Operation ID:** `getPortalCustomizationDraft`
Get portal customization draft
Gets the customization portal

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

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

**Operation ID:** `updatePortalCustomizationDraft`
Update portal customization draft
Updates the portal customization draft

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

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

**Operation ID:** `deletePortalCustomizationDraft`
Delete portal customization draft
Deletes the portal customization draft

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

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

**Operation ID:** `createPortalDraftPage`
Create portal draft page
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:** `getPortalDraftPage`
Get portal draft page
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:** `updatePortalDraftPage`
Update portal draft page
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:** `deletePortalDraftPage`
Delete portal draft page
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:** `updatePortalDraftPageOrder`
Update portal draft page order
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:** `listPortalDraftResources`
List portal draft resources
Gets portals resources

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

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

**Operation ID:** `createPortalDraftResource`
Create portal draft resource
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:** `getPortalDraftResource`
Get portal draft resource
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:** `deletePortalDraftResource`
Delete portal draft resource
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:** `getPortalPage`
Get portal page
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:** `listMyQueries`
List my queries
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:** `createMyQuery`
Create my query
Creates a new query

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

**Operation ID:** `updateMyQuery`
Update my query
Edits a saved search query

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

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

**Operation ID:** `deleteMyQuery`
Delete my query
Deletes the query

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

### GET /featureFlags

**Operation ID:** `listFeatureFlags`
List feature flags
Lists featureFlags.

### GET /graphql

**Operation ID:** `getGraphqlPlayground`
Get GraphQL playground
Lists graphql.

### POST /graphql

**Operation ID:** `executeGraphqlQuery`
Execute GraphQL query
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.