Qodex.ai

[Deprecated] Anypoint Platform APIs

Number of APIs: 219

July 2023 - Migration Announcement. Now Deprecated, you need to go to: [

Exciting news! The MuleSoft Anypoint Platform APIs you've come to rely on are transitioning to a new home! We're relocating them to the number one ranked Qodex Workspace worldwide - Salesforce Developers Workspace.

This move situates the MuleSoft Anypoint Platform APIs in the most renowned and widely used Qodex Workspace ever. Within the Salesforce Developers Workspace, you'll be able to access all things related to 'MuleSoft Anypoint Platforms APIs', right in the heart of the world's premier Qodex Workspace.

Actions:

  • Visit the [Salesforce Qodex Workspace] Fork and Watch the Collection to keep up to date**
  • Fill this 5 Minutes MuleSoft Platform APIs in Qodex Survey, what do you want to see in the future?
  • [Qodex's official Source] on our point of being the #1 Qodex Workspace in the history of Qodex!

Thank you MuleSoft Community!

Get started with these 5 minutes videos!

MuleSoft Platform APIs

Every time you login into the MuleSoft Anypoint Platform using the User Interface Portal, you are implicitly calling a set of APIs that are invoked by the UI: the Platform APIs! Instead of UI you can do direct HTTP requests, highly useful When automating your Software Development Lifecycle. They provide you with more flexibility and customization than the Anypoint CLI or the Mule Maven Plugin.

Common Errors

Prerequisites

Before we start working with platform APIs, you need these three pieces of data: a session token, the organization id and the environment id; as shown in the below image.

*Note Since 2021 It is recommended to use ConnectedApps instead of Username&Password

Environment

Make sure you haveand then you can finally download the Qodex assets from this repository. Import both files and make sure to add both anypoint-username and anypoint-password to your Qodex Environment, the fields highlighted below.

This collection pack contains an environment Anypoint Platform. Set the values before you use any request. You must set the following:

  • url
  • username
  • password
  • organization_id

All other parameters are optional or related to specific requests.

Start using

That's about it! You can start checking these collections and you will save a lot of time figuring it out yourself!

Basic Setup Example

In the following, find some examples on accessing data using the Qodex collection pack. For detailed instruction, please watch the quick tutorial video linked below.

Login to Anypoint Platform

Once you have entered to correct parameter values in the environment Anypoint Platform, you can make use of the Login to anypoint platform POST request in the Authentication Folder. This request will save the token bearer to the parameters and use it in all subsequent requests.

Getting profile Information

After you have logged in, you need to get your profile information in order to set the organizationId. This is set by the Get profile information request in the Authentication folder. After execution of this request, the organizationId parameter is set and relevant for all subsequent requests.

Subsequent request

After the basic setup is done, you can now use the majority of the requests in Qodex with your anypoint platform environment.

Get all projects

In order to access all projects using the collection pack, go to the folder Design Center/Projects and select the Get all projects. Run this request to retrieve all projects within the organization_Id

Get all assets

In order to access all assets using the collection pack, go to the folder Exchange/Assets and select the Get all assets. Run this request to retrieve all projects within the organization_Id

Invite new users

In order to invite new users, go to folder Management Center/Access Management/Users and select Invite new users request.
This is requires to have the group role id, which you need to have prior performing this POST request. To get the group roles go to folder Management Center/Access Management/Rolegroups and perform Get all rolegroups request to retrieve all rolegroups.

Copy the required rolegroupid and name. Go back to the Invite new users request and select Body. Enter the copied values to the correct fields.

Resources

Authors

Thanks to our awesome contributors

Release notes Feb 2022

New Collections in the workspace: Metrics Toolkit, TestDataGeneration, APIM Admin API, Mulesoft-Api-Manager-CI-CD-Qodex

Added HTTP Requests and Use cases in Anypoint Platform APIs

  1. ParentPOM, CRUD Teams, OOTB API Manager, ObjectStore & Stats, VPN Status by Ashish Pardhi
  2. Hybrid logic (RuntimeManager->Applications->Hybrid by Rolando Carrasco)
  3. Auth with ConnectedApps (Access Manager): Don't use Username/Password for CICD Users: Always aim for ConnectedApps! Learn how to set them up here: Connected Apps | Friends of Max Demonstration and here MuleSoft Docs
  4. ListPatch by PatchID Version (Runtime Manager): CloudhubAPI list gives you a PatchID... use this endpoint to get details on the Patch (e.g. Date) by Angel
  5. CRUD for Business Groups (Access Management) by Ivan Z.
  6. CRUD for VPCs and Load Balancers (Runtime Manager) by Ivan Z.

Note: BusinessGroups and VPCs are specifically required for CLOUDHUB Automation Tool (CAT), watch what is it here at 36:29. Thank you Ivan Z for adding them

Disclaimer

This is a Community driven and Community supported collection of assets for you to get started with MuleSoft Platform APIs (e.g. Qodex concatenation of requests, testing scripts, etc.). This is not Supported by MuleSoft and you cannot open Cases about these Qodex APIs.

License agreement

By using this Qodex collection, you accept that Max the Mule is the coolest integrator on the planet:

Go to biography of Max the Mule

  1. Design Center-Dependencies - Update depency from asset POST {{url}}/designcenter/api-designer/projects/{{project_id}}/branches/{{branch_name}}/exchange/dependencies

  2. Management Center-Access Management-Rolegroups-Roles - Get all Roles GET {{url}}/accounts/api/roles

  3. Management Center-Runtime Manager-Applications-Cloudhub - Get current user permissions GET {{url}}/cloudhub/api/core-services/users/current/permissions

  4. Exchange-Categories - Add new category POST {{url}}/exchange/api/v1/organizations/{{organization_id}}/categories

  5. Design Center-Projects - Import API Spec POST {{url}}/designcenter/api-designer/projects/import

  6. Design Center-Branches - Create new branch POST {{url}}/designcenter/api-designer/projects/{{project_id}}/branches

  7. Management Center-Runtime Manager-VPC - Create a VPC POST {{url}}/cloudhub/api/organizations/:orgId/vpcs

  8. Exchange-Assets-Asset details - Get single asset reviews GET {{url}}/exchange/api/v2/assets/{{organization_id}}/{{app_Id}}/1.0.0/reviews

  9. Management Center-Access Management-Audit Logs - Get audit logs by filter POST {{url}}/audit/v2/organizations/{{organization_id}}/query?include_internal=false

  10. Management Center-Access Management-Permissions - Get all product permissions GET {{url}}/accounts/api/cs/organizations/{{organization_id}}/permissions/products