# API Platform API Manage APIs, applications, alerts, and classifications in the Anypoint API Platform repository. - **Version:** 2.0.0 - **Category:** API Management - **OpenAPI Spec:** [api.yaml](https://dev-portal.mulesoft.com/apis/api-platform/api.yaml) ## Servers - `https://anypoint.mulesoft.com/apiplatform/repository/{version}` - `https://{region}.anypoint.mulesoft.com/apiplatform/repository/{version}` - `https://{region}.platform.mulesoft.com/apiplatform/repository/{version}` ## Operations (170) ### GET /public/apis **Operation ID:** `getPublicApis` Retrieves a list of APIs. **Parameters:** | `requireRaml` | query | Search only those APIs which have a publicly accesible RAML specification. | required | | `offset` | query | Skip over a number of elements by specifying an offset value for the query. | required | | `limit` | query | Limit the number of elements on the response. | required | | `sort` | query | Property to sort by. | required | | `ascending` | query | Order for sorting. | required | | `query` | query | Search criteria. | required | ### GET /organizations/active **Operation ID:** `getOrganizationsActive` Get the active organization. ### GET /organizations/{organizationId} **Operation ID:** `getOrganizationsByOrganizationid` Get the organization. **Parameters:** | `extended` | query | Obtain extended information from the organization. | required | | `resolveTheme` | query | Resolves the theme inheritance. | required | | `organizationId` | query | The organization ID to identify the target resource. | required | ### PUT /organizations/{organizationId} **Operation ID:** `updateOrganizationsByOrganizationid` Update the organization. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | ### DELETE /organizations/{organizationId} **Operation ID:** `deleteOrganizationsByOrganizationid` Delete the organization. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | ### GET /organizations/{organizationId}/migration-mapping **Operation ID:** `getOrganizationsByOrganizationidMigrationMapping` Get all api version migration mappings in CSV format. This is for setting up the Crowd upgrade. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | ### GET /organizations/{organizationId}/permissions **Operation ID:** `getOrganizationsByOrganizationidPermissions` Returns a list of elements. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | ### GET /organizations/{organizationId}/alerts **Operation ID:** `getOrganizationsByOrganizationidAlerts` Gets a collection of alerts. **Parameters:** | `apiVersionId` | query | The apiVersion ID query parameter. | required | | `tierId` | query | The tier ID query parameter. | required | | `lastModifiedSince` | query | Return items which have been modified since the specified timestamp | required | | `alertId` | query | The alert ID query parameter. | required | | `query` | query | Search criteria. | required | | `policyId` | query | The policy ID query parameter. | required | | `offset` | query | Skip over a number of elements by specifying an offset value for the query. | required | | `apiId` | query | The api ID query parameter. | required | | `ascending` | query | Order for sorting. | required | | `environmentId` | query | A string that will be checked for an exact match of the Environment ID | required | | `severity` | query | The severity query parameter. | required | | `sort` | query | Property to sort by. | required | | `type` | query | The type query parameter. | required | | `limit` | query | Limit the number of elements on the response. | required | | `active` | query | The active query parameter. | required | | `organizationId` | query | The organization ID to identify the target resource. | required | ### POST /organizations/{organizationId}/alerts **Operation ID:** `createOrganizationsByOrganizationidAlerts` Creates a new element. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | ### GET /organizations/{organizationId}/environments **Operation ID:** `getOrganizationsByOrganizationidEnvironments` Returns a list of elements. **Parameters:** | `withCloudhubPermissions` | query | Add to each environment the user's permissions in CloudHub | required | | `all` | query | Retrieve all environments, without filtering by the user's permissions. | required | | `organizationId` | query | The organization ID to identify the target resource. | required | ### GET /organizations/{organizationId}/environments/default **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsDefault` Retrieves a default. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | ### GET /organizations/{organizationId}/environments/{environmentId}/apis/{apiId}/versions/{apiVersionId}/alerts **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidApisByApiidVersionsByApiversionidAlerts` Returns a list of elements. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### POST /organizations/{organizationId}/environments/{environmentId}/apis/{apiId}/versions/{apiVersionId}/alerts **Operation ID:** `createOrganizationsByOrganizationidEnvironmentsByEnvironmentidApisByApiidVersionsByApiversionidAlerts` Creates a new element. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### GET /organizations/{organizationId}/environments/{environmentId}/apis/{apiId}/versions/{apiVersionId}/alerts/{alertId} **Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidApisByApiidVersionsByApiversionidAlertsByAlertid` Gets an alert. **Parameters:** | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | | `alertId` | query | The alert ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `organizationId` | query | The organization ID to identify the target resource. | required | ### PATCH /organizations/{organizationId}/environments/{environmentId}/apis/{apiId}/versions/{apiVersionId}/alerts/{alertId} **Operation ID:** `patchOrganizationsByOrganizationidEnvironmentsByEnvironmentidApisByApiidVersionsByApiversionidAlertsByAlertid` Updates a alert. **Parameters:** | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | | `alertId` | query | The alert ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `organizationId` | query | The organization ID to identify the target resource. | required | ### DELETE /organizations/{organizationId}/environments/{environmentId}/apis/{apiId}/versions/{apiVersionId}/alerts/{alertId} **Operation ID:** `deleteOrganizationsByOrganizationidEnvironmentsByEnvironmentidApisByApiidVersionsByApiversionidAlertsByAlertid` Deletes the specified alert definition. **Parameters:** | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | | `alertId` | query | The alert ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `environmentId` | query | The environment ID to identify the target resource. | required | | `organizationId` | query | The organization ID to identify the target resource. | required | ### PUT /organizations/{organizationId}/theme **Operation ID:** `updateOrganizationsByOrganizationidTheme` Update the organization theme. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | ### GET /organizations/{organizationId}/theme/default **Operation ID:** `getOrganizationsByOrganizationidThemeDefault` Get the default theme for an organization. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | ### GET /organizations/{organizationId}/portals/terms **Operation ID:** `getOrganizationsByOrganizationidPortalsTerms` Gets portal terms set for the organization. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | ### PUT /organizations/{organizationId}/portals/terms **Operation ID:** `updateOrganizationsByOrganizationidPortalsTerms` Create portal terms for the organization. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | ### DELETE /organizations/{organizationId}/portals/terms **Operation ID:** `deleteOrganizationsByOrganizationidPortalsTerms` Deletes portal terms for the organization. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | ### PUT /organizations/{organizationId}/portals/redirectUri **Operation ID:** `updateOrganizationsByOrganizationidPortalsRedirecturi` Update redirect uri of the list of portals for the organization **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | ### GET /organizations/{organizationId}/apis **Operation ID:** `getOrganizationsByOrganizationidApis` Retrieves a list of APIs. **Parameters:** | `query` | query | Search criteria. | required | | `offset` | query | Skip over a number of elements by specifying an offset value for the query. | required | | `filters` | query | The filters query parameter. | required | | `ascending` | query | Order for sorting. | required | | `requirePortal` | query | The requirePortal query parameter. | required | | `sort` | query | Property to sort by. | required | | `limit` | query | Limit the number of elements on the response. | required | | `organizationId` | query | The organization ID to identify the target resource. | required | ### POST /organizations/{organizationId}/apis **Operation ID:** `createOrganizationsByOrganizationidApis` Creates an API. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | ### GET /organizations/{organizationId}/apis/by-name **Operation ID:** `getOrganizationsByOrganizationidApisByName` Returns a single API that matches the passed-in API name. Returns null if no match is found. **Parameters:** | `apiName` | query | The apiName query parameter. | required | | `organizationId` | query | The organization ID to identify the target resource. | required | ### POST /organizations/{organizationId}/apis/versions **Operation ID:** `createOrganizationsByOrganizationidApisVersions` Create an API Version from an Exchange Spec. Only available after the Crowd upgrade. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | ### GET /organizations/{organizationId}/apis/versions/by-endpoint **Operation ID:** `getOrganizationsByOrganizationidApisVersionsByEndpoint` Returns a list of API versions for a given list of endpoints. **Parameters:** | `uris` | query | The uris query parameter. | required | | `organizationId` | query | The organization ID to identify the target resource. | required | ### GET /organizations/{organizationId}/apis/versions/by-name **Operation ID:** `getOrganizationsByOrganizationidApisVersionsByName` Returns a single API that matches the passed-in API name and API version name. Returns null if no match is found. **Parameters:** | `apiName` | query | The apiName query parameter. | required | | `versionName` | query | The versionName query parameter. | required | | `organizationId` | query | The organization ID to identify the target resource. | required | ### GET /organizations/{organizationId}/apis/versions/tiers **Operation ID:** `getOrganizationsByOrganizationidApisVersionsTiers` Returns permitted SLA tiers within an organization. It means every SLA tier that belongs to API version requesting user has access to. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | ### GET /organizations/{organizationId}/apis/versions/contracts/applications **Operation ID:** `getOrganizationsByOrganizationidApisVersionsContractsApplications` Returns permitted applications within an organization. It means every applications that has a contract with an API version requesting user has access to. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | ### GET /organizations/{organizationId}/apis/{apiId} **Operation ID:** `getOrganizationsByOrganizationidApisByApiid` Returns an API and all its versions. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | ### PATCH /organizations/{organizationId}/apis/{apiId} **Operation ID:** `patchOrganizationsByOrganizationidApisByApiid` Updates a apis. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | ### DELETE /organizations/{organizationId}/apis/{apiId} **Operation ID:** `deleteOrganizationsByOrganizationidApisByApiid` Deletes a apis. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | ### GET /organizations/{organizationId}/apis/{apiId}/portals **Operation ID:** `getOrganizationsByOrganizationidApisByApiidPortals` Returns a collection of API portals. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | ### POST /organizations/{organizationId}/apis/{apiId}/permissions **Operation ID:** `createOrganizationsByOrganizationidApisByApiidPermissions` Grant a user view access to this API. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | ### POST /organizations/{organizationId}/apis/{apiId}/versions **Operation ID:** `createOrganizationsByOrganizationidApisByApiidVersions` Creates an API version. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | ### GET /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId} **Operation ID:** `getOrganizationsByOrganizationidApisByApiidVersionsByApiversionid` Returns an instance of a single element. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### PUT /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId} **Operation ID:** `updateOrganizationsByOrganizationidApisByApiidVersionsByApiversionid` Updates a single element. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### PATCH /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId} **Operation ID:** `patchOrganizationsByOrganizationidApisByApiidVersionsByApiversionid` Patches a single element. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### DELETE /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId} **Operation ID:** `deleteOrganizationsByOrganizationidApisByApiidVersionsByApiversionid` Deletes the instance of the element specified. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### POST /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/classify **Operation ID:** `createOrganizationsByOrganizationidApisByApiidVersionsByApiversionidClassify` (Only avaliable after the Crowd upgrade) Moves an API Version from the unclassified environment into a specified environment. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### GET /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/export **Operation ID:** `getOrganizationsByOrganizationidApisByApiidVersionsByApiversionidExport` Exports an API Version. **Parameters:** | `portal` | query | Include portal. | required | | `files` | query | Include definition files. | required | | `slaTiers` | query | Include SLA tiers. | required | | `portalAttachments` | query | Include portal attachments. | required | | `endpoint` | query | Include endpoint definition. | required | | `portalFiles` | query | Include portal images. | required | | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### GET /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/users **Operation ID:** `getOrganizationsByOrganizationidApisByApiidVersionsByApiversionidUsers` Search for users. **Parameters:** | `search` | query | Search or filter expression to narrow results. | required | | `includeCurrent` | query | Whether to include the currently logged-in user in the search results or not. | required | | `offset` | query | Offset on the amount of assets (each of which has all its apis) | required | | `limit` | query | Limit on the amount of assets (each of which has all its apis) | required | | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### GET /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/users/by-roles **Operation ID:** `getOrganizationsByOrganizationidApisByApiidVersionsByApiversionidUsersByRoles` Search for users who match a specific set of roles. **Parameters:** | `API_VERSION_OWNER` | query | Context params for the API VERSION OWNER role. | required | | `PORTAL_ACCESS` | query | Context params for the PORTAL ACCESS role. | required | | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### GET /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/users/owners **Operation ID:** `getOrganizationsByOrganizationidApisByApiidVersionsByApiversionidUsersOwners` Return all owners of an API version. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### POST /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/permissions **Operation ID:** `createOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPermissions` Grant a user admin access to this API version. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### DELETE /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/permissions **Operation ID:** `deleteOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPermissions` Revoke a user's admin access to this API version. **Parameters:** | `userId` | query | The user ID query parameter. | required | | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### GET /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/migration-mapping **Operation ID:** `getOrganizationsByOrganizationidApisByApiidVersionsByApiversionidMigrationMapping` Get the api version migration mapping of an API version **Parameters:** | `apiVersionId` | query | The apiVersion ID query parameter. | required | | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### POST /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/migration-mapping **Operation ID:** `createOrganizationsByOrganizationidApisByApiidVersionsByApiversionidMigrationMapping` Create a migration mapping for an API version **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### PUT /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/migration-mapping **Operation ID:** `updateOrganizationsByOrganizationidApisByApiidVersionsByApiversionidMigrationMapping` Update a migration mapping of an API version **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### GET /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/portal **Operation ID:** `getOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPortal` Obtain the portal associated with the API version. **Parameters:** | `resolveTheme` | query | Resolves theme inheritance. | required | | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### POST /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/portal **Operation ID:** `createOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPortal` Create a portal and associates it with an API version. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### PATCH /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/portal **Operation ID:** `patchOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPortal` Create a portal and associates it with an API version. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### POST /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/portal/permissions **Operation ID:** `createOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPortalPermissions` Grant a user view access to this portal. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### DELETE /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/portal/permissions **Operation ID:** `deleteOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPortalPermissions` Revoke a user's view access to portal. **Parameters:** | `userId` | query | The user ID query parameter. | required | | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### PUT /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/portal/redirectUri **Operation ID:** `updateOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPortalRedirecturi` Update redirec uri for a portal **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### POST /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/portal/pages **Operation ID:** `createOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPortalPages` Creates a new element. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### PUT /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/portal/pages/{pageId} **Operation ID:** `updateOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPortalPagesByPageid` Update an existing page. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | | `pageId` | query | The page ID to identify the target resource. | required | ### DELETE /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/portal/pages/{pageId} **Operation ID:** `deleteOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPortalPagesByPageid` Deletes a pages. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | | `pageId` | query | The page ID to identify the target resource. | required | ### GET /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/portal/pages/{pageId}/widgets **Operation ID:** `getOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPortalPagesByPageidWidgets` Returns all content widgets of a page. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | | `pageId` | query | The page ID to identify the target resource. | required | ### PATCH /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/portal/pages/{pageId}/widgets **Operation ID:** `patchOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPortalPagesByPageidWidgets` Updates the collection of widgets. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | | `pageId` | query | The page ID to identify the target resource. | required | ### PUT /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/portal/theme **Operation ID:** `updateOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPortalTheme` Update the portal theme. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### POST /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/portal/files **Operation ID:** `createOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPortalFiles` Upload an api portal file. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### GET /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/portal/files/{fileId} **Operation ID:** `getOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPortalFilesByFileid` Gets the portal file. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | | `fileId` | query | The file ID to identify the target resource. | required | ### DELETE /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/portal/files/{fileId} **Operation ID:** `deleteOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPortalFilesByFileid` Removes the Portal file. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | | `fileId` | query | The file ID to identify the target resource. | required | ### GET /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/portal/files/{fileId}/{fileName} **Operation ID:** `getOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPortalFilesByFileidByFilename` Same as parent get but allows to set a file name in the content-disposition header for downloading in a browser environment. **Parameters:** | `fileId` | query | The file ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | | `fileName` | query | The fileName to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `organizationId` | query | The organization ID to identify the target resource. | required | ### POST /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/addRootRaml **Operation ID:** `createOrganizationsByOrganizationidApisByApiidVersionsByApiversionidAddrootraml` Adds the root RAML for this API version. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### GET /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/definition **Operation ID:** `getOrganizationsByOrganizationidApisByApiidVersionsByApiversionidDefinition` Gets the RAML SPEC. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### GET /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/endpoint **Operation ID:** `getOrganizationsByOrganizationidApisByApiidVersionsByApiversionidEndpoint` Returns the endpoint associated with the API version. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### POST /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/endpoint **Operation ID:** `createOrganizationsByOrganizationidApisByApiidVersionsByApiversionidEndpoint` Creates an endpoint for the API version. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### PUT /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/endpoint **Operation ID:** `updateOrganizationsByOrganizationidApisByApiidVersionsByApiversionidEndpoint` Updates the endpoint associated with the API version. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### PATCH /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/endpoint **Operation ID:** `patchOrganizationsByOrganizationidApisByApiidVersionsByApiversionidEndpoint` Updates the endpoint associated with the API version. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### DELETE /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/endpoint **Operation ID:** `deleteOrganizationsByOrganizationidApisByApiidVersionsByApiversionidEndpoint` Deletes the endpoint associated with the API version. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### POST /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/endpoint/active **Operation ID:** `createOrganizationsByOrganizationidApisByApiidVersionsByApiversionidEndpointActive` Records activity for an API version. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### GET /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/files **Operation ID:** `getOrganizationsByOrganizationidApisByApiidVersionsByApiversionidFiles` Returns a list of elements. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### POST /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/files **Operation ID:** `createOrganizationsByOrganizationidApisByApiidVersionsByApiversionidFiles` Creates a new element. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### GET /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/files/export **Operation ID:** `getOrganizationsByOrganizationidApisByApiidVersionsByApiversionidFilesExport` Exports all files in the filesystem as a ZIP file. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### GET /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/files/{apiVersionFileId} **Operation ID:** `getOrganizationsByOrganizationidApisByApiidVersionsByApiversionidFilesByApiversionfileid` Obtain a RAML file (or directory). **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | | `apiVersionFileId` | query | The apiVersionFile ID to identify the target resource. | required | ### PUT /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/files/{apiVersionFileId} **Operation ID:** `updateOrganizationsByOrganizationidApisByApiidVersionsByApiversionidFilesByApiversionfileid` Replaces a files. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | | `apiVersionFileId` | query | The apiVersionFile ID to identify the target resource. | required | ### DELETE /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/files/{apiVersionFileId} **Operation ID:** `deleteOrganizationsByOrganizationidApisByApiidVersionsByApiversionidFilesByApiversionfileid` Deletes a files. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | | `apiVersionFileId` | query | The apiVersionFile ID to identify the target resource. | required | ### GET /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/policies **Operation ID:** `getOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPolicies` Returns a list of elements. **Parameters:** | `standalone` | query | The standalone query parameter. | required | | `version` | query | The version query parameter. | required | | `fullInfo` | query | The fullInfo query parameter. | required | | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | | `if-modified-since` | query | Last modification date (EPOC) | optional | ### POST /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/policies **Operation ID:** `createOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPolicies` Creates a new element. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### PATCH /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/policies **Operation ID:** `patchOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPolicies` Updates multiple policies. Currently, only updates in order field are supported. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### PATCH /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/policies/{policyId} **Operation ID:** `patchOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPoliciesByPolicyid` Updates a policies. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | | `policyId` | query | Applied policy instance id on this API instance. | required | ### DELETE /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/policies/{policyId} **Operation ID:** `deleteOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPoliciesByPolicyid` Unapplies a policy. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | | `policyId` | query | Applied policy instance id on this API instance. | required | ### POST /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/policies/{policyId}/disable **Operation ID:** `createOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPoliciesByPolicyidDisable` Creates a disable. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | | `policyId` | query | Applied policy instance id on this API instance. | required | ### POST /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/policies/{policyId}/enable **Operation ID:** `createOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPoliciesByPolicyidEnable` Creates a enable. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | | `policyId` | query | Applied policy instance id on this API instance. | required | ### POST /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/tags/{tag} **Operation ID:** `createOrganizationsByOrganizationidApisByApiidVersionsByApiversionidTagsByTag` Adds a tag to an API version. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | | `tag` | query | The tag to identify the target resource. | required | ### DELETE /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/tags/{tag} **Operation ID:** `deleteOrganizationsByOrganizationidApisByApiidVersionsByApiversionidTagsByTag` Removes a tag from an API version. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | | `tag` | query | The tag to identify the target resource. | required | ### GET /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/tiers **Operation ID:** `getOrganizationsByOrganizationidApisByApiidVersionsByApiversionidTiers` Retrieves a list of tiers for the supplied api version. **Parameters:** | `query` | query | Search criteria. | required | | `offset` | query | Skip over a number of elements by specifying an offset value for the query. | required | | `ascending` | query | Order for sorting. | required | | `sort` | query | Property to sort by. | required | | `limit` | query | Limit the number of elements on the response. | required | | `active` | query | Retrieve only active tiers if set to true. | required | | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### POST /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/tiers **Operation ID:** `createOrganizationsByOrganizationidApisByApiidVersionsByApiversionidTiers` Creates a sla tier for the API version. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### PUT /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/tiers/{tierId} **Operation ID:** `updateOrganizationsByOrganizationidApisByApiidVersionsByApiversionidTiersByTierid` Update a tier associated with an API version. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | | `tierId` | query | SLA tier id on this API instance or API group instance tier (integer). | required | ### DELETE /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/tiers/{tierId} **Operation ID:** `deleteOrganizationsByOrganizationidApisByApiidVersionsByApiversionidTiersByTierid` Delete a tier that has no active applications. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | | `tierId` | query | SLA tier id on this API instance or API group instance tier (integer). | required | ### GET /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/contracts **Operation ID:** `getOrganizationsByOrganizationidApisByApiidVersionsByApiversionidContracts` Retrieves a list of applications with contracts with the API version. **Parameters:** | `includeExtraRedirections` | query | The includeExtraRedirections query parameter. | required | | `query` | query | Search criteria. | required | | `offset` | query | Skip over a number of elements by specifying an offset value for the query. | required | | `coreServicesId` | query | The coreServices ID query parameter. | required | | `status` | query | The status query parameter. | required | | `ascending` | query | Order for sorting. | required | | `sort` | query | Property to sort by. | required | | `limit` | query | Limit the number of elements on the response. | required | | `includeExtraApplicationData` | query | The includeExtraApplicationData query parameter. | required | | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### GET /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/contracts/{contractId} **Operation ID:** `getOrganizationsByOrganizationidApisByApiidVersionsByApiversionidContractsByContractid` Retrieves a specific contract for the API version. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | | `contractId` | query | Contract id on API group instance or managed service API (string form). | required | ### PATCH /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/contracts/{contractId} **Operation ID:** `patchOrganizationsByOrganizationidApisByApiidVersionsByApiversionidContractsByContractid` Patches contract conditions. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | | `contractId` | query | Contract id on API group instance or managed service API (string form). | required | ### DELETE /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/contracts/{contractId} **Operation ID:** `deleteOrganizationsByOrganizationidApisByApiidVersionsByApiversionidContractsByContractid` Deletes the contract. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | | `contractId` | query | Contract id on API group instance or managed service API (string form). | required | ### POST /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/contracts/{contractId}/approveTierChange **Operation ID:** `createOrganizationsByOrganizationidApisByApiidVersionsByApiversionidContractsByContractidApprovetierchange` Creates a approveTierChange. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | | `contractId` | query | Contract id on API group instance or managed service API (string form). | required | ### POST /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/contracts/{contractId}/approve **Operation ID:** `createOrganizationsByOrganizationidApisByApiidVersionsByApiversionidContractsByContractidApprove` Creates a approve. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | | `contractId` | query | Contract id on API group instance or managed service API (string form). | required | ### POST /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/contracts/{contractId}/reject **Operation ID:** `createOrganizationsByOrganizationidApisByApiidVersionsByApiversionidContractsByContractidReject` Creates a reject. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | | `contractId` | query | Contract id on API group instance or managed service API (string form). | required | ### POST /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/contracts/{contractId}/rejectTierChange **Operation ID:** `createOrganizationsByOrganizationidApisByApiidVersionsByApiversionidContractsByContractidRejecttierchange` Creates a rejectTierChange. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | | `contractId` | query | Contract id on API group instance or managed service API (string form). | required | ### POST /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/contracts/{contractId}/restore **Operation ID:** `createOrganizationsByOrganizationidApisByApiidVersionsByApiversionidContractsByContractidRestore` Creates a restore. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | | `contractId` | query | Contract id on API group instance or managed service API (string form). | required | ### POST /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/contracts/{contractId}/revoke **Operation ID:** `createOrganizationsByOrganizationidApisByApiidVersionsByApiversionidContractsByContractidRevoke` Creates a revoke. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | | `contractId` | query | Contract id on API group instance or managed service API (string form). | required | ### GET /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/proxy **Operation ID:** `getOrganizationsByOrganizationidApisByApiidVersionsByApiversionidProxy` Gets a proxy. **Parameters:** | `gatewayVersion` | query | The gatewayVersion query parameter. | required | | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### POST /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/proxy/deployment **Operation ID:** `createOrganizationsByOrganizationidApisByApiidVersionsByApiversionidProxyDeployment` Creates a deployment. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### PATCH /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/proxy/deployment **Operation ID:** `patchOrganizationsByOrganizationidApisByApiidVersionsByApiversionidProxyDeployment` Updates a deployment. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### GET /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/proxy/deployment/status **Operation ID:** `getOrganizationsByOrganizationidApisByApiidVersionsByApiversionidProxyDeploymentStatus` Retrieves the deployment details of a version. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### GET /organizations/{organizationId}/apis/{apiId}/versions/{apiVersionId}/gateway-versions **Operation ID:** `getOrganizationsByOrganizationidApisByApiidVersionsByApiversionidGatewayVersions` Retrieves the gateway versions compatible **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### GET /organizations/{organizationId}/policy-templates **Operation ID:** `getOrganizationsByOrganizationidPolicyTemplates` Retrieve a list of policy templates. **Parameters:** | `version` | query | The version query parameter. | required | | `organizationId` | query | The organization ID to identify the target resource. | required | ### GET /organizations/{organizationId}/policy-templates/{policyTemplateId} **Operation ID:** `getOrganizationsByOrganizationidPolicyTemplatesByPolicytemplateid` Retrieve specific details from the policy template, including the full XML that is being injected as well as all of its configuration parameters. **Parameters:** | `version` | query | The version query parameter. | required | | `organizationId` | query | The organization ID to identify the target resource. | required | | `policyTemplateId` | query | The policyTemplate ID to identify the target resource. | required | ### GET /organizations/{organizationId}/custom-policy-templates **Operation ID:** `getOrganizationsByOrganizationidCustomPolicyTemplates` Retrieves a list of custom policy templates. **Parameters:** | `query` | query | Search criteria. | required | | `offset` | query | Skip over a number of elements by specifying an offset value for the query. | required | | `ascending` | query | Order for sorting. | required | | `sort` | query | Property to sort by. | required | | `limit` | query | Limit the number of elements on the response. | required | | `organizationId` | query | The organization ID to identify the target resource. | required | ### POST /organizations/{organizationId}/custom-policy-templates **Operation ID:** `createOrganizationsByOrganizationidCustomPolicyTemplates` Creates a new custom policy. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | ### GET /organizations/{organizationId}/custom-policy-templates/{customPolicyTemplateId} **Operation ID:** `getOrganizationsByOrganizationidCustomPolicyTemplatesByCustompolicytemplateid` Returns an instance of a single element. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `customPolicyTemplateId` | query | The customPolicyTemplate ID to identify the target resource. | required | ### PUT /organizations/{organizationId}/custom-policy-templates/{customPolicyTemplateId} **Operation ID:** `updateOrganizationsByOrganizationidCustomPolicyTemplatesByCustompolicytemplateid` Updates a single element. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `customPolicyTemplateId` | query | The customPolicyTemplate ID to identify the target resource. | required | ### PATCH /organizations/{organizationId}/custom-policy-templates/{customPolicyTemplateId} **Operation ID:** `patchOrganizationsByOrganizationidCustomPolicyTemplatesByCustompolicytemplateid` Patches a single element. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `customPolicyTemplateId` | query | The customPolicyTemplate ID to identify the target resource. | required | ### DELETE /organizations/{organizationId}/custom-policy-templates/{customPolicyTemplateId} **Operation ID:** `deleteOrganizationsByOrganizationidCustomPolicyTemplatesByCustompolicytemplateid` Deletes the instance of the element specified. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `customPolicyTemplateId` | query | The customPolicyTemplate ID to identify the target resource. | required | ### GET /organizations/{organizationId}/custom-policy-templates/{customPolicyTemplateId}/configuration **Operation ID:** `getOrganizationsByOrganizationidCustomPolicyTemplatesByCustompolicytemplateidConfiguration` The XML configuration for the custom policy template. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `customPolicyTemplateId` | query | The customPolicyTemplate ID to identify the target resource. | required | ### GET /organizations/{organizationId}/custom-policy-templates/{customPolicyTemplateId}/definition **Operation ID:** `getOrganizationsByOrganizationidCustomPolicyTemplatesByCustompolicytemplateidDefinition` The YAML definition for the custom policy template. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `customPolicyTemplateId` | query | The customPolicyTemplate ID to identify the target resource. | required | ### GET /organizations/{organizationId}/portals **Operation ID:** `getOrganizationsByOrganizationidPortals` Returns a list of elements. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | ### POST /organizations/{organizationId}/portals **Operation ID:** `createOrganizationsByOrganizationidPortals` Creates a new element. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | ### GET /organizations/{organizationId}/users **Operation ID:** `getOrganizationsByOrganizationidUsers` Search for users **Parameters:** | `search` | query | The search string to query users for. | required | | `includeCurrent` | query | Whether to include the currently logged-in user in the search results or not. | required | | `offset` | query | Offset on the amount of assets (each of which has all its apis) | required | | `limit` | query | Limit on the amount of assets (each of which has all its apis) | required | | `organizationId` | query | The organization ID to identify the target resource. | required | ### GET /organizations/{organizationId}/applications **Operation ID:** `getOrganizationsByOrganizationidApplications` Retrieves a list of applications. **Parameters:** | `targetAdminSite` | query | Retrieve applications with all the information needed for the admin site. | required | | `query` | query | Search criteria. | required | | `includeContractsForApiVersion` | query | This field is used to filter by API version. | required | | `offset` | query | Skip over a number of elements by specifying an offset value for the query. | required | | `ascending` | query | Order for sorting. | required | | `sort` | query | Property to sort by. Possible values 'id', 'name', 'status', 'createdDate' or 'updatedDate'. | optional | | `limit` | query | Limit the number of elements on the response. | required | | `organizationId` | query | The organization ID to identify the target resource. | required | ### POST /organizations/{organizationId}/applications **Operation ID:** `createOrganizationsByOrganizationidApplications` Creates a new application. **Parameters:** | `apiVersionId` | query | Used to associate the application with the IDP (Identity Provider) configured on the api instance. This parameter is not needed when the organization is not fully migrated to crowd or when the organization does not use a client provider. | optional | | `groupInstanceId` | query | Used to associate the application with the IDP (Identity Provider) configured on the api instances of the group instance. This parameter is not needed when the organization is not fully migrated to crowd or when the organization does not use a client provider. | optional | | `organizationId` | query | The organization ID to identify the target resource. | required | ### GET /organizations/{organizationId}/applications/{applicationId} **Operation ID:** `getOrganizationsByOrganizationidApplicationsByApplicationid` Returns an instance of a single element. **Parameters:** | `ignoreOwners` | query | Retrieve application with or without owners information. | required | | `organizationId` | query | The organization ID to identify the target resource. | required | | `applicationId` | query | Could be an API Manager application ID or a Core Services client ID. | required | ### PUT /organizations/{organizationId}/applications/{applicationId} **Operation ID:** `updateOrganizationsByOrganizationidApplicationsByApplicationid` Updates a single element. **Parameters:** | `organizationId` | query | The organization 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/{organizationId}/applications/{applicationId} **Operation ID:** `patchOrganizationsByOrganizationidApplicationsByApplicationid` Patches a single element. **Parameters:** | `organizationId` | query | The organization 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}/applications/{applicationId} **Operation ID:** `deleteOrganizationsByOrganizationidApplicationsByApplicationid` Deletes the instance of the element specified. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `applicationId` | query | Could be an API Manager application ID or a Core Services client ID. | required | ### POST /organizations/{organizationId}/applications/{applicationId}/secret/reset **Operation ID:** `createOrganizationsByOrganizationidApplicationsByApplicationidSecretReset` Creates a reset. **Parameters:** | `organizationId` | query | The organization 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/{organizationId}/applications/{applicationId}/party-ids **Operation ID:** `getOrganizationsByOrganizationidApplicationsByApplicationidPartyIds` Retrieves a list of Party Ids for a specific api version. **Parameters:** | `apiVersionId` | query | The apiVersion ID query parameter. | required | | `organizationId` | query | The organization ID to identify the target resource. | required | | `applicationId` | query | Could be an API Manager application ID or a Core Services client ID. | required | ### POST /organizations/{organizationId}/applications/{applicationId}/owners **Operation ID:** `createOrganizationsByOrganizationidApplicationsByApplicationidOwners` Adds an owner to an existing application. **Parameters:** | `organizationId` | query | The organization 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}/applications/{applicationId}/owners/{userId} **Operation ID:** `deleteOrganizationsByOrganizationidApplicationsByApplicationidOwnersByUserid` Removes an owner from an existing application. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `applicationId` | query | Could be an API Manager application ID or a Core Services client ID. | required | | `userId` | query | The user ID to identify the target resource. | required | ### GET /organizations/{organizationId}/applications/{applicationId}/contracts **Operation ID:** `getOrganizationsByOrganizationidApplicationsByApplicationidContracts` Retrieves a list of applications with contracts with the application. **Parameters:** | `query` | query | Search criteria. | required | | `offset` | query | Skip over a number of elements by specifying an offset value for the query. | required | | `ascending` | query | Order for sorting. | required | | `sort` | query | Property to sort by. | required | | `limit` | query | Limit the number of elements on the response. | required | | `organizationId` | query | The organization ID to identify the target resource. | required | | `applicationId` | query | Could be an API Manager application ID or a Core Services client ID. | required | ### POST /organizations/{organizationId}/applications/{applicationId}/contracts **Operation ID:** `createOrganizationsByOrganizationidApplicationsByApplicationidContracts` Creates new contract between an API version and the application. **Parameters:** | `organizationId` | query | The organization 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/{organizationId}/applications/{applicationId}/contracts/{contractId} **Operation ID:** `patchOrganizationsByOrganizationidApplicationsByApplicationidContractsByContractid` Patches contract conditions. **Parameters:** | `organizationId` | query | The organization 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 | ### GET /organizations/{organizationId}/contracts **Operation ID:** `getOrganizationsByOrganizationidContracts` Retrieves a contracts. **Parameters:** | `apiVersionId` | query | The apiVersion ID query parameter. | required | | `coreServicesId` | query | The coreServices ID query parameter. | required | | `organizationId` | query | The organization ID to identify the target resource. | required | ### GET /organizations/{organizationId}/deployment-targets **Operation ID:** `getOrganizationsByOrganizationidDeploymentTargets` Retrieves a deployment targets. **Parameters:** | `environmentId` | query | A string that will be checked for an exact match of the Environment ID | required | | `organizationId` | query | The organization ID to identify the target resource. | required | ### POST /organizations/{organizationId}/bundles **Operation ID:** `createOrganizationsByOrganizationidBundles` Creates a bundles. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | ### GET /organizations/{organizationId}/public/theme/logo **Operation ID:** `getOrganizationsByOrganizationidPublicThemeLogo` Retrieves a logo. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | ### GET /organizations/{organizationId}/public/theme/favicon **Operation ID:** `getOrganizationsByOrganizationidPublicThemeFavicon` Retrieves a favicon. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | ### GET /organizations/{organizationId}/public/permissions **Operation ID:** `getOrganizationsByOrganizationidPublicPermissions` Retrieves a permissions. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | ### GET /organizations/{organizationId}/public/portals **Operation ID:** `getOrganizationsByOrganizationidPublicPortals` Returns a list of elements. **Parameters:** | `query[tags]` | query | A list of keywords for matching API version tags in a search. Used in conjunction with other 'query[xxx]' to perform advanced search. Note: when any of 'query[xxx]' is used, the query parameter 'query' would be disregarded. | required | | `requireRaml` | query | The requireRaml query parameter. | required | | `query` | query | Search criteria. | required | | `query[name]` | query | A list of keywords for matching API name in a search. Used in conjunction with other 'query[xxx]' to perform advanced search. Note: when any of 'query[xxx]' is used, the query parameter 'query' would be disregarded. | required | | `query[version]` | query | A list of keywords for matching API version name in a search. Used in conjunction with other 'query[xxx]' to perform advanced search. Note: when any of 'query[xxx]' is used, the query parameter 'query' would be disregarded. | required | | `offset` | query | Skip over a number of elements by specifying an offset value for the query. | required | | `deep` | query | A boolean value that, when set, would cause the search be perform on the organization associated with 'organizationId' param, as well as all the sub-organizations under it - as long as the login user has permission to view the content. | required | | `ascending` | query | Order for sorting. | required | | `query[description]` | query | A list of keywords for matching API version description in a search. Used in conjunction with other 'query[xxx]' to perform advanced search. Note: when any of 'query[xxx]' is used, the query parameter 'query' would be disregarded. | required | | `organizationId` | query | The organization ID that the search should be run in. If not provided, search would be performed within the organization which the login user is under. | required | | `sort` | query | Property to sort by. | required | | `query[matchAll]` | query | A boolean value that determines how other 'query[xxx]' values should work together in an advanced search When 'matchAll' is true, all other 'query[xxx]' would be chained with an 'AND' when performing a search, otherwise they are chained with an 'OR' Note: when any of 'query[xxx]' is used, the query parameter 'query' would be disregarded. | required | | `limit` | query | Limit the number of elements on the response. | required | | `organizationId` | query | The organization ID to identify the target resource. | required | ### POST /organizations/{organizationId}/public/portals **Operation ID:** `createOrganizationsByOrganizationidPublicPortals` Creates a new element. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | ### GET /organizations/{organizationId}/public/portals/{portalId}/theme/logo **Operation ID:** `getOrganizationsByOrganizationidPublicPortalsByPortalidThemeLogo` Retrieves a logo. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `portalId` | query | The portal ID to identify the target resource. | required | ### GET /organizations/{organizationId}/public/portals/{portalId}/theme/favicon **Operation ID:** `getOrganizationsByOrganizationidPublicPortalsByPortalidThemeFavicon` Retrieves a favicon. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `portalId` | query | The portal ID to identify the target resource. | required | ### GET /organizations/{organizationId}/public/portals/terms **Operation ID:** `getOrganizationsByOrganizationidPublicPortalsTerms` Retrieves a terms. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | ### GET /organizations/{organizationId}/public/portals/terms/acceptance **Operation ID:** `getOrganizationsByOrganizationidPublicPortalsTermsAcceptance` Retrieves a acceptance. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | ### POST /organizations/{organizationId}/public/portals/terms/{portalTermsId}/acceptance **Operation ID:** `createOrganizationsByOrganizationidPublicPortalsTermsByPortaltermsidAcceptance` Creates a acceptance. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `portalTermsId` | query | The portalTerms ID to identify the target resource. | required | ### GET /organizations/{organizationId}/public/apis/{apiId} **Operation ID:** `getOrganizationsByOrganizationidPublicApisByApiid` Returns an instance of a single element. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | ### PUT /organizations/{organizationId}/public/apis/{apiId} **Operation ID:** `updateOrganizationsByOrganizationidPublicApisByApiid` Updates a single element. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | ### PATCH /organizations/{organizationId}/public/apis/{apiId} **Operation ID:** `patchOrganizationsByOrganizationidPublicApisByApiid` Patches a single element. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | ### DELETE /organizations/{organizationId}/public/apis/{apiId} **Operation ID:** `deleteOrganizationsByOrganizationidPublicApisByApiid` Deletes the instance of the element specified. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | ### GET /organizations/{organizationId}/public/apis/{apiId}/versions/{apiVersionId} **Operation ID:** `getOrganizationsByOrganizationidPublicApisByApiidVersionsByApiversionid` Returns an instance of a single element. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### PUT /organizations/{organizationId}/public/apis/{apiId}/versions/{apiVersionId} **Operation ID:** `updateOrganizationsByOrganizationidPublicApisByApiidVersionsByApiversionid` Updates a single element. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### PATCH /organizations/{organizationId}/public/apis/{apiId}/versions/{apiVersionId} **Operation ID:** `patchOrganizationsByOrganizationidPublicApisByApiidVersionsByApiversionid` Patches a single element. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### DELETE /organizations/{organizationId}/public/apis/{apiId}/versions/{apiVersionId} **Operation ID:** `deleteOrganizationsByOrganizationidPublicApisByApiidVersionsByApiversionid` Deletes the instance of the element specified. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### GET /organizations/{organizationId}/public/apis/{apiId}/versions/{apiVersionId}/portal **Operation ID:** `getOrganizationsByOrganizationidPublicApisByApiidVersionsByApiversionidPortal` Retrieves a portal. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### GET /organizations/{organizationId}/public/apis/{apiId}/versions/{apiVersionId}/portal/pages/{pageId}/widgets **Operation ID:** `getOrganizationsByOrganizationidPublicApisByApiidVersionsByApiversionidPortalPagesByPageidWidgets` Retrieves a widgets. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | | `pageId` | query | The page ID to identify the target resource. | required | ### GET /organizations/{organizationId}/public/apis/{apiId}/versions/{apiVersionId}/portal/files/{fileId} **Operation ID:** `getOrganizationsByOrganizationidPublicApisByApiidVersionsByApiversionidPortalFilesByFileid` Retrieve the file by file id. Content-type will be set based on the content-type originally received. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | | `fileId` | query | The file ID to identify the target resource. | required | ### GET /organizations/{organizationId}/public/apis/{apiId}/versions/{apiVersionId}/portal/files/{fileId}/{fileName} **Operation ID:** `getOrganizationsByOrganizationidPublicApisByApiidVersionsByApiversionidPortalFilesByFileidByFilename` Same as parent get but allows to set a file name in the content-disposition header for downloading in a browser environment. **Parameters:** | `fileId` | query | The file ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | | `fileName` | query | The fileName to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `organizationId` | query | The organization ID to identify the target resource. | required | ### GET /organizations/{organizationId}/public/apis/{apiId}/versions/{apiVersionId}/tiers **Operation ID:** `getOrganizationsByOrganizationidPublicApisByApiidVersionsByApiversionidTiers` Retrieves a tiers. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### GET /organizations/{organizationId}/public/apis/{apiId}/versions/{apiVersionId}/definition **Operation ID:** `getOrganizationsByOrganizationidPublicApisByApiidVersionsByApiversionidDefinition` Gets the RAML SPEC. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### PUT /organizations/{organizationId}/public/apis/{apiId}/versions/{apiVersionId}/definition **Operation ID:** `updateOrganizationsByOrganizationidPublicApisByApiidVersionsByApiversionidDefinition` Updates a single element. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### PATCH /organizations/{organizationId}/public/apis/{apiId}/versions/{apiVersionId}/definition **Operation ID:** `patchOrganizationsByOrganizationidPublicApisByApiidVersionsByApiversionidDefinition` Patches a single element. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### DELETE /organizations/{organizationId}/public/apis/{apiId}/versions/{apiVersionId}/definition **Operation ID:** `deleteOrganizationsByOrganizationidPublicApisByApiidVersionsByApiversionidDefinition` Deletes the instance of the element specified. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### GET /organizations/{organizationId}/public/apis/{apiId}/versions/{apiVersionId}/files **Operation ID:** `getOrganizationsByOrganizationidPublicApisByApiidVersionsByApiversionidFiles` Redirect to the root RAML file. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### GET /organizations/{organizationId}/public/apis/{apiId}/versions/{apiVersionId}/files/root **Operation ID:** `getOrganizationsByOrganizationidPublicApisByApiidVersionsByApiversionidFilesRoot` Retrieve the root RAML file contents. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | ### GET /organizations/{organizationId}/public/apis/{apiId}/versions/{apiVersionId}/files/{+fileName} **Operation ID:** `getOrganizationsByOrganizationidPublicApisByApiidVersionsByApiversionidFilesByFilename` Retrieve the RAML contents by file name. **Parameters:** | `organizationId` | query | The organization ID to identify the target resource. | required | | `apiId` | query | The api ID to identify the target resource. | required | | `apiVersionId` | query | The apiVersion ID to identify the target resource. | required | | `+fileName` | query | The +fileName to identify the target resource. | required | ### GET /policies/{policyId} **Operation ID:** `getPoliciesByPolicyid` Retrieves a policies. **Parameters:** | `policyId` | query | The policy ID to identify the target resource. | required | ### GET /ch-domains/{domainName} **Operation ID:** `getChDomainsByDomainname` Retrieves a ch domains. **Parameters:** | `domainName` | query | The domainName to identify the target resource. | required | ### GET /gateway-versions **Operation ID:** `getGatewayVersions` Retrieves a list of gateway versions.