openapi: 3.0.0 info: title: MuleSoft Anypoint Platform APIs description: >- # [Get started with these 5 minutes videos!](https://www.youtube.com/playlist?list=PLiONnRuKRuJBHJoqaN8qx-QKMhYjPf8_s) # MuleSoft Anypoint 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. - Official documentation of the Platform APIs in the [Platform API Portal](https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/) ## Common Errors - [Invalid CSRF Support Article](https://help.mulesoft.com/s/article/CSRF-Protection-execute-from-Postman) ## 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 havePostmaninstalled, that you do know how toimport the Postman Collection and the Environmentand then you can finally download the Postman assets from this repository. Import both files and make sure to add both anypoint-username and anypoint-password or ConnectedApps-ClientID/ClientSecret to your Postman 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 - \[Recommended: ConnectedApps (ClientID and ClientSecret)\] or \[For TESTING: exceptional account (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 postman 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 organization_Id. This is set by the "Get profile information" request in the Authentication folder. After execution of this request, the organization_Id 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 postman 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 role_group_id and name. Go back to the "Invite new users" request and select Body. Enter the copied values to the correct fields. ## Resources - Official documentation of the Platform APIs in the [Platform API Portal](https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/) - If you are new to the Platform APIs check this [post!](https://blogs.mulesoft.com/dev/howto/get-started-with-platform-apis-and-postman-automation/) ## Authors - [Amir Khan](https://www.linkedin.com/in/amir-khan-ak/) - [Angel Alberici](https://www.linkedin.com/in/angelalberici/) - [Ivan Z.](https://www.linkedin.com/in/ivan-z-apis/) ## Thanks to our awesome contributors - [Ashish Pardhi](https://www.linkedin.com/in/ashishpardhi/) - [Rolando Carrasco](https://www.linkedin.com/in/rolandocarrasco/) - [Amit Ghorpade](https://www.linkedin.com/in/amitghorpadein/) - Management Center -> API Manager -> API Administration -> Manage APIs -> Single API -> POST create an alerts for api ## Contributing to the project - Please read the tutorial in: [https://github.com/forcedotcom/postman-salesforce-apis/blob/master/contributing.md](https://github.com/forcedotcom/postman-salesforce-apis/blob/master/contributing.md) ## Release notes 31st Aug 2023 - Exchange can be access by the Exchange Platform API and by the Exchange GraphQL Platform API. Almost every use case is covered by Exchange Platform API this is in case you want to explore the Exchange GraphQL Platform API due to specific use cases or training - The Folder has been added in: MuleSoft Platform APIs -> Exchange -> GraphQL Exchange Search # Release notes 1st Aug 2023 - Migrated from "MuleSoft Platform APIs" Postman Workspace into "Salesforce Developers" Postman Workspace - Added Folders for Cloudhub 2.0 under Management Center -> Runtime Manager -> Private Spaces, Transit Gateways & Deployment Target - Added Environment Variables for Cloudhub 2.0 including the URL (transit_gateway_id, private_space_id, tls_context_id, target_id, connection_id, vpn_id) - Changed Authentication Mechanism at Root Level (MuleSoft Anypoint Platform APIs) from "None" to Bearer Token of value # Release notes Feb 2022 New Collections in the workspace: Metrics Toolkit, TestDataGeneration, APIM Admin API, Mulesoft-Api-Manager-CI-CD-Postman 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](https://www.youtube.com/watch?v=zoxZg0qvyz8) and here [MuleSoft Docs](https://docs.mulesoft.com/access-management/connected-apps-overview#:~:text=The%20Connected%20Apps%20feature%20provides,their%20accounts%20to%20third%20parties) 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](https://youtu.be/tqgoFmPgl7Y?t=2189). 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. Postman concatenation of requests, testing scripts, etc.). This is not Supported by MuleSoft and you cannot open Cases about these Postman APIs. ## License agreement By using this postman collection, you accept that Max the Mule is the coolest integrator on the planet: [Go to biography of Max the Mule](https://brand.salesforce.com/content/characters-overview__3?tab=BogXMx2m) version: 1.0.0 servers: - url: http://{{url}} - url: http://{{mavenurl}} - url: https://anypoint.mulesoft.com - url: http://{{osv2_url}} - url: http://{{osv2_stats_url}} - url: http://{{cloudhub2-url}} - url: http://{{baseurl}} - url: https://monitoring.anypoint.mulesoft.com components: securitySchemes: noauthAuth: type: http scheme: noauth bearerAuth: type: http scheme: bearer security: - bearerAuth: [] tags: - name: Authentication - name: Design Center - name: Design Center > Profile Information - name: Design Center > Projects - name: Design Center > Environments - name: Design Center > Publish Specification to Exchange - name: Design Center > Dependencies - name: Design Center > Branches - name: Design Center > File(s) & Folder(s) - name: Design Center > Delete - name: Exchange - name: Exchange > Assets - name: Exchange > Assets > Asset details - name: Exchange > Assets > Asset details > icon - name: Exchange > Assets > Asset details > version - name: Exchange > Assets > Asset details > version > versiongroup - name: Exchange > Assets > Asset details > version > versiongroup > Instances - name: Exchange > My Applications - name: Exchange > My Applications > contracts - name: Exchange > Tags - name: Exchange > Categories - name: Exchange > Custom Fields description: |- dataType available: "date", "enum", "number", "text", "number-list", "text-list", - name: Exchange > Identities - name: Exchange > Maven Assets - name: Exchange > GraphQL Exchange search (Readme inside) description: >- Whenever you work with GraphQL be sure to review these three sites: 1. [API Portal (this is the basic documentation of the Exchange GraphQL API)](https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/exchange-graph-http/minor/2.0/pages/Querying%20the%20graph/) 2. [MuleDocs (Exchange GraphQL version 1 and version 2 are VERY different, please be aware)](https://docs.mulesoft.com/exchange/to-search-with-graph-api#reference-query-filter-parameters) 3. [Runnable GraphQL site with an example preloaded](https://anypoint.mulesoft.com/graph/api/v2/graphql) - name: Exchange > GraphQL Exchange search (Readme inside) > v1 (/v1 in the URL) - name: Exchange > GraphQL Exchange search (Readme inside) > v2 (/v2 in the URL) - name: Management Center - name: Management Center > Access Management - name: Management Center > Access Management > Environments - name: Management Center > Access Management > Business Groups (Organizations) - name: >- Management Center > Access Management > Business Groups (Organizations) > Members - name: >- Management Center > Access Management > Business Groups (Organizations) > Hierarchy - name: Management Center > Access Management > Users - name: Management Center > Access Management > Rolegroups - name: Management Center > Access Management > Rolegroups > Roles - name: Management Center > Access Management > Rolegroups > User Assignment - name: Management Center > Access Management > Permissions - name: Management Center > Access Management > Identity Provider - name: Management Center > Access Management > Audit Logs - name: Management Center > Access Management > Connected Apps - name: Management Center > Access Management > Connected Apps > Owned Apps - name: Management Center > Access Management > Connected Apps > Authorizations - name: Management Center > Access Management > External Access - name: Management Center > Access Management > Team - name: Management Center > API Manager - name: Management Center > API Manager > API Administration - name: Management Center > API Manager > API Administration > Manage APIs - name: >- Management Center > API Manager > API Administration > Manage APIs > Single API - name: Management Center > API Manager > API Groups - name: Management Center > API Manager > Client Applications - name: Management Center > API Manager > Custom Policies - name: Management Center > API Manager > OOTB Policy - name: Management Center > Runtime Manager - name: Management Center > Runtime Manager > Applications - name: Management Center > Runtime Manager > Applications > Notification - name: Management Center > Runtime Manager > Applications > Cloudhub - name: Management Center > Runtime Manager > Applications > Deploy Application - name: Management Center > Runtime Manager > Applications > Hybrid - name: Management Center > Runtime Manager > Servers - name: Management Center > Runtime Manager > Servers > Servergroups - name: Management Center > Runtime Manager > Servers > Clusters - name: Management Center > Runtime Manager > Alerts - name: Management Center > Runtime Manager > VPC - name: Management Center > Runtime Manager > VPN - name: Management Center > Runtime Manager > Load Balancers - name: Management Center > Runtime Manager > Object Store v2 - name: Management Center > Runtime Manager > Private Spaces (Cloudhub 2.0) - name: >- Management Center > Runtime Manager > Private Spaces (Cloudhub 2.0) > Transit Gateways within Private Spaces - name: >- Management Center > Runtime Manager > Private Spaces (Cloudhub 2.0) > TLS Contexts - name: >- Management Center > Runtime Manager > Private Spaces (Cloudhub 2.0) > Connections - name: Management Center > Runtime Manager > Transit Gateways (Cloudhub 2.0) - name: >- Management Center > Runtime Manager > Deployment Target (Cloudhub 2.0 : Not in use) - name: Management Center > Visualizer - name: Management Center > Secret Manager - name: Management Center > Secret Manager > Keystores - name: Management Center > Secret Manager > Truststore - name: Management Center > Secret Manager > Certificates - name: Management Center > Secret Manager > Certificate Pinset - name: Management Center > Secret Manager > Shared Secret - name: Management Center > Secret Manager > CRL Distributor Config - name: Management Center > Secret Manager > TSL Context - name: Management Center > Automated Policies - name: Management Center > Anypoint Monitoring - name: Management Center > Anypoint Monitoring > Metric data for APIs description: >- This API lists and retrieves Anypoint Monitoring archived API metrics and logs. Archived data is organized by organizations and environments. Within organization and environments, archived data is further divided by runtime entities that generated the data as well as creation data of the data files. A caller with proper permission must authenticate in order to access this API. See [Anypoint Monitoring Archive API](https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/anypoint-monitoring-archive-api/) for more information on caller authentication and permissions. See [Authentication Service API](https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/access-management-api/minor/1.0/pages/Authentication/) for details on obtaining a bearer token for accessing this API. - name: >- Management Center > Anypoint Monitoring > Metric data for APIs > {organization}/environments - name: >- Management Center > Anypoint Monitoring > Metric data for APIs > {organization}/environments > {environment} - name: >- Management Center > Anypoint Monitoring > Metric data for APIs > {organization}/environments > {environment} > {entity Type} - name: >- Management Center > Anypoint Monitoring > Metric data for APIs > {organization}/environments > {environment} > {entity Type} > {entity ID} - name: >- Management Center > Anypoint Monitoring > Metric data for APIs > {organization}/environments > {environment} > {entity Type} > {entity ID} > {file Type} - name: >- Management Center > Anypoint Monitoring > Metric data for APIs > {organization}/environments > {environment} > {entity Type} > {entity ID} > {file Type} > {year} - name: >- Management Center > Anypoint Monitoring > Metric data for APIs > {organization}/environments > {environment} > {entity Type} > {entity ID} > {file Type} > {year} > {month} - name: >- Management Center > Anypoint Monitoring > Metric data for APIs > {organization}/environments > {environment} > {entity Type} > {entity ID} > {file Type} > {year} > {month} > {day Of Month} paths: /accounts/api/v2/oauth2/token: post: tags: - Authentication summary: Login Anypoint Platform with ConnectedApps requestBody: content: application/json: schema: type: object example: client_id: '{{user_client_id}}' client_secret: '{{user_client_secret}}' grant_type: client_credentials security: - noauthAuth: [] responses: '200': description: Successful response content: application/json: {} /accounts/login/{org-domain}/providers/{providerId}/receive-id: post: tags: - Authentication summary: Login Anypoint Platform with SAML requestBody: content: '*/*': schema: type: string example: >- "{\n \"SAMLResponse\": \"\"\n}" parameters: - name: Content-Type in: header schema: type: string example: application/json - name: X-Requested-With in: header schema: type: string example: XMLHttpRequest - name: org-domain in: path schema: type: string required: true - name: providerId in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /accounts/login: post: tags: - Authentication summary: >- Login Anypoint Platform with Username/Password (Deprecated: works by Exempt users only) requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: username: type: string example: '{{username}}' password: type: string example: '{{password}}' security: - noauthAuth: [] responses: '200': description: Successful response content: application/json: {} /accounts/api/profile: get: tags: - Authentication summary: Get profile information parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} responses: '200': description: Successful response content: application/json: {} /accounts/api/me: get: tags: - Authentication summary: Get my profile information parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} responses: '200': description: Successful response content: application/json: {} /accounts/api/logout: get: tags: - Authentication summary: Logout parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} responses: '200': description: Successful response content: application/json: {} /designcenter/api/v1/auth/profile: get: tags: - Design Center > Profile Information summary: Get design center profile parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} responses: '200': description: Successful response content: application/json: {} /designcenter/api/v1/organizations/{organization_id}/projects: get: tags: - Design Center > Projects summary: Get all projects parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: pageSize in: query schema: type: integer example: '50' - name: pageIndex in: query schema: type: integer example: '0' - name: orderBy in: query schema: type: string example: '-updateDate' - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /designcenter/api-designer/projects: post: tags: - Design Center > Projects summary: Create Fragment requestBody: content: application/json: schema: type: object example: name: '{{fragment_name}}' classifier: raml-fragment subType: '{{fragment_subType}}' parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: x-organization-id in: header schema: type: string example: '{{x-organization-id}}' - name: x-owner-id in: header schema: type: string example: '{{x-owner-id}}' responses: '200': description: Successful response content: application/json: {} /designcenter/api-designer/projects/{project_id}/api/name: get: tags: - Design Center > Projects summary: Get project data parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: x-organization-id in: header schema: type: string example: '{{x-organization-id}}' - name: x-owner-id in: header schema: type: string example: '{{x-owner-id}}' - name: project_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /designcenter/api-designer/projects/{project_id}: get: tags: - Design Center > Projects summary: Get API data parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: x-organization-id in: header schema: type: string example: '{{x-organization-id}}' - name: x-owner-id in: header schema: type: string example: '{{x-owner-id}}' - name: project_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} delete: tags: - Design Center > Delete summary: Delete a project parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: x-organization-id in: header schema: type: string example: '{{x-organization-id}}' - name: x-owner-id in: header schema: type: string example: '{{x-owner-id}}' - name: project_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /designcenter/api-designer/projects/import: post: tags: - Design Center > Projects summary: Import API Spec requestBody: content: multipart/form-data: schema: type: object properties: fileName: type: string format: binary Content-Type: type: string example: multipart/form-data name: type: string example: FINS Salesforce Insurance Exp API mainFile: type: string example: fins-salesforce-insurance-exp-api-spec.raml format: type: string example: yaml classifier: type: string example: raml version: type: number example: '1.0' parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: x-organization-id in: header schema: type: string example: '{{x-organization-id}}' - name: x-owner-id in: header schema: type: string example: '{{x-owner-id}}' responses: '200': description: Successful response content: application/json: {} /designcenter/api/v1/organizations/{organization_id}/environments: get: tags: - Design Center > Environments summary: Get all environments parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /projects/{project_id}/branches/{branch}/publish/exchange: post: tags: - Design Center > Publish Specification to Exchange summary: Publish Project to Exchange description: Publish project to Exchange. As a result, an Exchange asset is created. requestBody: content: '*/*': schema: type: string example: >- "{\n \"main\": \"api.raml\",\n \"apiVersion\": \"1.0.0\",\n \"version\": \"1.0.0\",\n \"assetId\": \"publish-project-doc\",\n \"groupId\": \"gid1234\",\n \"classifier\": \"oas\"\n}" parameters: - name: x-owner-id in: header schema: type: string description: > (Required) User's ownerId, which identifies the user performing the operation. This is NOT the username, but an UUID that can be found in the users page by the organization administrator. example: '{{owner_id}}' - name: X-ANYPNT-ORG-ID in: header schema: type: string description: > (Required) OrganizationId, which identifies the organization to which perform the operation. This can be found in the organizations page by the organization administrator. example: '{{organization_id}}' - name: Content-Type in: header schema: type: string example: application/json - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: project_id in: path schema: type: string required: true - name: branch in: path schema: type: string required: true responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: assetId: test-publish-doc groupId: 6a2f41a3-c54c-fce8-32d2-0324e1c32e22 organizationId: 6a2f41a3-c54c-fce8-32d2-0324e1c32e22 version: 1.0.0 '401': description: Unauthorized headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /designcenter/api-designer/projects/{project_id}/branches/{branch_name}/exchange/dependencies: post: tags: - Design Center > Dependencies summary: Update depency from asset requestBody: content: application/json: schema: type: object example: add: - groupId: bc6c7bb9-87c7-4220-833b-40509c780dd4 assetId: baking-common version: 1.0.1 remove: - groupId: bc6c7bb9-87c7-4220-833b-40509c780dd4 assetId: baking-common version: 1.0.0 parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment-id}}' - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{org-id}}' - name: Content-Type in: header schema: type: string example: application/json - name: X-OWNER-ID in: header schema: type: string example: '{{owner_id}}' - name: project_id in: path schema: type: string required: true - name: branch_name in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} delete: tags: - Design Center > Dependencies summary: Delete dependency to asset Copy parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment-id}}' - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{org-id}}' - name: Content-Type in: header schema: type: string example: application/json - name: X-OWNER-ID in: header schema: type: string example: '{{owner_id}}' - name: project_id in: path schema: type: string required: true - name: branch_name in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /designcenter/api-designer/projects/{project_id}/branches/{branch}/acquireLock: post: tags: - Design Center > Branches summary: Acquire the Write Lock requestBody: content: application/json: schema: type: object example: {} parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: x-organization-id in: header schema: type: string example: '{{x-organization-id}}' - name: x-owner-id in: header schema: type: string example: '{{x-owner-id}}' - name: project_id in: path schema: type: string required: true - name: branch in: path schema: type: string required: true responses: '200': description: OK content: application/json: schema: type: object example: locked: true name: nitishrajmay2022 /designcenter/api-designer/projects/{project_id}/branches/{branch}/releaseLock: post: tags: - Design Center > Branches summary: Release the Write Lock requestBody: content: application/json: schema: type: object example: {} parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: x-organization-id in: header schema: type: string example: '{{x-organization-id}}' - name: x-owner-id in: header schema: type: string example: '{{x-owner-id}}' - name: project_id in: path schema: type: string required: true - name: branch in: path schema: type: string required: true responses: '200': description: OK content: application/json: schema: type: object example: locked: true name: nitishrajmay2022 /designcenter/api-designer/projects/{project_id}/branches: post: tags: - Design Center > Branches summary: Create new branch requestBody: content: application/json: schema: type: object example: name: dev commitId: '454545' parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: x-organization-id in: header schema: type: string example: '{{x-organization-id}}' - name: x-owner-id in: header schema: type: string example: '{{x-owner-id}}' - name: project_id in: path schema: type: string required: true responses: '200': description: OK content: application/json: schema: type: object example: locked: true name: nitishrajmay2022 get: tags: - Design Center > Branches summary: List branches parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: x-organization-id in: header schema: type: string example: '{{x-organization-id}}' - name: x-owner-id in: header schema: type: string example: '{{x-owner-id}}' - name: project_id in: path schema: type: string required: true responses: '200': description: OK content: application/json: schema: type: object example: locked: true name: nitishrajmay2022 /designcenter/api-designer/projects/{project_id}/branches/{branch}: delete: tags: - Design Center > Branches summary: Delete branch parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: x-organization-id in: header schema: type: string example: '{{x-organization-id}}' - name: x-owner-id in: header schema: type: string example: '{{x-owner-id}}' - name: project_id in: path schema: type: string required: true - name: branch in: path schema: type: string required: true responses: '200': description: OK content: application/json: schema: type: object example: locked: true name: nitishrajmay2022 /designcenter/api-designer/projects/{project_id}/branches/{branch}/open: post: tags: - Design Center > Branches summary: List project files requestBody: content: {} parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: x-organization-id in: header schema: type: string example: '{{x-organization-id}}' - name: x-owner-id in: header schema: type: string example: '{{x-owner-id}}' - name: project_id in: path schema: type: string required: true - name: branch in: path schema: type: string required: true responses: '200': description: OK content: application/json: schema: type: object example: locked: true name: nitishrajmay2022 /designcenter/api-designer/projects/{project_id}/branches/{branch}/clean: post: tags: - Design Center > Branches summary: Clean branch requestBody: content: application/json: schema: type: object example: {} parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: x-organization-id in: header schema: type: string example: '{{x-organization-id}}' - name: x-owner-id in: header schema: type: string example: '{{x-owner-id}}' - name: project_id in: path schema: type: string required: true - name: branch in: path schema: type: string required: true responses: '200': description: OK content: application/json: schema: type: object example: locked: true name: nitishrajmay2022 /designcenter/api-designer/projects/{project_id}/branches/{branch}/status: post: tags: - Design Center > Branches summary: Check Write Lock Status requestBody: content: application/json: schema: type: object example: {} parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: x-organization-id in: header schema: type: string example: '{{x-organization-id}}' - name: x-owner-id in: header schema: type: string example: '{{x-owner-id}}' - name: project_id in: path schema: type: string required: true - name: branch in: path schema: type: string required: true responses: '200': description: OK content: application/json: schema: type: object example: lock: locked: false lockedBy: null lockedByMe: false project: commitsAhead: 0 commitsBehind: 0 added: [] conflicts: [] deleted: [] modified: [] /designcenter/api-designer/projects/{project_id}/branches/{branch}/save: post: tags: - Design Center > File(s) & Folder(s) summary: Create a Examples Folder with files requestBody: content: application/json: schema: type: object example: - path: examples/bus.raml type: FILE content: |- #%RAML 1.0 Example type: object properties: brand: string model: string color: string year?: string title: Car Datatype parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: x-organization-id in: header schema: type: string example: '{{x-organization-id}}' - name: x-owner-id in: header schema: type: string example: '{{x-owner-id}}' - name: project_id in: path schema: type: string required: true - name: branch in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /designcenter/api-designer/projects/{project_id}/branches/{branch}/save/v2: post: tags: - Design Center > File(s) & Folder(s) summary: Add file(s) or folder(s) to upload requestBody: content: multipart/form-data: schema: type: object properties: '{{project_main}}': type: string format: binary dataTypes/ExternalIdType.raml: type: string format: binary dataTypes/ValidationResponseType.raml: type: string format: binary examples/ExternalIdExample.raml: type: string format: binary examples/ValidationResponseExample.raml: type: string format: binary accelerator-salesforce-customers-system-api.json: type: string format: binary parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: x-organization-id in: header schema: type: string example: '{{x-organization-id}}' - name: x-owner-id in: header schema: type: string example: '{{x-owner-id}}' - name: project_id in: path schema: type: string required: true - name: branch in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /designcenter/api-designer/projects/{project_id}/branches/{branch}/files: get: tags: - Design Center > File(s) & Folder(s) summary: Get file or folder structure parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: x-organization-id in: header schema: type: string example: '{{x-organization-id}}' - name: x-owner-id in: header schema: type: string example: '{{x-owner-id}}' - name: project_id in: path schema: type: string required: true - name: branch in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /designcenter/api-designer/projects/{project_id}/branches/{branch}/files/v2/{project_main}: get: tags: - Design Center > File(s) & Folder(s) summary: Get file content parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: x-organization-id in: header schema: type: string example: '{{x-organization-id}}' - name: x-owner-id in: header schema: type: string example: '{{x-owner-id}}' - name: project_id in: path schema: type: string required: true - name: branch in: path schema: type: string required: true - name: project_main in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /designcenter/api-designer/projects/{project_id}/branches/{branch}/files/{project_main}: get: tags: - Design Center > File(s) & Folder(s) summary: Get file content (JSON response) parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: x-organization-id in: header schema: type: string example: '{{x-organization-id}}' - name: x-owner-id in: header schema: type: string example: '{{x-owner-id}}' - name: project_id in: path schema: type: string required: true - name: branch in: path schema: type: string required: true - name: project_main in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} delete: tags: - Design Center > Delete summary: Delete file or folder parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: x-organization-id in: header schema: type: string example: '{{x-organization-id}}' - name: x-owner-id in: header schema: type: string example: '{{x-owner-id}}' - name: project_id in: path schema: type: string required: true - name: branch in: path schema: type: string required: true - name: project_main in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /designcenter/api-designer/projects/{project_id}/branches/{branch}/files/example/Car.raml/move: post: tags: - Design Center > File(s) & Folder(s) summary: Move or Rename file or folder requestBody: content: application/json: schema: type: object example: path: examples/Car.raml parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: x-organization-id in: header schema: type: string example: '{{x-organization-id}}' - name: x-owner-id in: header schema: type: string example: '{{x-owner-id}}' - name: project_id in: path schema: type: string required: true - name: branch in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /exchange/api/v2/assets/{x-organization-id}/{exchange_assetId}/{exchange_assetVersion}: delete: tags: - Design Center > Delete summary: Hard delete an asset in Exchange parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: x-delete-type in: header schema: type: string example: hard-delete - name: x-organization-id in: path schema: type: string required: true - name: exchange_assetId in: path schema: type: string required: true - name: exchange_assetVersion in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /exchange/api/v2/assets/{organization_id}/{app_Id}/icon: delete: tags: - Exchange > Assets > Asset details > icon summary: Delete an Icon parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true - name: app_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /exchange/api/v2/assets/{organization_id}/{app_Id}/versionGroups/v1/instances: get: tags: - Exchange > Assets > Asset details > version > versiongroup > Instances summary: Get asset version groups Instances (v1 example) parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true - name: app_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /exchange/api/v2/assets/{organization_id}/{app_Id}/versionGroups/v1/instances/external/{external_instance_id}: patch: tags: - Exchange > Assets > Asset details > version > versiongroup > Instances summary: Get asset version groups Instances by Id requestBody: content: application/json: schema: type: object example: name: test42 endpointUri: http://google.de isPublic: false parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true - name: app_Id in: path schema: type: string required: true - name: external_instance_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /exchange/api/v2/assets/{organization_id}/{app_Id}/versionGroups/v1/instances/external: post: tags: - Exchange > Assets > Asset details > version > versiongroup > Instances summary: Create external instance requestBody: content: application/json: schema: type: object example: name: test2 endpointUri: http://google.de isPublic: false parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true - name: app_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /exchange/api/v2/assets/{organization_id}/{app_Id}/versionGroups: get: tags: - Exchange > Assets > Asset details > version > versiongroup summary: Get asset version groups parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true - name: app_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /exchange/api/v2/assets/{organization_id}/{app_Id}/minorVersions/1.0: get: tags: - Exchange > Assets > Asset details > version summary: Get asset version parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true - name: app_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /exchange/api/v2/assets/{organization_id}/{app_Id}/1.0.1/status: put: tags: - Exchange > Assets > Asset details > version summary: Revert deprecated state of asset version requestBody: content: application/json: schema: type: object example: status: published parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true - name: app_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /exchange/api/v2/assets/{organization_id}/{app_Id}: get: tags: - Exchange > Assets > Asset details summary: Get single asset parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true - name: app_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} patch: tags: - Exchange > Assets > Asset details summary: Change description of asset requestBody: content: application/json: schema: type: object example: description: >- Existing SOAP service and proxied with REST API app/json and integrated with Salesforce and ServiceNow...... and other apps parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true - name: app_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /exchange/api/v2/assets/{organization_id}/{app_Id}/1.0.0/reviews: get: tags: - Exchange > Assets > Asset details summary: Get single asset reviews parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true - name: app_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /exchange/api/v2/assets/{organization_id}/{app_Id}/identities: put: tags: - Exchange > Assets > Asset details summary: Share asset requestBody: content: application/json: schema: type: object example: added: - identityId: af696110-60f8-4a47-9367-e2464a468949 role: viewer identityType: organization organizationId: '{{organization_id}}' deleted: [] parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true - name: app_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} get: tags: - Exchange > Identities summary: Get asset identities parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true - name: app_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /exchange/api/v2/assets: post: tags: - Exchange > Assets > Asset details summary: Publish new Asset with metadata requestBody: content: multipart/form-data: schema: type: object properties: type: type: string example: '"custom"' name: type: string example: '"Custom asset with mutable data"' categories.test-coverage: type: string example: '"90"' tags: type: string example: '"tag1, tag2"' fields.maintainers: type: string example: '"Mulesoft, Exchange"' fields.github-repo: type: string example: '"https://github.com/mulesoft/exchange"' fields.releaseDate: type: string example: '"2020-01-01T20:00:00.000Z"' fields.buildVersion: type: string example: '"v1.0.949"' files.docs.zip: type: string example: '@"/Users/userName/Desktop/pages.zip"' parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} responses: '200': description: Successful response content: application/json: {} get: tags: - Exchange > Assets summary: Get all assets for organization shared with me parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: search in: query schema: type: string - name: types in: query schema: type: string example: api-group - name: domain in: query schema: type: string - name: organizationId in: query schema: type: string example: '{{mulesoft_org_id}}' - name: masterOrganizationId in: query schema: type: string - name: offset in: query schema: type: integer example: '0' - name: limit in: query schema: type: integer example: '20' - name: sharedWithMe in: query schema: type: boolean example: 'true' - name: includeSnapshots in: query schema: type: boolean example: 'true' responses: '200': description: Successful response content: application/json: {} /exchange/api/v1/assets: post: tags: - Exchange > Assets > Asset details summary: Publish new asset on exchange requestBody: content: multipart/form-data: schema: type: object properties: organizationId: type: string example: '{{organization_id}}' groupId: type: string example: '{{organization_id}}' assetId: type: string example: mysoapapp version: type: string example: 1.0.0 name: type: string example: my soap app classifier: type: string example: wsdl apiVersion: type: string example: v1 asset: type: string format: binary parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} responses: '200': description: Successful response content: application/json: {} get: tags: - Exchange > Assets summary: Search assets by text description: >- Generated from a curl request: curl -X POST -H "Authorization: Bearer {{token}}" -H "Content-Type: application/json" -d '{ "displayName": “Custom_Field_Test”, "tagKey": “Tag_Key_Test”, "dataType": "text", "assetTypeRestrictions": \[\] } ' "[https://anypoint.mulesoft.com/exchange/api/v1/organizations/59995d29-ebe2-43d9-a52b-766683fd41a7/fields\\"](https://anypoint.mulesoft.com/exchange/api/v1/organizations/59995d29-ebe2-43d9-a52b-766683fd41a7/fields) parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: Content-Type in: header schema: type: string example: application/json - name: search in: query schema: type: string example: '{{search_text}}' responses: '200': description: Successful response content: application/json: {} /apiplatform/repository/v2/organizations/{organization_id}/applications/895843/contracts: get: tags: - Exchange > My Applications > contracts summary: Get all contracts for consumer app parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: Content-Type in: header schema: type: string example: application/json - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /exchange/api/v2/organizations/{organization_id}/applications/895843/instances/16802222/contracts: get: tags: - Exchange > My Applications > contracts summary: Get all contracts for instances parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: Content-Type in: header schema: type: string example: application/json - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /exchange/api/v1/organizations/{organization_id}/applications/895850: delete: tags: - Exchange > My Applications summary: Delete consumer app description: >- Generated from a curl request: curl -X POST -H "Authorization: Bearer {{token}}" -H "Content-Type: application/json" -d '{ "displayName": “Custom_Field_Test”, "tagKey": “Tag_Key_Test”, "dataType": "text", "assetTypeRestrictions": \[\] } ' "[https://anypoint.mulesoft.com/exchange/api/v1/organizations/59995d29-ebe2-43d9-a52b-766683fd41a7/fields\\"](https://anypoint.mulesoft.com/exchange/api/v1/organizations/59995d29-ebe2-43d9-a52b-766683fd41a7/fields) parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: Content-Type in: header schema: type: string example: application/json - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /exchange/api/v2/organizations/{organization_id}/applications/895843/instances: get: tags: - Exchange > My Applications summary: Get all consumer application instances description: >- Generated from a curl request: curl -X POST -H "Authorization: Bearer {{token}}" -H "Content-Type: application/json" -d '{ "displayName": “Custom_Field_Test”, "tagKey": “Tag_Key_Test”, "dataType": "text", "assetTypeRestrictions": \[\] } ' "[https://anypoint.mulesoft.com/exchange/api/v1/organizations/59995d29-ebe2-43d9-a52b-766683fd41a7/fields\\"](https://anypoint.mulesoft.com/exchange/api/v1/organizations/59995d29-ebe2-43d9-a52b-766683fd41a7/fields\") parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: Content-Type in: header schema: type: string example: application/json - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /exchange/api/v1/organizations/{organization_id}/applications/895851/secret/reset: post: tags: - Exchange > My Applications summary: Reset client secret for consumer app requestBody: content: {} parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: Content-Type in: header schema: type: string example: application/json - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /exchange/api/v1/organizations/{organization_id}/applications/895851: patch: tags: - Exchange > My Applications summary: Edit consumer app information requestBody: content: '*/*': schema: type: string example: >- "{\r\n \"name\":\"myapp2\",\r\n \"description\":\"abcdefghijklmnopqrstuvwxyz\",\r\n \"url\":\"http://google.cd\",\r\n \"redirectUri\":[],\r\n \"grantTypes\":[],\r\n \"apiEndpoints\":false\r\n}" parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: Content-Type in: header schema: type: string example: application/json - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /exchange/api/v1/organizations/{organization_id}/assets/{organization_id}/{app_Id}/1.0.1/tags: put: tags: - Exchange > Tags summary: Add tags to single asset requestBody: content: application/json: schema: type: object example: - value: postmancollection - value: anypointplatformapis parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true - name: organization_id in: path schema: type: string required: true - name: app_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /exchange/api/v1/organizations/{organization_id}/categories: get: tags: - Exchange > Categories summary: Get all categories description: >- Generated from a curl request: curl -X POST -H "Authorization: Bearer {{token}}" -H "Content-Type: application/json" -d '{ "displayName": “Custom_Field_Test”, "tagKey": “Tag_Key_Test”, "dataType": "text", "assetTypeRestrictions": \[\] } ' "[https://anypoint.mulesoft.com/exchange/api/v1/organizations/59995d29-ebe2-43d9-a52b-766683fd41a7/fields\\"](https://anypoint.mulesoft.com/exchange/api/v1/organizations/59995d29-ebe2-43d9-a52b-766683fd41a7/fields\") parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: Content-Type in: header schema: type: string example: application/json - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} post: tags: - Exchange > Categories summary: Add new category description: >- Generated from a curl request: curl -X POST -H "Authorization: Bearer {{token}}" -H "Content-Type: application/json" -d '{ "displayName": “Custom_Field_Test”, "tagKey": “Tag_Key_Test”, "dataType": "text", "assetTypeRestrictions": \[\] } ' "[https://anypoint.mulesoft.com/exchange/api/v1/organizations/59995d29-ebe2-43d9-a52b-766683fd41a7/fields\\"](https://anypoint.mulesoft.com/exchange/api/v1/organizations/59995d29-ebe2-43d9-a52b-766683fd41a7/fields\") requestBody: content: '*/*': schema: type: string example: >- "{\r\n \"displayName\":\"test3\",\r\n \"acceptedValues\":[\r\n \"test\",\r\n \"test2\"\r\n ],\r\n \"assetTypeRestrictions\":[\r\n \"connector\",\r\n \"extension\"\r\n ]\r\n}" parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: Content-Type in: header schema: type: string example: application/json - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /exchange/api/v1/organizations/{organization_id}/categories/test3: delete: tags: - Exchange > Categories summary: Delete category by tagKey description: >- Generated from a curl request: curl -X POST -H "Authorization: Bearer {{token}}" -H "Content-Type: application/json" -d '{ "displayName": “Custom_Field_Test”, "tagKey": “Tag_Key_Test”, "dataType": "text", "assetTypeRestrictions": \[\] } ' "[https://anypoint.mulesoft.com/exchange/api/v1/organizations/59995d29-ebe2-43d9-a52b-766683fd41a7/fields\\"](https://anypoint.mulesoft.com/exchange/api/v1/organizations/59995d29-ebe2-43d9-a52b-766683fd41a7/fields\") parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: Content-Type in: header schema: type: string example: application/json - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /exchange/api/v2/organizations/{organization_id}/fields: get: tags: - Exchange > Custom Fields summary: Get all custom fields of organization parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} post: tags: - Exchange > Custom Fields summary: Create a custom field requestBody: content: application/json: schema: type: object example: dataType: number displayName: UX Factor tagKey: uxFactor parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /exchange/api/v1/organizations/{organization_id}/assets/{organization_id}/{app_Id}/1.0.1/tags/fields/subType: put: tags: - Exchange > Custom Fields summary: Add custom field to asset requestBody: content: application/json: schema: type: object example: tagValue: - OAS parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true - name: organization_id in: path schema: type: string required: true - name: app_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} delete: tags: - Exchange > Custom Fields summary: Remove custom field from asset parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true - name: organization_id in: path schema: type: string required: true - name: app_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /exchange/api/v1/organizations/{organization_id}/assets/{organization_id}/{app_Id}/1.0.1/tags/fields/uxFactor: put: tags: - Exchange > Custom Fields summary: Add custom field to asset requestBody: content: application/json: schema: type: object example: tagValue: 4 parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true - name: organization_id in: path schema: type: string required: true - name: app_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} delete: tags: - Exchange > Custom Fields summary: Remove custom field from asset parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true - name: organization_id in: path schema: type: string required: true - name: app_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /exchange/api/v1/organizations/{organization_id}/fields/uxFactor: delete: tags: - Exchange > Custom Fields summary: Delete custom field parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /exchange/api/v2/organizations/{organization_id}/identities: get: tags: - Exchange > Identities summary: Get all identities of organization parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: offset in: query schema: type: integer example: '0' - name: limit in: query schema: type: integer example: '100' - name: search in: query schema: type: string example: a - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /api/v2/organizations/{organization_id}/maven/{groupId}/{artifactId}/{version}/{artifactId}-{version}.pom: get: tags: - Exchange > Maven Assets summary: Get Parent POM security: - bearerAuth: [] parameters: - name: organization_id in: path schema: type: string required: true - name: groupId in: path schema: type: string required: true - name: artifactId in: path schema: type: string required: true - name: version in: path schema: type: string required: true - name: artifactId in: path schema: type: string required: true - name: version in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /graph/api/v1/graphql: post: tags: - >- Exchange > GraphQL Exchange search (Readme inside) > v1 (/v1 in the URL) summary: by Group/Asset/Verion return all fields (GraphQL Body) requestBody: content: {} security: - noauthAuth: [] parameters: - name: content-type in: header schema: type: string example: application/json - name: Authorization in: header schema: type: string example: Bearer {{token}} responses: '200': description: Successful response content: application/json: {} /graph/api/v2/graphql: post: tags: - Exchange > GraphQL Exchange search (Readme inside) summary: README (read the BODY) description: >- Whenever you work with GraphQL be sure to review these three sites: 1. API Portal (this is the basic documentation of the Exchange GraphQL API): [https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/exchange-graph-http/minor/2.0/pages/Querying%20the%20graph/](https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/exchange-graph-http/minor/2.0/pages/Querying%20the%20graph/) 2. MuleDocs (Exchange GraphQL version 1 and version 2 are VERY different, please be aware) [https://docs.mulesoft.com/exchange/to-search-with-graph-api#reference-query-filter-parameters](https://docs.mulesoft.com/exchange/to-search-with-graph-api#reference-query-filter-parameters) 3. Runnable GraphQL site with an example preloaded (Postman collections in this folder will help you building and testing very similar to the playground): requestBody: content: text/plain: schema: type: string example: >- Whenever you work with GraphQL be sure to review these three sites: 1. API Portal (this is the basic documentation of the Exchange GraphQL API): https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/exchange-graph-http/minor/2.0/pages/Querying%20the%20graph/ 2. MuleDocs (Exchange GraphQL version 1 and version 2 are VERY different, please be aware) https://docs.mulesoft.com/exchange/to-search-with-graph-api#reference-query-filter-parameters 3. Runnable GraphQL site with an example preloaded (Postman collections in this folder will help you building and testing very similar to the playground): https://anypoint.mulesoft.com/graph/api/v2/graphql?query=%23%0A%23+Welcome+to+Exchange+GraphQL%0A%23%0A%23+Exchange+GraphQL+is+an+in-browser+tool+for+writing%2C+validating%2C+and%0A%23+testing+GraphQL+queries.%0A%23%0A%23+Type+queries+into+this+side+of+the+screen%2C+and+you+will+see+intelligent%0A%23+typeaheads+aware+of+the+current+GraphQL+type+schema+and+live+syntax+and%0A%23+validation+errors+highlighted+within+the+text.%0A%23%0A%23+GraphQL+queries+typically+start+with+a+%22%7B%22+character.+Lines+that+start%0A%23+with+a+%23+are+ignored.%0A%23%0A%23+An+example+GraphQL+query+might+look+like%3A%0A%23%0A%23+++++%7B%0A%23+++++++field%28arg%3A+%22value%22%29+%7B%0A%23+++++++++subField%0A%23+++++++%7D%0A%23+++++%7D%0A%23%0A%23+Keyboard+shortcuts%3A%0A%23%0A%23++Prettify+Query%3A++Shift-Ctrl-P+%28or+press+the+prettify+button+above%29%0A%23%0A%23+++++Merge+Query%3A++Shift-Ctrl-M+%28or+press+the+merge+button+above%29%0A%23%0A%23+++++++Run+Query%3A++Ctrl-Enter+%28or+press+the+play+button+above%29%0A%23%0A%23+++Auto+Complete%3A++Ctrl-Space+%28or+just+start+typing%29%0A%23%0A%0A%7B%0A++assets%28%0A++++searchTerm%3A+%22123%22%0A++%29+%7B%0A++++organizationId%0A++++groupId%0A++++assetId%0A++++version%0A++++minorVersion%0A++++versionGroup%0A++++description%0A++++name%0A++++contactName%0A++++contactEmail%0A++++type%0A++++icon%0A++++status%0A++++isPublic%0A++++isLatestVersion%0A++++createdDate%0A++++updatedDate%0A++++originalFormat%0A++++originalFormatVersion%0A++++minMuleVersion%0A++++isGenerated%0A++++isMozartTemplate%0A++++isSnapshot%0A++++rating%0A++++numberOfRates%0A++%7D%0A%7D%0A# security: - noauthAuth: [] parameters: - name: content-type in: header schema: type: string example: application/json - name: Authorization in: header schema: type: string example: Bearer {{token}} responses: '200': description: Successful response content: application/json: {} /accounts/api/organizations/{organization_id}/environments: get: tags: - Management Center > Runtime Manager > Applications summary: Get environments parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} post: tags: - Management Center > Access Management > Environments summary: Create a new environment requestBody: content: application/json: schema: type: object example: activeOrganizationId: '{{organization_id}}' name: Production-2 type: production parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /accounts/api/organizations/{organization_id}/environments/{environment_id}: get: tags: - Management Center > Access Management > Environments summary: Get environment by Id parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true - name: environment_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} put: tags: - Management Center > Access Management > Environments summary: Update an environment requestBody: content: application/json: schema: type: object example: name: sab-test-a security: - bearerAuth: [] parameters: - name: organization_id in: path schema: type: string required: true example: '{{organization_id}}' - name: environment_id in: path schema: type: string required: true example: '{{environment_id}}' responses: '200': description: Successful response content: application/json: {} delete: tags: - Management Center > Access Management > Environments summary: Delete an environment parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true - name: environment_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /accounts/api/organizations/{organization_id}/clients/{client_id}: get: tags: - Management Center > Access Management > Environments summary: Get client Id and client secret parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true - name: client_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /accounts/api/organizations/{orgid}/members: get: tags: - >- Management Center > Access Management > Business Groups (Organizations) > Members summary: Get Organization By Id parameters: - name: orgid in: path schema: type: string required: true example: '{{organization_id}}' responses: '200': description: Successful response content: application/json: {} /accounts/api/organizations/{organization_id}/hierarchy: get: tags: - >- Management Center > Access Management > Business Groups (Organizations) > Hierarchy summary: Get organization hierarchy parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /accounts/api/organizations: post: tags: - >- Management Center > Access Management > Business Groups (Organizations) summary: Create Organization requestBody: content: application/json: schema: type: object example: name: Example parentOrganizationId: '{{organization_id}}' ownerId: '{{owner_id}}' entitlements: createSubOrgs: true createEnvironments: true globalDeployment: false vCoresProduction: assigned: 0.2 vCoresSandbox: assigned: 0.2 vCoresDesign: assigned: 0.1 staticIps: assigned: 1 vpcs: assigned: 0 loadBalancer: assigned: 0 vpns: assigned: 0 responses: '200': description: Successful response content: application/json: {} put: tags: - >- Management Center > Access Management > Business Groups (Organizations) summary: Update Organisation requestBody: content: application/json: schema: type: object example: name: Example parentOrganizationId: '{{new_organization_id}}' ownerId: '{{owner_id}}' entitlements: createSubOrgs: true createEnvironments: true globalDeployment: false vCoresProduction: assigned: 0.2 vCoresSandbox: assigned: 0.2 vCoresDesign: assigned: 0.1 staticIps: assigned: 1 vpcs: assigned: 0 loadBalancer: assigned: 0 vpns: assigned: 0 responses: '200': description: Successful response content: application/json: {} /accounts/api/organizations/{orgid}: get: tags: - >- Management Center > Access Management > Business Groups (Organizations) summary: Get Organization By Id parameters: - name: orgid in: path schema: type: string required: true example: '{{organization_id}}' responses: '200': description: Successful response content: application/json: {} delete: tags: - >- Management Center > Access Management > Business Groups (Organizations) summary: Delete Organization parameters: - name: orgid in: path schema: type: string required: true example: '{{new_organization_id}}' responses: '200': description: Successful response content: application/json: {} /accounts/api/organizations/{organization_id}/members: get: tags: - Management Center > Access Management > Users summary: Get all users parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: limit in: query schema: type: integer example: '25' - name: offset in: query schema: type: integer example: '0' - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /accounts/api/organizations/{organization_id}/invites: get: tags: - Management Center > Access Management > Users summary: Get all user invites parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: limit in: query schema: type: integer example: '25' - name: offset in: query schema: type: integer example: '0' - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} post: tags: - Management Center > Access Management > Users summary: Invite users requestBody: content: application/json: schema: type: object example: - email: amir.khan@embrace-devops.com role_groups: - role_group_id: e6263c45-738d-4e33-8286-f28b6d3e6f7c name: API Versions Owner parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /accounts/api/organizations/{organization_id}/users/{user_id}: get: tags: - Management Center > Access Management > Users summary: Get user by Id parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true - name: user_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /accounts/api/organizations/{organization_id}/users/{user_id}/rolegroups: get: tags: - Management Center > Access Management > Users summary: Get all rolegroups assigned to user parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: limit in: query schema: type: integer example: '25' - name: offset in: query schema: type: integer example: '0' - name: organization_id in: path schema: type: string required: true - name: user_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /accounts/api/roles: get: tags: - Management Center > Access Management > Rolegroups > Roles summary: Get all Roles security: - bearerAuth: [] responses: '200': description: Successful response content: application/json: {} /accounts/api/organizations/{organization_id}/rolegroups/{rolegroup_Id}/roles: get: tags: - Management Center > Access Management > Rolegroups > Roles summary: Get roles by rolegroup Id parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true - name: rolegroup_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} post: tags: - Management Center > Access Management > Rolegroups > Roles summary: Add a new permission and environment to rolegroup requestBody: content: application/json: schema: type: object example: - context_params: org: af696110-60f8-4a47-9367-e2464a468949 envId: 67078084-8200-4956-a47b-7e97d5bb1835 role_id: f14b0d23-a267-4014-9563-29d46a26295b - context_params: org: af696110-60f8-4a47-9367-e2464a468949 envId: 67078084-8200-4956-a47b-7e97d5bb1835 role_id: 67ff49cb-6774-49de-92aa-95e0dd525b3d - context_params: org: af696110-60f8-4a47-9367-e2464a468949 envId: 67078084-8200-4956-a47b-7e97d5bb1835 role_id: c4662f0f-31fc-4791-9493-97a6e7ea261a - context_params: org: af696110-60f8-4a47-9367-e2464a468949 envId: 67078084-8200-4956-a47b-7e97d5bb1835 role_id: 2ee11112-51ca-47a8-b4ae-a6bb6e7e5573 - context_params: org: af696110-60f8-4a47-9367-e2464a468949 envId: 67078084-8200-4956-a47b-7e97d5bb1835 role_id: be26fe60-0cc9-4b9a-bf20-5b12a6aa34e1 - context_params: org: af696110-60f8-4a47-9367-e2464a468949 envId: 67078084-8200-4956-a47b-7e97d5bb1835 role_id: 456f139c-39e2-48c4-80b5-5205cb6b8ae2 - context_params: org: af696110-60f8-4a47-9367-e2464a468949 envId: 67078084-8200-4956-a47b-7e97d5bb1835 role_id: 5a46e86c-7a28-424b-84a9-20021b1ec626 - context_params: org: af696110-60f8-4a47-9367-e2464a468949 envId: 67078084-8200-4956-a47b-7e97d5bb1835 role_id: 8856c1b1-37cf-4f12-a02d-f36ce1a96a93 - context_params: org: af696110-60f8-4a47-9367-e2464a468949 envId: 67078084-8200-4956-a47b-7e97d5bb1835 role_id: 1660b07a-8920-4091-8292-1f42f35e92e4 - context_params: org: af696110-60f8-4a47-9367-e2464a468949 envId: 67078084-8200-4956-a47b-7e97d5bb1835 role_id: b979af78-664f-4ca2-8fd6-d8355fa09dc3 parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true - name: rolegroup_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} delete: tags: - Management Center > Access Management > Rolegroups > Roles summary: Delete roles from rolegroup parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true - name: rolegroup_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /accounts/api/organizations/{organization_id}/rolegroups/{rolegroup_Id}/users/{user_id}: post: tags: - Management Center > Access Management > Rolegroups > User Assignment summary: Assign rolegroup to a user requestBody: content: application/json: schema: type: object example: organizationId: '{{organization_id}}' userId: '{{user_id}}' roleGroupId: '{{rolegroup_Id}}' parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true - name: rolegroup_Id in: path schema: type: string required: true - name: user_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} delete: tags: - Management Center > Access Management > Rolegroups > User Assignment summary: Delete user from rolegroup parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true - name: rolegroup_Id in: path schema: type: string required: true - name: user_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /accounts/api/organizations/{organization_id}/rolegroups: get: tags: - Management Center > Access Management > Rolegroups summary: Get all rolegroups parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: include_internal in: query schema: type: boolean example: 'false' - name: limit in: query schema: type: integer example: '25' - name: offset in: query schema: type: integer example: '0' - name: search in: query schema: type: string - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} post: tags: - Management Center > Access Management > Rolegroups summary: Create a new rolegroup requestBody: content: application/json: schema: type: object example: name: External Org Admin 2 description: Description parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: include_internal in: query schema: type: boolean example: 'false' - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} delete: tags: - Management Center > Access Management > Rolegroups summary: Delete a rolegroup parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: include_internal in: query schema: type: boolean example: 'false' - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /accounts/api/organizations/{organization_id}/rolegroups/{rolegroup_Id}: get: tags: - Management Center > Access Management > Rolegroups summary: Get rolegroup by Id parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true - name: rolegroup_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /accounts/api/organizations/{organization_id}/rolegroups/{rolegroup_Id}/users: get: tags: - Management Center > Access Management > Rolegroups summary: Get users assigned to rolegroup parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: limit in: query schema: type: integer example: '25' - name: offset in: query schema: type: integer example: '0' - name: organization_id in: path schema: type: string required: true - name: rolegroup_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /accounts/api/cs/organizations/{organization_id}/permissions/products: get: tags: - Management Center > Access Management > Permissions summary: Get all product permissions parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /accounts/api/organizations/{organization_id}/provider/users: get: tags: - Management Center > Access Management > Identity Provider summary: Get users from provider parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /audit/v2/organizations/{organization_id}/query.csv: post: tags: - Management Center > Access Management > Audit Logs summary: Get csv formatted audit logs requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: startDate: type: string example: '2021-04-20T12:24:36.971Z' endDate: type: string example: '2021-04-21T12:24:36.971Z' ascending: type: boolean example: 'false' accessToken: type: string example: '{{token}}' parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /audit/v2/organizations/{organization_id}/query: post: tags: - Management Center > Access Management > Audit Logs summary: Get audit logs by filter requestBody: content: application/json: schema: type: object example: startDate: '2021-04-20T12:05:21.714Z' endDate: '2021-04-21T12:05:21.714Z' platforms: [] objectTypes: [] environmentIds: [] actions: [] objectIds: [] userIds: [] ascending: false organizationId: af696110-60f8-4a47-9367-e2464a468949 offset: 0 limit: 25 parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: include_internal in: query schema: type: boolean example: 'false' - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /accounts/api/connectedApplications: get: tags: - Management Center > Access Management > Connected Apps > Owned Apps summary: Get all connected apps parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: limit in: query schema: type: integer example: '100' - name: offset in: query schema: type: integer example: '0' - name: includeUsage in: query schema: type: boolean example: 'true' responses: '200': description: Successful response content: application/json: {} /accounts/api/cs/organizations/{organization_id}/connectedApplications/authorizations: get: tags: - >- Management Center > Access Management > Connected Apps > Authorizations summary: Get authorization for connected apps parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: limit in: query schema: type: integer example: '100' - name: offset in: query schema: type: integer example: '0' - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /accounts/api/organizations/{organization_id}/connectedApplications/settings: get: tags: - >- Management Center > Access Management > Connected Apps > Authorizations summary: Get settings for authorization parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /accounts/api/cs/conditionalAssignments: get: tags: - Management Center > Access Management > External Access summary: Get all conditional assignments parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: intent in: query schema: type: string example: role_assignment responses: '200': description: Successful response content: application/json: {} /accounts/api/organizations/{organization_id}/teams: get: tags: - Management Center > Access Management > Team summary: Get all Teams parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} post: tags: - Management Center > Access Management > Team summary: Create New Team requestBody: content: application/json: schema: type: object example: parent_team_id: '{{parent_team_id}}' team_name: '{{new_team_name}}' team_type: internal parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /accounts/api/organizations/{organization_id}/teams/{team_id}/roles: get: tags: - Management Center > Access Management > Team summary: Get Permission for Team parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true - name: team_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /accounts/api/organizations/{organization_id}/teams/{child_team_id}/roles: post: tags: - Management Center > Access Management > Team summary: Assign Permissions to Team requestBody: content: application/json: schema: type: object example: - role_id: '{{exchange_viewer_role_id}}' context_params: org: '{{organization_id}}' parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true - name: child_team_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /accounts/api/cs: get: tags: - Management Center > Access Management summary: Get all information for organization parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} responses: '200': description: Successful response content: application/json: {} /apimanager/api/v1/organizations/{organization_id}/environments/{environment_id}/apis/{api_Id}: get: tags: - >- Management Center > API Manager > API Administration > Manage APIs > Single API summary: Get api details by Id parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true - name: environment_id in: path schema: type: string required: true - name: api_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} patch: tags: - >- Management Center > API Manager > API Administration > Manage APIs > Single API summary: Undeprecate api requestBody: content: application/json: schema: type: object example: deprecated: false parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true - name: environment_id in: path schema: type: string required: true - name: api_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} delete: tags: - >- Management Center > API Manager > API Administration > Manage APIs > Single API summary: Delete api parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true - name: environment_id in: path schema: type: string required: true - name: api_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /apimanager/api/v1/organizations/{organization_id}/environments/{environment_id}/apis/{api_Id}/alerts: get: tags: - >- Management Center > API Manager > API Administration > Manage APIs > Single API summary: Get alerts for api parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: limit in: query schema: type: integer example: '10000' - name: organization_id in: path schema: type: string required: true - name: environment_id in: path schema: type: string required: true - name: api_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} post: tags: - >- Management Center > API Manager > API Administration > Manage APIs > Single API summary: POST create an alerts for api requestBody: content: application/json: schema: type: object example: apiAlertsVersion: 1.0.0 condition: aggregate: COUNT operator: GREATER_THAN value: 20 resourceType: api enabled: true name: api-request-count-alert period: repeat: 5 duration: count: 5 weight: MINUTES recipients: - type: user value: 57e281b5-ec5b-4701-80a0-92a936a68da3 lastName: Owner firstName: Organization - type: email value: mulesoft_c4e_admin@pqr.com severity: CRITICAL type: api-request-count parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true - name: environment_id in: path schema: type: string required: true - name: api_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /apimanager/api/v1/organizations/{organization_id}/environments/{environment_id}/apis/{api_Id}/contracts: get: tags: - >- Management Center > API Manager > API Administration > Manage APIs > Single API summary: Get contracts for api parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true - name: environment_id in: path schema: type: string required: true - name: api_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /apimanager/api/v1/organizations/{organization_id}/environments/{environment_id}/apis/{api_Id}/policies: get: tags: - >- Management Center > API Manager > API Administration > Manage APIs > Single API summary: Get all policies parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: fullInfo in: query schema: type: boolean example: 'false' - name: organization_id in: path schema: type: string required: true - name: environment_id in: path schema: type: string required: true - name: api_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} post: tags: - Management Center > API Manager > OOTB Policy summary: Apply Rate-Limiting Policy requestBody: content: application/json: schema: type: object example: configurationData: clusterizable: true exposeHeaders: true rateLimits: - timePeriodInMilliseconds: 86400000 maximumRequests: 1000 pointcutData: null policyTemplateId: rate-limiting assetId: rate-limiting assetVersion: 1.3.5 groupId: 68ef9520-24e9-4cf2-b2f5-620025690913 parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true - name: environment_id in: path schema: type: string required: true - name: api_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /apimanager/api/v1/organizations/{organization_id}/policy-templates: get: tags: - >- Management Center > API Manager > API Administration > Manage APIs > Single API summary: Get all policy-templates parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: apiInstanceId in: query schema: type: string example: '{{api_Id}}' - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /apimanager/api/v1/organizations/{organization_id}/environments/{environment_id}/apis/{api_Id}/tiers: get: tags: - >- Management Center > API Manager > API Administration > Manage APIs > Single API summary: Get all tiers parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true - name: environment_id in: path schema: type: string required: true - name: api_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /apimanager/api/v1/organizations/{organization_id}/environments/{environment_id}/apis/{api_Id}/bundle: get: tags: - >- Management Center > API Manager > API Administration > Manage APIs > Single API summary: Export api as ZIP parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: endpoint in: query schema: type: boolean example: 'true' - name: slaTiers in: query schema: type: boolean example: 'true' - name: cookie in: query schema: type: string example: file-download-1619013965103 - name: organization_id in: path schema: type: string required: true - name: environment_id in: path schema: type: string required: true - name: api_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /apimanager/api/v1/organizations/{organization_id}/environments/{environment_id}/apis: post: tags: - Management Center > API Manager > API Administration > Manage APIs summary: Import api as zip requestBody: content: multipart/form-data: schema: type: object properties: file: type: string format: binary parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true - name: environment_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} get: tags: - Management Center > API Manager > API Administration > Manage APIs summary: Get apis for an environment parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: ascending in: query schema: type: boolean example: 'false' - name: limit in: query schema: type: integer example: '20' - name: offset in: query schema: type: integer example: '0' - name: sort in: query schema: type: string example: createdDate - name: organization_id in: path schema: type: string required: true - name: environment_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /apimanager/xapi/v1/organizations/{organization_id}/environments/{environment_id}/clients: get: tags: - Management Center > API Manager > API Administration > Manage APIs summary: Get clients for environment parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true - name: environment_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /apimanager/xapi/v1/organizations/{organization_id}/permissions: get: tags: - Management Center > API Manager > API Administration > Manage APIs summary: Get all permissions for an environment parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: environmentId in: query schema: type: string example: '{{environment_id}}' - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /apimanager/xapi/v1/organizations/active: get: tags: - Management Center > API Manager > API Administration summary: Get all active organizations parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} responses: '200': description: Successful response content: application/json: {} /apimanager/xapi/v1/organizations/{organization_id}/environments: get: tags: - Management Center > API Manager > API Groups summary: Get environments parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /apimanager/api/v1/organizations/{organization_id}/groups: get: tags: - Management Center > API Manager > API Groups summary: Get all api groups parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} post: tags: - Management Center > API Manager > API Groups summary: Create an api group requestBody: content: application/json: schema: type: object example: "{\r\n \"name\":\"myAPIseg\",\r\n \"versions\":[\r\n {\r\n \"name\":\"v1\",\r\n \"instances\":[\r\n {\r\n \"environmentId\":\"{{environment_id}}\",\r\n \"groupInstanceLabel\":\"technet\",\r\n \"apiInstances\":[\r\n {{api_Id}}\r\n ]\r\n }\r\n ]\r\n }\r\n ]\r\n}" parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /apimanager/api/v1/organizations/{organization_id}/groups/{apigroup_id}/versions: get: tags: - Management Center > API Manager > API Groups summary: Get api group version parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true - name: apigroup_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} post: tags: - Management Center > API Manager > API Groups summary: Create a new api group version requestBody: content: application/json: schema: type: object example: "{\r\n \"name\":\"v3\",\r\n \"instances\":[\r\n {\r\n \"environmentId\":\"{{environment_id}}\",\r\n \"groupInstanceLabel\":\"technet\",\r\n \"apiInstances\":[\r\n {{api_Id}}\r\n ]\r\n }\r\n ]\r\n}" parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true - name: apigroup_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /apimanager/api/v1/organizations/{organization_id}/environments/{environment_id}/groupInstances: get: tags: - Management Center > API Manager > API Groups summary: Get api group instances parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true - name: environment_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} post: tags: - Management Center > API Manager > API Groups summary: Create new api group instance requestBody: content: application/json: schema: type: object example: "{\r\n \"groupId\":{{apigroup_id}},\r\n \"groupVersionId\":43866,\r\n \"apiInstances\":[\r\n {{api_Id}}\r\n ]\r\n}" parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true - name: environment_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /apimanager/xapi/v1/organizations/{organization_id}/groups/permittedOrganizations: get: tags: - Management Center > API Manager > API Groups summary: Get permittedOrganizations parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /apiplatform/repository/v2/organizations/{organization_id}/applications: get: tags: - Management Center > API Manager > Client Applications summary: Get all applications parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: ascending in: query schema: type: boolean example: 'true' - name: filter in: query schema: type: string example: all - name: limit in: query schema: type: integer example: '10' - name: literalMatch in: query schema: type: boolean example: 'true' - name: offset in: query schema: type: integer example: '0' - name: sort in: query schema: type: string example: name - name: targetAdminSite in: query schema: type: boolean example: 'true' - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /apimanager/api/v1/organizations/{organization_id}/custom-policy-templates: get: tags: - Management Center > API Manager > OOTB Policy summary: Get all ootb policy-templates parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: limit in: query schema: type: integer example: '20' - name: offset in: query schema: type: integer example: '0' - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /cloudhub/api/notifications/count: get: tags: - Management Center > Runtime Manager > Applications > Notification summary: Get notification count parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' responses: '200': description: Successful response content: application/json: {} /cloudhub/api/notifications: get: tags: - Management Center > Runtime Manager > Applications > Notification summary: Get notifications parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' responses: '200': description: Successful response content: application/json: {} /cloudhub/api/system-info: get: tags: - Management Center > Runtime Manager > Applications > Cloudhub summary: Get system-information parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} responses: '200': description: Successful response content: application/json: {} /cloudhub/api/organization: get: tags: - Management Center > Runtime Manager > Applications > Cloudhub summary: Get organization parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} responses: '200': description: Successful response content: application/json: {} /cloudhub/api/regions: get: tags: - Management Center > Runtime Manager > Applications > Cloudhub summary: Get all regions parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} responses: '200': description: Successful response content: application/json: {} /cloudhub/api/core-services/users/current/permissions: get: tags: - Management Center > Runtime Manager > Applications > Cloudhub summary: Get current user permissions parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' responses: '200': description: Successful response content: application/json: {} /cloudhub/api/v2/applications/{app_Id}: get: tags: - Management Center > Runtime Manager > Applications > Cloudhub summary: Get single application info parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' - name: app_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /cloudhub/api/v2/applications/{app_Id}/deployments: get: tags: - Management Center > Runtime Manager > Applications > Cloudhub summary: Get all deployments for application parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' - name: app_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /cloudhub/api/v2/applications/{app_Id}/deployments/{deployment_Id}/logs: get: tags: - Management Center > Runtime Manager > Applications > Cloudhub summary: Get logs for application deployment parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' - name: app_Id in: path schema: type: string required: true - name: deployment_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /cloudhub/api/v2/applications/{app_Id}/instances/{deployment_Id}/logs: get: tags: - Management Center > Runtime Manager > Applications > Cloudhub summary: Get systemlogs for application parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' - name: app_Id in: path schema: type: string required: true - name: deployment_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /cloudhub/api/v2/applications/{app_Id}/dashboardStats: get: tags: - Management Center > Runtime Manager > Applications > Cloudhub summary: Get dashboardstats for app parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' - name: app_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /cloudhub/api/v2/applications: get: tags: - Management Center > Runtime Manager > Applications > Cloudhub summary: List all Cloudhub APIs in an environment parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' responses: '200': description: Successful response content: application/json: {} post: tags: - >- Management Center > Runtime Manager > Applications > Deploy Application summary: Deploy application requestBody: content: application/json: schema: type: object example: applicationInfo: fileName: HTTP Request Response with Logger muleVersion: version: 4.3.0 updateId: 606cc71944b5ff1b07f791e3 properties: anypoint.platform.config.analytics.agent.enabled: 'false' logLevels: [] trackingSettings: trackingLevel: DISABLED deploymentGroup: null monitoringEnabled: true monitoringAutoRestart: true persistentQueues: false persistentQueuesEncrypted: false workers: amount: 1 type: name: Micro weight: 0.1 cpu: 0.1 vCores memory: 500 MB memory objectStoreV1: false loggingNgEnabled: true loggingCustomLog4JEnabled: false staticIPsEnabled: false domain: postman-api applicationSource: source: EXCHANGE groupId: org.mule.examples artifactId: http-request-response-with-logger version: 2.1.4 organizationId: 68ef9520-24e9-4cf2-b2f5-620025690913 autoStart: true parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' responses: '200': description: Successful response content: application/json: {} /cloudhub/api/v2/applications/da-american-flights: get: tags: - Management Center > Runtime Manager > Applications > Cloudhub summary: Get Cloudhub API in an environment parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' responses: '200': description: Successful response content: application/json: {} /cloudhub/api/mule-versions/{mule_version}/updates/{patchId}: get: tags: - Management Center > Runtime Manager > Applications > Cloudhub summary: Get Patch by PatchId parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' - name: mule_version in: path schema: type: string required: true - name: patchId in: path schema: type: string required: true responses: '200': description: OK headers: Access-Control-Allow-Headers: schema: type: string example: >- Origin, Authorization, Accept, X-Requested-With, Content-Type, Access-Control-Request-Method, Access-Control-Request-Headers, x-anypnt-env-id, x-anypnt-org-id Access-Control-Allow-Methods: schema: type: string example: GET, POST, DELETE, PUT, OPTIONS, HEAD Access-Control-Allow-Origin: schema: type: string example: '*' Content-Type: schema: type: string example: application/json Date: schema: type: string example: Tue, 15 Feb 2022 18:00:48 GMT Server: schema: type: string example: nginx Strict-Transport-Security: schema: type: string example: max-age=31536000; includeSubDomains X-ANYPNT-TRX-ID: schema: type: string example: 16853b80-af6f-457d-aae7-b2ed89638b29 X-RateLimit-Limit: schema: type: string example: unlimited X-RateLimit-Remaining: schema: type: string example: unlimited Content-Length: schema: type: integer example: '2817' Connection: schema: type: string example: keep-alive content: application/json: schema: type: object example: id: 61fdba9e5a08be2bfbaaa7a4 name: 02-08-2022 releaseDate: 1644018334471 releaseNotes: >- https://docs.mulesoft.com/release-notes/cloudhub-runtimes-release-notes flags: performLog4jReplacement: true skipMMCPairing: true log4j1Used: false usingMuleAgent: false vpnSupported: true monitoringSupported: true objectStoreV1: false loggingNgSupported: true diagnosticsSupported: true persistentQueuesSupported: true asyncScheduleSupported: false muleLivenessSupported: false muleReadinessCheckSupported: false ocsServiceSupported: false injectLog4j2Supported: false injectMuleLogsWhenFail: false muleDistributionName: none amiVersionData: mule,version: 3.8.5 mule,distro,version: 3.8.5-20220128 httpcomponents,httpclient,version: 4.4.1 jackson,version: 1.9.11 project,build,sourceEncoding: UTF-8 restassured,version: 1.6.2 mmc,common,artifact: mmc-agent-api slf4j,version: 1.6.2 junit,version: '4.12' log4j,version: '2.5' hawtjournal,version: 1.0-MULEPATCH cloudhub-common,version: 58-SNAPSHOT spring,version: 4.1.6.RELEASE xalan,version: 2.7.1 mmc,version: 3.8.5 clm,serverId: nexusiq-server woodstox,version: 4.1.4 cobertura,totalLineRate: '65' commons,lang,version: '2.4' aws-java-sdk,version: 1.11.153 quartz,version: 2.2.1 xercesImpl,version: 2.11.0 cobertura,packageBranchRate: '65' maven,deploy,skip: 'false' jersey,version: '2.11' geronimo-jta,version: 1.1.1 branchFullName: 3.8.5 guava,version: '18.0' cloudhub-appender,version: 61-SNAPSHOT licensePath: muleLicenseKey.lic commons-io,version: '2.4' javax,ws,version: '2.0' commons,logging,version: 1.1.1 mmc,agent,artifact: mmc-agent branchType: 3.8.5 mmc,common,group: com.mulesoft.muleesb.modules.agent elasticsearch,version: 0.19.9 commons,lang3,version: '3.1' jasypt,version: '1.7' mmc,agent,group: com.mulesoft.muleesb.modules.agent patform,services,version: 44-SNAPSHOT cobertura,totalBranchRate: '65' mule,distro,target,directory: >- /var/lib/jenkins/workspace/hub_cloudhub-mule-services_3.8.5/mule-extensions/mule-distribution/target/mule-ee gson,version: '2.2' cobertura,packageLineRate: '65' mule,agent,version: 1.7.1-mule-3.x mule,distribution,name: 3.8.5 branchDetail: N/A httpcomponents,httpcore,version: 4.4.1 mockito,version: 1.10.19 objectstore,plugin,version: 3.8-1.5 mule,version,base: 3.8.5 cobertura,branchRate: '65' geronimo,version: '1.1' mule,version,suffix: '20220128' mule-licm,version: 1.1.5 clm,serverUrl: http://nexus-iq-0:8070 mule,unpack,directory: >- /var/lib/jenkins/workspace/hub_cloudhub-mule-services_3.8.5/mule-extensions/mule-distribution/target/mule-ee/mule-enterprise-standalone-3.8.5-20220128 clm,applicationId: mule-distribution cobertura,lineRate: '65' /cloudhub/api/mule-versions: get: tags: - >- Management Center > Runtime Manager > Applications > Deploy Application summary: Get mule-version parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' responses: '200': description: Successful response content: application/json: {} /armui/api/v1/targets: get: tags: - >- Management Center > Runtime Manager > Applications > Deploy Application summary: Get target deployment types parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' responses: '200': description: Successful response content: application/json: {} /cloudhub/api/v2/environment/deploymentgroups: get: tags: - >- Management Center > Runtime Manager > Applications > Deploy Application summary: Get deployment groups parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' responses: '200': description: Successful response content: application/json: {} /cloudhub/api/applications/domains: get: tags: - >- Management Center > Runtime Manager > Applications > Deploy Application summary: Get domains parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' responses: '200': description: Successful response content: application/json: {} /hybrid/api/v1/applications: get: tags: - Management Center > Runtime Manager > Applications > Hybrid summary: Get All Applications - hybrid mode parameters: - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: Authorization in: header schema: type: string example: Bearer {{token}} responses: '200': description: Successful response content: application/json: {} /hybrid/api/v1/applications{hyb_app_id}: get: tags: - Management Center > Runtime Manager > Applications > Hybrid summary: Get Single Application info - hybrid mode parameters: - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: hyb_app_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /cloudhub/api/buildinfo/environment: get: tags: - Management Center > Runtime Manager > Applications summary: Get buildinfo for environments parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} responses: '200': description: Successful response content: application/json: {} /armui/api/v1/permissions: get: tags: - Management Center > Runtime Manager > Applications summary: Get permissions parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' responses: '200': description: Successful response content: application/json: {} /accounts/api/organizations/{organization_id}/entitlements: get: tags: - Management Center > Runtime Manager > Applications summary: Get entitlement parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /armui/api/v1/applications: get: tags: - Management Center > Runtime Manager > Applications summary: Get applications parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' responses: '200': description: Successful response content: application/json: {} /hybrid/api/v1/serverGroups: get: tags: - Management Center > Runtime Manager > Servers > Servergroups summary: Get servergroups parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' responses: '200': description: Successful response content: application/json: {} post: tags: - Management Center > Runtime Manager > Servers > Servergroups summary: Create servergroup requestBody: content: application/json: schema: type: object example: name: test2 serverIds: [] parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' responses: '200': description: Successful response content: application/json: {} /hybrid/api/v1/serverGroups/{servergroup_Id}: delete: tags: - Management Center > Runtime Manager > Servers > Servergroups summary: Delete servergroup parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' - name: servergroup_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /hybrid/api/v1/clusters: get: tags: - Management Center > Runtime Manager > Servers > Clusters summary: Get clusters parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' responses: '200': description: Successful response content: application/json: {} post: tags: - Management Center > Runtime Manager > Servers > Clusters summary: Get clusters Copy requestBody: content: application/json: schema: type: object example: name: cluster-test multicastEnabled: false servers: [] parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' responses: '200': description: Successful response content: application/json: {} /armui/api/v1/servers: get: tags: - Management Center > Runtime Manager > Servers summary: Get all servers parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' responses: '200': description: Successful response content: application/json: {} /armui/api/v1/alerts/cloudhub/02213013-10f2-4bbb-b399-718c0a543e18: put: tags: - Management Center > Runtime Manager > Alerts summary: Update alert by id requestBody: content: application/json: schema: type: object example: name: Low CPU usage severity: WARNING actions: - type: email content: >- Hello, You are receiving this alert because: The application ${resource} is now in an ${state} state, based on the condition 'CPU ${operator} ${value}%. subject: '${severity}: CPU usage ${state}' emails: - angel.alberici+testalerts@mulesoft.com - angel.alberici@mulesoft.com condition: operator: LESS_THAN value: 50 periodCount: 1 resourceType: cloudhub-application type: cpu periodMins: 1 resources: - '*' parameters: - name: X-ANYPNT-ENV-ID in: header schema: type: string description: >- (Required) Identifier of the environment where the api user is currently working. example: '{{environment_id}}' - name: X-ANYPNT-ORG-ID in: header schema: type: string description: >- (Required) Identifier of the sub org where the api user is currently working. example: '{{organization_id}}' - name: Authorization in: header schema: type: string example: Bearer {{token}} responses: '202': description: Accepted headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: id: 2312 timeCreated: 342423432142342 timeUpdated: 342423432154342 severity: CRITICAL description: Notify when one server of cluster 45 went down enabled: true action: notification: recipients: - alex.tiavo - greg.kio condition: resourceType: CLUSTER resources: - 45 event: DISCONNECTED /armui/api/v1/alerts: get: tags: - Management Center > Runtime Manager > Alerts summary: Get all alerts parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' responses: '200': description: Successful response content: application/json: {} /armui/api/v1/alerts/cloudhub: post: tags: - Management Center > Runtime Manager > Alerts summary: Create an alert requestBody: content: application/json: schema: type: object example: name: Platform API Postman Test 001 severity: INFO actions: - type: email content: >- Hello, You are receiving this alert because: The application ${resource} is now in an ${state} state, based on the condition 'memory ${operator} ${value}%'. subject: '${severity}: memory usage ${state}' userIds: - 2909a63d-c57a-47b0-90f1-7ddfb815efba condition: operator: GREATER_THAN periodCount: 20 value: 80 resourceType: cloudhub-application type: memory periodMins: 1 resources: - '*' parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' responses: '200': description: Successful response content: application/json: {} /armui/api/v1/alerts/cloudhub/{alert_id}: get: tags: - Management Center > Runtime Manager > Alerts summary: Get alert by id description: | Get the alert with id = {alertId} parameters: - name: X-ANYPNT-ENV-ID in: header schema: type: string description: >- (Required) Identifier of the environment where the api user is currently working. example: '{{environment_id}}' - name: X-ANYPNT-ORG-ID in: header schema: type: string description: >- (Required) Identifier of the sub org where the api user is currently working. example: '{{organization_id}}' - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: alert_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /armui/api/v1/alerts/cloudhub/{alert_id}/history: get: tags: - Management Center > Runtime Manager > Alerts summary: Get alert history by id description: Returns a list of the alert history for this particular alert id parameters: - name: X-ANYPNT-ENV-ID in: header schema: type: string description: >- (Required) Identifier of the environment where the api user is currently working. example: '{{environment_id}}' - name: X-ANYPNT-ORG-ID in: header schema: type: string description: >- (Required) Identifier of the sub org where the api user is currently working. example: '{{organization_id}}' - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: alert_id in: path schema: type: string required: true responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: {} '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: {} /cloudhub/api/organizations/{orgId}/vpcs: post: tags: - Management Center > Runtime Manager > VPC summary: Create a VPC requestBody: content: application/json: schema: type: object example: name: myTestVPC region: us-east-1 cidrBlock: 192.168.1.0/24 internalDns: dnsServers: - 8.8.8.8 - 8.8.8.4 specialDomains: [] isDefault: false associatedEnvironments: [] sharedWith: [] firewallRules: - cidrBlock: 0.0.0.0/0 protocol: tcp fromPort: 8081 toPort: 8082 - cidrBlock: 192.168.1.0/24 protocol: tcp fromPort: 8091 toPort: 8092 security: - bearerAuth: [] parameters: - name: orgId in: path schema: type: string required: true example: '{{organization_id}}' responses: '200': description: Successful response content: application/json: {} get: tags: - Management Center > Runtime Manager > VPC summary: Get All VPCs security: - bearerAuth: [] parameters: - name: orgId in: path schema: type: string required: true example: '{{organization_id}}' responses: '200': description: Successful response content: application/json: {} /cloudhub/api/organizations/{orgId}/vpcs/{vpcId}: get: tags: - Management Center > Runtime Manager > VPC summary: GET a VPC by Id security: - bearerAuth: [] parameters: - name: orgId in: path schema: type: string required: true example: '{{organization_id}}' - name: vpcId in: path schema: type: string required: true example: xxxxxx responses: '200': description: Successful response content: application/json: {} put: tags: - Management Center > Runtime Manager > VPC summary: Update VPC by Id requestBody: content: application/json: schema: type: object example: name: myTestVPC region: us-east-1 cidrBlock: 192.168.1.0/24 internalDns: dnsServers: [] specialDomains: [] isDefault: false associatedEnvironments: [] sharedWith: [] firewallRules: - cidrBlock: 0.0.0.0/0 protocol: tcp fromPort: 8081 toPort: 8082 - cidrBlock: 192.168.1.0/24 protocol: tcp fromPort: 8091 toPort: 8092 security: - bearerAuth: [] parameters: - name: orgId in: path schema: type: string required: true example: '{{organization_id}}' - name: vpcId in: path schema: type: string required: true example: xxxxxx responses: '200': description: Successful response content: application/json: {} delete: tags: - Management Center > Runtime Manager > VPC summary: Delete VPC by Id security: - bearerAuth: [] parameters: - name: orgId in: path schema: type: string required: true example: '{{organization_id}}' - name: vpcId in: path schema: type: string required: true example: xxxxxx responses: '200': description: Successful response content: application/json: {} /cloudhub/api/organizations/{organization_id}/vpcs/{vpc_id}/ipsec/{vpn_id}: get: tags: - Management Center > Runtime Manager > VPN summary: Get VPN Status parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true - name: vpc_id in: path schema: type: string required: true - name: vpn_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /cloudhub/api/organizations/{organization_id}/loadbalancers: get: tags: - Management Center > Runtime Manager > Load Balancers summary: Get all load balancers parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /cloudhub/api/organizations/{orgId}/vpcs/{vpc}/loadbalancers: get: tags: - Management Center > Runtime Manager > Load Balancers summary: Get DLBs of a VPC security: - bearerAuth: [] parameters: - name: orgId in: path schema: type: string required: true example: '{{organization_id}}' - name: vpc in: path schema: type: string required: true example: xxxxxx responses: '200': description: Successful response content: application/json: {} post: tags: - Management Center > Runtime Manager > Load Balancers summary: Create a DLB withing a VPC requestBody: content: application/json: schema: type: object example: name: myloadbalancer ipWhitelist: [] httpMode: redirect defaultSslEndpoint: 0 tlsv1: false sslEndpoints: - publicKey: >- -----BEGIN CERTIFICATE-----YOUR PUBLIC KEY-----END CERTIFICATE----- privateKey: >- -----BEGIN PRIVATE KEY-----YOUR PRIVATE KEY-----END PRIVATE KEY----- verifyClientMode: 'off' mappings: - inputUri: '{app}/' appName: '{app}' appUri: / security: - bearerAuth: [] parameters: - name: orgId in: path schema: type: string required: true example: '{{organization_id}}' - name: vpc in: path schema: type: string required: true example: xxxxxx responses: '200': description: Successful response content: application/json: {} /cloudhub/api/organizations/{orgId}/vpcs/{vpc}/loadbalancers/{dlbid}: patch: tags: - Management Center > Runtime Manager > Load Balancers summary: update DLB requestBody: content: application/json: schema: type: object example: - op: replace path: /state value: STARTED - op: replace path: /sslEndpoints/0 value: publicKey: >- -----BEGIN CERTIFICATE-----YOUR PUBLIC KEY-----END CERTIFICATE----- privateKey: >- -----BEGIN PRIVATE KEY-----YOUR PRIVATE KEY-----END PRIVATE KEY----- verifyClientMode: 'off' mappings: - inputUri: '{app}/' appName: '{app}' appUri: / security: - bearerAuth: [] parameters: - name: orgId in: path schema: type: string required: true example: '{{organization_id}}' - name: vpc in: path schema: type: string required: true example: xxxxxx - name: dlbid in: path schema: type: string required: true example: xxxxxx responses: '200': description: Successful response content: application/json: {} /cloudhub/api/organizations/{orgId}/vpcs/{vpc}/loadbalancers/{lbdid}: delete: tags: - Management Center > Runtime Manager > Load Balancers summary: delete DLB security: - bearerAuth: [] parameters: - name: orgId in: path schema: type: string required: true example: '{{organization_id}}' - name: vpc in: path schema: type: string required: true example: xxxxxx - name: lbdid in: path schema: type: string required: true example: xxxxxx responses: '200': description: Successful response content: application/json: {} /api/v1/organizations/{organization_id}/environments/{environment_id}/stores: get: tags: - Management Center > Runtime Manager > Object Store v2 summary: Get OSV2 Stores parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true - name: environment_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /api/v1/organizations/{organization_id}: get: tags: - Management Center > Runtime Manager > Object Store v2 summary: Get OSV2 Stores Stats parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: startDate in: query schema: type: string example: '{{start_date}}' - name: endDate in: query schema: type: string example: '{{end_date}}' - name: period in: query schema: type: string example: '{{period}}' - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /organizations/{organization_id}/privatespaces/{private_space_id}/transitgateways: get: tags: - >- Management Center > Runtime Manager > Private Spaces (Cloudhub 2.0) > Transit Gateways within Private Spaces summary: List TGW connections assocated with Private Space description: get list of TGW connections assocated with a private space. parameters: - name: Accept in: header schema: type: string example: application/json - name: organization_id in: path schema: type: string required: true - name: private_space_id in: path schema: type: string required: true responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json ETag: schema: type: string example: content: application/json: schema: type: object example: - id: name: spec: resourceShare: id: account: region: spaceName: status: gateway: attachment: tgwResource: routes: - - - id: name: spec: resourceShare: id: account: region: spaceName: status: gateway: attachment: tgwResource: routes: - - '415': description: Unsupported Media Type headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: errors: - code: message: - code: message: '429': description: Too Many Requests headers: Content-Type: schema: type: string example: application/json Retry-After: schema: type: string example: content: application/json: schema: type: object example: message: errors: - code: message: - code: message: post: tags: - >- Management Center > Runtime Manager > Private Spaces (Cloudhub 2.0) > Transit Gateways within Private Spaces summary: Create Private Space TGW connection description: create a private space TGW connection. requestBody: content: application/json: schema: type: object example: name: resourceShareId: resourceShareAccount: routes: - - parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: organization_id in: path schema: type: string required: true - name: private_space_id in: path schema: type: string required: true responses: '201': description: Created headers: Content-Type: schema: type: string example: application/json Location: schema: type: string example: ETag: schema: type: string example: content: application/json: schema: type: object example: id: name: spec: resourceShare: id: account: region: spaceName: status: gateway: attachment: tgwResource: routes: - - '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: errors: - code: message: - code: message: '409': description: Conflict content: text/plain: schema: type: string example: '' '415': description: Unsupported Media Type headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: errors: - code: message: - code: message: '429': description: Too Many Requests headers: Content-Type: schema: type: string example: application/json Retry-After: schema: type: string example: content: application/json: schema: type: object example: message: errors: - code: message: - code: message: /organizations/{organization_id}/privatespaces/{private_space_id}/transitgateways/routes: get: tags: - >- Management Center > Runtime Manager > Private Spaces (Cloudhub 2.0) > Transit Gateways within Private Spaces summary: Get TGW routes configured in Private Space description: get TGW routes configured to private space. parameters: - name: organization_id in: path schema: type: string required: true - name: private_space_id in: path schema: type: string required: true responses: '200': description: OK content: text/plain: schema: type: string example: '' /organizations/{organization_id}/privatespaces/{private_space_id}/transitgateways/{transit_gateway_id}: delete: tags: - >- Management Center > Runtime Manager > Private Spaces (Cloudhub 2.0) > Transit Gateways within Private Spaces summary: Detach a Transit Gateway from the Private Space description: Detach a Transit Gateway from the Private Space parameters: - name: organization_id in: path schema: type: string required: true - name: private_space_id in: path schema: type: string required: true - name: transit_gateway_id in: path schema: type: string required: true responses: '200': description: OK content: text/plain: schema: type: string example: '' patch: tags: - >- Management Center > Runtime Manager > Private Spaces (Cloudhub 2.0) > Transit Gateways within Private Spaces summary: Patch the Private Space TGW Connection description: patch the Private Space TGW Connection requestBody: content: application/json: schema: type: object example: name: parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: organization_id in: path schema: type: string required: true - name: private_space_id in: path schema: type: string required: true - name: transit_gateway_id in: path schema: type: string required: true responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: id: name: spec: resourceShare: id: account: region: spaceName: status: gateway: attachment: tgwResource: routes: - - '202': description: Accepted headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: x-amf-examples: response: name: rtf-kamboocha spec: resourceShare: account: '25102306' region: us-east-1 networkIds: - network-deployment-id1 spaceName: space status: gateway: unknown attachment: unattached tgwResource: http://aws.tgw.link.com routes: - 10.0.0.0/21 - 10.0.0.0/22 get: tags: - >- Management Center > Runtime Manager > Private Spaces (Cloudhub 2.0) > Transit Gateways within Private Spaces summary: Get Transit Gateway by ID description: | Get the transitgateway with id = {transitgatewayId} parameters: - name: Accept in: header schema: type: string example: application/json - name: organization_id in: path schema: type: string required: true - name: private_space_id in: path schema: type: string required: true - name: transit_gateway_id in: path schema: type: string required: true responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: x-amf-examples: response: name: rtf-kamboocha spec: resourceShare: account: '25102306' region: us-east-1 networkIds: - network-deployment-id1 spaceName: space status: gateway: unknown attachment: unattached tgwResource: http://aws.tgw.link.com routes: - 10.0.0.0/21 - 10.0.0.0/22 '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: {} /organizations/{organization_id}/privatespaces/{private_space_id}/transitgateways/{transit_gateway_id}/routes: patch: tags: - >- Management Center > Runtime Manager > Private Spaces (Cloudhub 2.0) > Transit Gateways within Private Spaces summary: Patch routes for a TGW connection description: patch routes for a TGW connection. requestBody: content: application/json: schema: type: object example: - - parameters: - name: Content-Type in: header schema: type: string example: application/json - name: organization_id in: path schema: type: string required: true - name: private_space_id in: path schema: type: string required: true - name: transit_gateway_id in: path schema: type: string required: true responses: '200': description: OK content: text/plain: schema: type: string example: '' get: tags: - >- Management Center > Runtime Manager > Private Spaces (Cloudhub 2.0) > Transit Gateways within Private Spaces summary: Get TGW Routes configured to TGW Connection description: get TGW routes configured to tgw connection. parameters: - name: organization_id in: path schema: type: string required: true - name: private_space_id in: path schema: type: string required: true - name: transit_gateway_id in: path schema: type: string required: true responses: '200': description: OK content: text/plain: schema: type: string example: '' /organizations/{organization_id}/privatespaces/{private_space_id}/tlsContexts: get: tags: - >- Management Center > Runtime Manager > Private Spaces (Cloudhub 2.0) > TLS Contexts summary: List TLS contexts inside Private Space description: get the list of TLS contexts inside the private space. parameters: - name: Accept in: header schema: type: string example: application/json - name: organization_id in: path schema: type: string required: true - name: private_space_id in: path schema: type: string required: true responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json ETag: schema: type: string example: content: application/json: schema: type: object example: - id: name: keyStore: type: cn: san: - - fileName: alias: keyFileName: capathFileName: expirationDate: ciphers: aes128GcmSha256: false aes128Sha256: false aes256GcmSha384: false aes256Sha256: false dheRsaAes128Sha256: false dheRsaAes256GcmSha384: false dheRsaAes256Sha256: false ecdheEcdsaAes128GcmSha256: true ecdheEcdsaAes128Sha1: false ecdheEcdsaAes256GcmSha384: true ecdheEcdsaAes256Sha1: false ecdheRsaAes128GcmSha256: true ecdheRsaAes128Sha1: false ecdheRsaAes256GcmSha384: true ecdheRsaAes256Sha1: false ecdheEcdsaChacha20Poly1305: false ecdheRsaChacha20Poly1305: false dheRsaChacha20Poly1305: false tlsAes256GcmSha384: true tlsChacha20Poly1305Sha256: true tlsAes128GcmSha256: true trustStore: type: dnList: - issuer: commonName: countryName: localityName: organizationName: organizationUnit: state: subject: commonName: countryName: localityName: organizationName: organizationUnit: state: version: serialNumber: signatureAlgorithm: publicKeyAlgorithm: validity: notBefore: notAfter: certificateType: subjectAlternativeName: - - basicConstraints: certificateAuthority: keyUsage: - Key CertSign extendedKeyUsage: - OCSPstamping fileName: expirationDate: type: - id: name: keyStore: type: cn: san: - - fileName: alias: keyFileName: capathFileName: expirationDate: ciphers: aes128GcmSha256: false aes128Sha256: false aes256GcmSha384: false aes256Sha256: false dheRsaAes128Sha256: false dheRsaAes256GcmSha384: false dheRsaAes256Sha256: false ecdheEcdsaAes128GcmSha256: true ecdheEcdsaAes128Sha1: false ecdheEcdsaAes256GcmSha384: true ecdheEcdsaAes256Sha1: false ecdheRsaAes128GcmSha256: true ecdheRsaAes128Sha1: false ecdheRsaAes256GcmSha384: true ecdheRsaAes256Sha1: false ecdheEcdsaChacha20Poly1305: false ecdheRsaChacha20Poly1305: false dheRsaChacha20Poly1305: false tlsAes256GcmSha384: true tlsChacha20Poly1305Sha256: true tlsAes128GcmSha256: true trustStore: type: dnList: - issuer: commonName: countryName: localityName: organizationName: organizationUnit: state: subject: commonName: countryName: localityName: organizationName: organizationUnit: state: version: serialNumber: signatureAlgorithm: publicKeyAlgorithm: validity: notBefore: notAfter: certificateType: subjectAlternativeName: - - basicConstraints: certificateAuthority: keyUsage: - Key Encipherment extendedKeyUsage: - IP security tunnel termination fileName: expirationDate: type: '415': description: Unsupported Media Type headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: errors: - code: message: - code: message: '429': description: Too Many Requests headers: Content-Type: schema: type: string example: application/json Retry-After: schema: type: string example: content: application/json: schema: type: object example: message: errors: - code: message: - code: message: post: tags: - >- Management Center > Runtime Manager > Private Spaces (Cloudhub 2.0) > TLS Contexts summary: Create a TLS context description: create a TLS context requestBody: content: application/json: schema: type: object example: x-amf-examples: create-request-pem: name: test tlsConfig: keyStore: source: PEM certificate: |- -----BEGIN CERTIFICATE----- replace with encrypted data -----END CERTIFICATE----- key: |- -----BEGIN ENCRYPTED PRIVATE KEY----- replace with encrypted data -----END ENCRYPTED PRIVATE KEY----- keyPassphrase: password123 keyFileName: test.pem certificateFileName: certificateF.pem ciphers: aes128GcmSha256: true aes128Sha256: false aes256GcmSha384: false aes256Sha256: false dheRsaAes128Sha256: false dheRsaAes256GcmSha384: false dheRsaAes256Sha256: false ecdheEcdsaAes128GcmSha256: true ecdheEcdsaAes128Sha1: false ecdheEcdsaAes256GcmSha384: true ecdheEcdsaAes256Sha1: false ecdheRsaAes128GcmSha256: true ecdheRsaAes128Sha1: false ecdheRsaAes256GcmSha384: true ecdheRsaAes256Sha1: false ecdheEcdsaChacha20Poly1305: false ecdheRsaChacha20Poly1305: false dheRsaChacha20Poly1305: false tlsAes256GcmSha384: true tlsChacha20Poly1305Sha256: true tlsAes128GcmSha256: true create-request-jks: name: test tlsConfig: keyStore: source: JKS keystoreBase64: replace with base64 encoded keystore keyPassphrase: password123 storePassphrase: password123 alias: special keystoreFileName: special.jks ciphers: aes128GcmSha256: true aes128Sha256: false aes256GcmSha384: false aes256Sha256: false dheRsaAes128Sha256: false dheRsaAes256GcmSha384: false dheRsaAes256Sha256: false ecdheEcdsaAes128GcmSha256: true ecdheEcdsaAes128Sha1: false ecdheEcdsaAes256GcmSha384: true ecdheEcdsaAes256Sha1: false ecdheRsaAes128GcmSha256: true ecdheRsaAes128Sha1: false ecdheRsaAes256GcmSha384: true ecdheRsaAes256Sha1: false ecdheEcdsaChacha20Poly1305: false ecdheRsaChacha20Poly1305: false dheRsaChacha20Poly1305: false tlsAes256GcmSha384: true tlsChacha20Poly1305Sha256: true tlsAes128GcmSha256: true x-amf-union: - {} - {} parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: organization_id in: path schema: type: string required: true - name: private_space_id in: path schema: type: string required: true responses: '201': description: Created headers: Content-Type: schema: type: string example: application/json Location: schema: type: string example: ETag: schema: type: string example: content: application/json: schema: type: object example: id: name: keyStore: type: cn: san: - - fileName: alias: keyFileName: capathFileName: expirationDate: ciphers: aes128GcmSha256: false aes128Sha256: false aes256GcmSha384: false aes256Sha256: false dheRsaAes128Sha256: false dheRsaAes256GcmSha384: false dheRsaAes256Sha256: false ecdheEcdsaAes128GcmSha256: true ecdheEcdsaAes128Sha1: false ecdheEcdsaAes256GcmSha384: true ecdheEcdsaAes256Sha1: false ecdheRsaAes128GcmSha256: true ecdheRsaAes128Sha1: false ecdheRsaAes256GcmSha384: true ecdheRsaAes256Sha1: false ecdheEcdsaChacha20Poly1305: false ecdheRsaChacha20Poly1305: false dheRsaChacha20Poly1305: false tlsAes256GcmSha384: true tlsChacha20Poly1305Sha256: true tlsAes128GcmSha256: true trustStore: type: dnList: - issuer: commonName: countryName: localityName: organizationName: organizationUnit: state: subject: commonName: countryName: localityName: organizationName: organizationUnit: state: version: serialNumber: signatureAlgorithm: publicKeyAlgorithm: validity: notBefore: notAfter: certificateType: subjectAlternativeName: - - basicConstraints: certificateAuthority: keyUsage: - CRL Sign extendedKeyUsage: - IP security end system fileName: expirationDate: type: '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: errors: - code: message: - code: message: '409': description: Conflict content: text/plain: schema: type: string example: '' '415': description: Unsupported Media Type headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: errors: - code: message: - code: message: '429': description: Too Many Requests headers: Content-Type: schema: type: string example: application/json Retry-After: schema: type: string example: content: application/json: schema: type: object example: message: errors: - code: message: - code: message: /organizations/{organization_id}/privatespaces/{private_space_id}/tlsContexts/{tls_context_id}: delete: tags: - >- Management Center > Runtime Manager > Private Spaces (Cloudhub 2.0) > TLS Contexts summary: Delete the TLS context description: delete the TLS context parameters: - name: organization_id in: path schema: type: string required: true - name: private_space_id in: path schema: type: string required: true - name: tls_context_id in: path schema: type: string required: true responses: '200': description: OK content: text/plain: schema: type: string example: '' get: tags: - >- Management Center > Runtime Manager > Private Spaces (Cloudhub 2.0) > TLS Contexts summary: Get the TLS context description: get the TLS context parameters: - name: Accept in: header schema: type: string example: application/json - name: organization_id in: path schema: type: string required: true - name: private_space_id in: path schema: type: string required: true - name: tls_context_id in: path schema: type: string required: true responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: null '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: {} patch: tags: - >- Management Center > Runtime Manager > Private Spaces (Cloudhub 2.0) > TLS Contexts summary: Update an existing TLS context description: Update an existing TLS context requestBody: content: {} parameters: - name: Accept in: header schema: type: string example: application/json - name: organization_id in: path schema: type: string required: true - name: private_space_id in: path schema: type: string required: true - name: tls_context_id in: path schema: type: string required: true responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: id: name: keyStore: type: cn: san: - - fileName: alias: keyFileName: capathFileName: expirationDate: ciphers: aes128GcmSha256: false aes128Sha256: false aes256GcmSha384: false aes256Sha256: false dheRsaAes128Sha256: false dheRsaAes256GcmSha384: false dheRsaAes256Sha256: false ecdheEcdsaAes128GcmSha256: true ecdheEcdsaAes128Sha1: false ecdheEcdsaAes256GcmSha384: true ecdheEcdsaAes256Sha1: false ecdheRsaAes128GcmSha256: true ecdheRsaAes128Sha1: false ecdheRsaAes256GcmSha384: true ecdheRsaAes256Sha1: false ecdheEcdsaChacha20Poly1305: false ecdheRsaChacha20Poly1305: false dheRsaChacha20Poly1305: false tlsAes256GcmSha384: true tlsChacha20Poly1305Sha256: true tlsAes128GcmSha256: true trustStore: type: dnList: - issuer: commonName: countryName: localityName: organizationName: organizationUnit: state: subject: commonName: countryName: localityName: organizationName: organizationUnit: state: version: serialNumber: signatureAlgorithm: publicKeyAlgorithm: validity: notBefore: notAfter: certificateType: subjectAlternativeName: - - basicConstraints: certificateAuthority: keyUsage: - CRL Sign extendedKeyUsage: - IP security end system fileName: expirationDate: type: '202': description: Accepted headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: null /organizations/{organization_id}/privatespaces/{private_space_id}/connections: get: tags: - >- Management Center > Runtime Manager > Private Spaces (Cloudhub 2.0) > Connections summary: List Connections in Private Space description: get the list of Connections inside the private space. parameters: - name: Accept in: header schema: type: string example: application/json - name: organization_id in: path schema: type: string required: true - name: private_space_id in: path schema: type: string required: true responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json ETag: schema: type: string example: content: application/json: schema: type: object example: - id: name: vpns: - name: remoteIpAddress: vpnId: connectionId: connectionName: vpnConnectionStatus: remoteAsn: localAsn: - name: remoteIpAddress: vpnId: connectionId: connectionName: vpnConnectionStatus: remoteAsn: localAsn: - id: name: vpns: - name: remoteIpAddress: vpnId: connectionId: connectionName: vpnConnectionStatus: remoteAsn: localAsn: - name: remoteIpAddress: vpnId: connectionId: connectionName: vpnConnectionStatus: remoteAsn: localAsn: '415': description: Unsupported Media Type headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: errors: - code: message: - code: message: '429': description: Too Many Requests headers: Content-Type: schema: type: string example: application/json Retry-After: schema: type: string example: content: application/json: schema: type: object example: message: errors: - code: message: - code: message: post: tags: - >- Management Center > Runtime Manager > Private Spaces (Cloudhub 2.0) > Connections summary: Create Private Space Connection description: create a Private Space Connection requestBody: content: application/json: schema: type: object example: name: vpns: - name: remoteIpAddress: vpnId: connectionId: connectionName: vpnConnectionStatus: remoteAsn: localAsn: - name: remoteIpAddress: vpnId: connectionId: connectionName: vpnConnectionStatus: remoteAsn: localAsn: parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: organization_id in: path schema: type: string required: true - name: private_space_id in: path schema: type: string required: true responses: '201': description: Created headers: Content-Type: schema: type: string example: application/json Location: schema: type: string example: ETag: schema: type: string example: content: application/json: schema: type: object example: id: name: vpns: - name: remoteIpAddress: vpnId: connectionId: connectionName: vpnConnectionStatus: remoteAsn: localAsn: - name: remoteIpAddress: vpnId: connectionId: connectionName: vpnConnectionStatus: remoteAsn: localAsn: '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: errors: - code: message: - code: message: '409': description: Conflict content: text/plain: schema: type: string example: '' '415': description: Unsupported Media Type headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: errors: - code: message: - code: message: '429': description: Too Many Requests headers: Content-Type: schema: type: string example: application/json Retry-After: schema: type: string example: content: application/json: schema: type: object example: message: errors: - code: message: - code: message: /organizations/{organization_id}/privatespaces/{private_space_id}/connections/{connection_id}: delete: tags: - >- Management Center > Runtime Manager > Private Spaces (Cloudhub 2.0) > Connections summary: Delete Private Space Connection description: delete the Private Space Connection parameters: - name: organization_id in: path schema: type: string required: true - name: private_space_id in: path schema: type: string required: true - name: connection_id in: path schema: type: string required: true responses: '200': description: OK content: text/plain: schema: type: string example: '' get: tags: - >- Management Center > Runtime Manager > Private Spaces (Cloudhub 2.0) > Connections summary: Get Private Space Connection description: get the Private Space Connection parameters: - name: Accept in: header schema: type: string example: application/json - name: organization_id in: path schema: type: string required: true - name: private_space_id in: path schema: type: string required: true - name: connection_id in: path schema: type: string required: true responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: x-amf-examples: response: name: hello-connection vpns: - vpnId: 83d77850-04ee-4368-8122-192f760913de name: test-vpn-dev localAsn: 65001 remoteAsn: 65002 remoteIpAddress: 1.2.3.4 connectionStatus: available staticRoutes: [] vpnTunnels: [] vpnTunnelsConfig: [] - name: test-vpn-dev-bak vpnId: 83d77850-04ee-4368-8122-192f760913df localAsn: 65001 remoteAsn: 65002 remoteIpAddress: 1.2.3.5 connectionStatus: available staticRoutes: [] vpnTunnels: [] vpnTunnelsConfig: [] '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: {} patch: tags: - >- Management Center > Runtime Manager > Private Spaces (Cloudhub 2.0) > Connections summary: Update existing Private Space Connection description: Update existing Private Space Connection requestBody: content: application/json: schema: type: object example: id: name: parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: organization_id in: path schema: type: string required: true - name: private_space_id in: path schema: type: string required: true - name: connection_id in: path schema: type: string required: true responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: id: name: vpns: - name: remoteIpAddress: vpnId: connectionId: connectionName: vpnConnectionStatus: remoteAsn: localAsn: - name: remoteIpAddress: vpnId: connectionId: connectionName: vpnConnectionStatus: remoteAsn: localAsn: '202': description: Accepted headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: x-amf-examples: response: name: hello-connection vpns: - vpnId: 83d77850-04ee-4368-8122-192f760913de name: test-vpn-dev localAsn: 65001 remoteAsn: 65002 remoteIpAddress: 1.2.3.4 connectionStatus: available staticRoutes: [] vpnTunnels: [] vpnTunnelsConfig: [] - name: test-vpn-dev-bak vpnId: 83d77850-04ee-4368-8122-192f760913df localAsn: 65001 remoteAsn: 65002 remoteIpAddress: 1.2.3.5 connectionStatus: available staticRoutes: [] vpnTunnels: [] vpnTunnelsConfig: [] /organizations/{organization_id}/privatespaces/{private_space_id}/connections/vpns: post: tags: - >- Management Center > Runtime Manager > Private Spaces (Cloudhub 2.0) > Connections summary: Add VPN to existing Connection description: add a vpn to an existing connection. requestBody: content: {} parameters: - name: Accept in: header schema: type: string example: application/json - name: organization_id in: path schema: type: string required: true - name: private_space_id in: path schema: type: string required: true responses: '201': description: Created headers: Content-Type: schema: type: string example: application/json Location: schema: type: string example: ETag: schema: type: string example: content: application/json: schema: type: object example: id: name: vpns: - name: remoteIpAddress: vpnId: connectionId: connectionName: vpnConnectionStatus: remoteAsn: localAsn: - name: remoteIpAddress: vpnId: connectionId: connectionName: vpnConnectionStatus: remoteAsn: localAsn: '409': description: Conflict content: text/plain: schema: type: string example: '' /organizations/{organization_id}/privatespaces/{private_space_id}/connections/vpns/{vpn_id}: delete: tags: - >- Management Center > Runtime Manager > Private Spaces (Cloudhub 2.0) > Connections summary: Delete VPN from Connection description: delete a vpn from a connection. parameters: - name: organization_id in: path schema: type: string required: true - name: private_space_id in: path schema: type: string required: true - name: vpn_id in: path schema: type: string required: true responses: '200': description: OK content: text/plain: schema: type: string example: '' patch: tags: - >- Management Center > Runtime Manager > Private Spaces (Cloudhub 2.0) > Connections summary: Delete VPN from Connection description: delete a vpn from a connection. requestBody: content: application/json: schema: type: object example: id: remoteIpAddress: staticRoutes: [] vpnTunnels: [] name: remoteAsn: localAsn: parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: organization_id in: path schema: type: string required: true - name: private_space_id in: path schema: type: string required: true - name: vpn_id in: path schema: type: string required: true responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: id: remoteIpAddress: staticRoutes: [] vpnTunnels: [] name: remoteAsn: localAsn: /organizations/{organization_id}/privatespaces/{private_space_id}/connections/vpns/{vpn_id}/connectionGuide: get: tags: - >- Management Center > Runtime Manager > Private Spaces (Cloudhub 2.0) > Connections summary: Get VPN from Connection by ID parameters: - name: vendor in: query schema: type: string description: '(Required) ' example: - name: platform in: query schema: type: string description: '(Required) ' example: - name: software in: query schema: type: string description: '(Required) ' example: - name: organization_id in: path schema: type: string required: true - name: private_space_id in: path schema: type: string required: true - name: vpn_id in: path schema: type: string required: true responses: '200': description: OK content: text/plain: schema: type: string example: '' /organizations/{organization_id}/privatespaces: get: tags: - Management Center > Runtime Manager > Private Spaces (Cloudhub 2.0) summary: List Private Spaces in the organization description: get the list of Private Spaces in the organization. parameters: - name: Accept in: header schema: type: string example: application/json - name: organization_id in: path schema: type: string required: true responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json ETag: schema: type: string example: content: application/json: schema: type: object example: - id: name: organizationId: environments: type: businessGroups: - - network: region: vpcId: cidrBlock: 10.0.0.0/16 internalDns: dnsServers: [] specialDomains: [] inboundStaticIps: - - outboundStaticIps: - - dnsTarget: internalDnsTarget: firewallRules: - cidrBlock: protocol: fromPort: toPort: type: inbound - cidrBlock: protocol: fromPort: toPort: type: inbound ingressConfiguration: readResponseTimeout: 300 logs: portLogLevel: ERROR protocol: https-redirect deployment: status: lastSeenTimestamp: status: statusMessage: provisioning: status: message: region: managedFirewallRules: - cidrBlock: protocol: fromPort: toPort: type: inbound - cidrBlock: protocol: fromPort: toPort: type: inbound enableIAMRole: globalSpaceStatus: space: status: message: lastSeenTimeStamp: cluster: - infra: status: message: lastSeenTimeStamp: fabric: status: message: lastSeenTimeStamp: ingress: status: message: lastSeenTimeStamp: - infra: status: message: lastSeenTimeStamp: fabric: status: message: lastSeenTimeStamp: ingress: status: message: lastSeenTimeStamp: network: status: message: lastSeenTimeStamp: - id: name: organizationId: environments: type: businessGroups: - - network: region: vpcId: cidrBlock: 10.0.0.0/16 internalDns: dnsServers: [] specialDomains: [] inboundStaticIps: - - outboundStaticIps: - - dnsTarget: internalDnsTarget: firewallRules: - cidrBlock: protocol: fromPort: toPort: type: inbound - cidrBlock: protocol: fromPort: toPort: type: inbound ingressConfiguration: readResponseTimeout: 300 logs: portLogLevel: ERROR protocol: https-redirect deployment: status: lastSeenTimestamp: status: statusMessage: provisioning: status: message: region: managedFirewallRules: - cidrBlock: protocol: fromPort: toPort: type: inbound - cidrBlock: protocol: fromPort: toPort: type: inbound enableIAMRole: globalSpaceStatus: space: status: message: lastSeenTimeStamp: cluster: - infra: status: message: lastSeenTimeStamp: fabric: status: message: lastSeenTimeStamp: ingress: status: message: lastSeenTimeStamp: - infra: status: message: lastSeenTimeStamp: fabric: status: message: lastSeenTimeStamp: ingress: status: message: lastSeenTimeStamp: network: status: message: lastSeenTimeStamp: '415': description: Unsupported Media Type headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: errors: - code: message: - code: message: '429': description: Too Many Requests headers: Content-Type: schema: type: string example: application/json Retry-After: schema: type: string example: content: application/json: schema: type: object example: message: errors: - code: message: - code: message: post: tags: - Management Center > Runtime Manager > Private Spaces (Cloudhub 2.0) summary: Create Private Space description: create a Private Space requestBody: content: application/json: schema: type: object example: name: TestBy2Aug2023-AngelAlberici-UsEast2 environments: type: sandbox businessGroups: - 59995d29-ebe2-43d9-a52b-766683fd41a7 network: region: us-east-2 cidrBlock: 192.168.192.0/24 inboundStaticIps: - 13.58.69.47 - 3.137.72.80 - 3.142.18.12 outboundStaticIps: - 3.128.99.14 - 3.140.68.137 - 3.141.210.250 dnsTarget: 83j7jq.usa-e2.cloudhub.io internalDnsTarget: internal-83j7jq.usa-e2.cloudhub.io managedFirewallRules: - cidrBlock: 0.0.0.0/0 protocol: tcp fromPort: 80 toPort: 80 type: inbound - cidrBlock: 0.0.0.0/0 protocol: tcp fromPort: 443 toPort: 443 type: inbound - cidrBlock: 0.0.0.0/0 protocol: tcp fromPort: 0 toPort: 65535 type: outbound - cidrBlock: 0.0.0.0/0 protocol: tcp fromPort: 443 toPort: 443 type: outbound parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: organization_id in: path schema: type: string required: true responses: '201': description: Created headers: Content-Type: schema: type: string example: application/json Location: schema: type: string example: ETag: schema: type: string example: content: application/json: schema: type: object example: id: name: organizationId: environments: type: businessGroups: - - network: region: vpcId: cidrBlock: 10.0.0.0/16 internalDns: dnsServers: [] specialDomains: [] inboundStaticIps: - - outboundStaticIps: - - dnsTarget: internalDnsTarget: firewallRules: - cidrBlock: protocol: fromPort: toPort: type: inbound - cidrBlock: protocol: fromPort: toPort: type: inbound ingressConfiguration: readResponseTimeout: 300 logs: portLogLevel: ERROR protocol: https-redirect deployment: status: lastSeenTimestamp: status: statusMessage: provisioning: status: message: region: managedFirewallRules: - cidrBlock: protocol: fromPort: toPort: type: inbound - cidrBlock: protocol: fromPort: toPort: type: inbound enableIAMRole: globalSpaceStatus: space: status: message: lastSeenTimeStamp: cluster: - infra: status: message: lastSeenTimeStamp: fabric: status: message: lastSeenTimeStamp: ingress: status: message: lastSeenTimeStamp: - infra: status: message: lastSeenTimeStamp: fabric: status: message: lastSeenTimeStamp: ingress: status: message: lastSeenTimeStamp: network: status: message: lastSeenTimeStamp: '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: errors: - code: message: - code: message: '409': description: Conflict content: text/plain: schema: type: string example: '' '415': description: Unsupported Media Type headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: errors: - code: message: - code: message: '429': description: Too Many Requests headers: Content-Type: schema: type: string example: application/json Retry-After: schema: type: string example: content: application/json: schema: type: object example: message: errors: - code: message: - code: message: /organizations/{organization_id}/privatespaces/{private_space_id}/logs/ingress: get: tags: - Management Center > Runtime Manager > Private Spaces (Cloudhub 2.0) summary: Get Ingress logs in ascending order description: download ingress logs in ascending order parameters: - name: Accept in: header schema: type: string example: application/octet-stream - name: organization_id in: path schema: type: string required: true - name: private_space_id in: path schema: type: string required: true responses: '200': description: OK headers: Content-Type: schema: type: string example: application/octet-stream transfer-encoding: schema: type: string example: chunked content: text/plain: schema: type: string example: '{}' /organizations/{organization_id}/privatespaces/{private_space_id}/accounts: get: tags: - Management Center > Runtime Manager > Private Spaces (Cloudhub 2.0) summary: Get AWS account Id a string value description: get the AWS account Id a string value. parameters: - name: organization_id in: path schema: type: string required: true - name: private_space_id in: path schema: type: string required: true responses: '200': description: OK content: text/plain: schema: type: string example: '' /organizations/{organization_id}/privatespaces/{private_space_id}/iamroles: get: tags: - Management Center > Runtime Manager > Private Spaces (Cloudhub 2.0) summary: Get IAM roles associated with the Private Space description: get the IAM roles associated with the space. parameters: - name: Accept in: header schema: type: string example: application/json - name: organization_id in: path schema: type: string required: true - name: private_space_id in: path schema: type: string required: true responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: roles: - - organizationId: spaceId: message: /organizations/{organization_id}/privatespaces/{private_space_id}: delete: tags: - Management Center > Runtime Manager > Private Spaces (Cloudhub 2.0) summary: Delete Private Space description: delete the Private Space parameters: - name: organization_id in: path schema: type: string required: true - name: private_space_id in: path schema: type: string required: true responses: '200': description: OK content: text/plain: schema: type: string example: '' get: tags: - Management Center > Runtime Manager > Private Spaces (Cloudhub 2.0) summary: Get Private Space description: get the Private Space parameters: - name: Accept in: header schema: type: string example: application/json - name: organization_id in: path schema: type: string required: true - name: private_space_id in: path schema: type: string required: true responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: null '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: {} patch: tags: - Management Center > Runtime Manager > Private Spaces (Cloudhub 2.0) summary: Update existing Private Space description: Update existing Private Space requestBody: content: application/json: schema: type: object example: environments: type: businessGroups: - - network: region: vpcId: cidrBlock: 10.0.0.0/16 internalDns: dnsServers: [] specialDomains: [] firewallRules: - cidrBlock: protocol: fromPort: toPort: type: inbound - cidrBlock: protocol: fromPort: toPort: type: inbound logForwarding: anypointMonitoring: ingressConfiguration: readResponseTimeout: 300 logs: portLogLevel: ERROR protocol: https-redirect deployment: status: lastSeenTimestamp: managedFirewallRules: - cidrBlock: protocol: fromPort: toPort: type: inbound - cidrBlock: protocol: fromPort: toPort: type: inbound enableIAMRole: parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: organization_id in: path schema: type: string required: true - name: private_space_id in: path schema: type: string required: true responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: id: name: organizationId: environments: type: businessGroups: - - network: region: vpcId: cidrBlock: 10.0.0.0/16 internalDns: dnsServers: [] specialDomains: [] inboundStaticIps: - - outboundStaticIps: - - dnsTarget: internalDnsTarget: firewallRules: - cidrBlock: protocol: fromPort: toPort: type: inbound - cidrBlock: protocol: fromPort: toPort: type: inbound ingressConfiguration: readResponseTimeout: 300 logs: portLogLevel: ERROR protocol: https-redirect deployment: status: lastSeenTimestamp: status: statusMessage: provisioning: status: message: region: managedFirewallRules: - cidrBlock: protocol: fromPort: toPort: type: inbound - cidrBlock: protocol: fromPort: toPort: type: inbound enableIAMRole: globalSpaceStatus: space: status: message: lastSeenTimeStamp: cluster: - infra: status: message: lastSeenTimeStamp: fabric: status: message: lastSeenTimeStamp: ingress: status: message: lastSeenTimeStamp: - infra: status: message: lastSeenTimeStamp: fabric: status: message: lastSeenTimeStamp: ingress: status: message: lastSeenTimeStamp: network: status: message: lastSeenTimeStamp: '202': description: Accepted headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: null /organizations/{organization_id}/privatespaces/supportedVpnConfigs: get: tags: - Management Center > Runtime Manager > Private Spaces (Cloudhub 2.0) summary: Get supported VPN configs description: get supported vpn configs parameters: - name: organization_id in: path schema: type: string required: true responses: '200': description: OK content: text/plain: schema: type: string example: '' /organizations/{organization_id}/privatespaces/{private_space_id}/ports: get: tags: - Management Center > Runtime Manager > Private Spaces (Cloudhub 2.0) summary: Get next set of available ports description: Get the next set of available ports. parameters: - name: Accept in: header schema: type: string example: application/json - name: available in: query schema: type: boolean example: 'true' - name: count in: query schema: type: integer example: '10000' - name: organization_id in: path schema: type: string required: true - name: private_space_id in: path schema: type: string required: true responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: ports: - - '409': description: Conflict content: text/plain: schema: type: string example: '' /organizations/{organization_id}/transitgateways: get: tags: - Management Center > Runtime Manager > Transit Gateways (Cloudhub 2.0) summary: List TGW connections associated with an Organization description: get list of TGW connections assocated with an organization. parameters: - name: Accept in: header schema: type: string example: application/json - name: organization_id in: path schema: type: string required: true responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json ETag: schema: type: string example: content: application/json: schema: type: object example: - id: name: spec: resourceShare: id: account: region: spaceName: status: gateway: attachment: tgwResource: routes: - - - id: name: spec: resourceShare: id: account: region: spaceName: status: gateway: attachment: tgwResource: routes: - - '415': description: Unsupported Media Type headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: errors: - code: message: - code: message: '429': description: Too Many Requests headers: Content-Type: schema: type: string example: application/json Retry-After: schema: type: string example: content: application/json: schema: type: object example: message: errors: - code: message: - code: message: /organizations/{organization_id}/transitgateways/{transit_gateway_id}: delete: tags: - Management Center > Runtime Manager > Transit Gateways (Cloudhub 2.0) summary: Remove Transit gateway from an Organization description: Remove the Transit gateway from your Anypoint Platform organization parameters: - name: organization_id in: path schema: type: string required: true - name: transit_gateway_id in: path schema: type: string required: true responses: '200': description: OK content: text/plain: schema: type: string example: '' /organizations/{organization_id}/transitgateways/{transit_gateway_id}/routes: get: tags: - Management Center > Runtime Manager > Transit Gateways (Cloudhub 2.0) summary: Get TGW routes configured for a gateway description: get TGW routes configured for a gateway parameters: - name: organization_id in: path schema: type: string required: true - name: transit_gateway_id in: path schema: type: string required: true responses: '200': description: OK content: text/plain: schema: type: string example: '' /organizations/{organization_id}/targets/{target_id}: get: tags: - >- Management Center > Runtime Manager > Deployment Target (Cloudhub 2.0 : Not in use) summary: Get the target (Uncommon use) description: get the target parameters: - name: Accept in: header schema: type: string example: application/json - name: organization_id in: path schema: type: string required: true - name: target_id in: path schema: type: string required: true responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: id: name: version: type: runtimes: - type: versions: - baseVersion: tag: releaseDate: minimumTag: href: - baseVersion: tag: releaseDate: minimumTag: href: - type: versions: - baseVersion: tag: releaseDate: minimumTag: href: - baseVersion: tag: releaseDate: minimumTag: href: status: isAvailableForDeployments: nodes: - id: location: isAvailableForDeployments: availability: - id: location: isAvailableForDeployments: availability: region: environments: - - - - - - - - - - replicationStrategies: {} defaults: {} enhancedSecurity: featureFlags: {} /organizations/{organization_id}/targets: get: tags: - >- Management Center > Runtime Manager > Deployment Target (Cloudhub 2.0 : Not in use) summary: List target deployments within an organization (Uncommon use) description: get list of target deployments within an organization parameters: - name: Accept in: header schema: type: string example: application/json - name: organization_id in: path schema: type: string required: true responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json ETag: schema: type: string example: content: application/json: schema: type: object example: - id: name: version: type: runtimes: - type: versions: - baseVersion: tag: releaseDate: minimumTag: href: - baseVersion: tag: releaseDate: minimumTag: href: - type: versions: - baseVersion: tag: releaseDate: minimumTag: href: - baseVersion: tag: releaseDate: minimumTag: href: status: isAvailableForDeployments: nodes: - id: location: isAvailableForDeployments: availability: - id: location: isAvailableForDeployments: availability: region: environments: - - - - - - - - - - replicationStrategies: {} defaults: {} enhancedSecurity: featureFlags: {} - id: name: version: type: runtimes: - type: versions: - baseVersion: tag: releaseDate: minimumTag: href: - baseVersion: tag: releaseDate: minimumTag: href: - type: versions: - baseVersion: tag: releaseDate: minimumTag: href: - baseVersion: tag: releaseDate: minimumTag: href: status: isAvailableForDeployments: nodes: - id: location: isAvailableForDeployments: availability: - id: location: isAvailableForDeployments: availability: region: environments: - - - - - - - - - - replicationStrategies: {} defaults: {} enhancedSecurity: featureFlags: {} '415': description: Unsupported Media Type headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: errors: - code: message: - code: message: '429': description: Too Many Requests headers: Content-Type: schema: type: string example: application/json Retry-After: schema: type: string example: content: application/json: schema: type: object example: message: errors: - code: message: - code: message: /visualizer/api/v4/organizations/{organization_id}/users/{user_id}/settings: get: tags: - Management Center > Visualizer summary: Get settings for user parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' - name: organization_id in: path schema: type: string required: true - name: user_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /visualizer/api/v4/organizations/{organization_id}/applications-info: get: tags: - Management Center > Visualizer summary: Get application-info parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /visualizer/api/v4/organizations/{organization_id}/policy-templates: get: tags: - Management Center > Visualizer summary: Get policy-templates parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /secrets-manager/api/v1/organizations/{organization_id}/environments/{environment_id}/details/store: post: tags: - Management Center > Secret Manager > Keystores summary: Check certificate content requestBody: content: multipart/form-data: schema: type: object properties: type: type: string example: JKS file: type: string format: binary storePassphrase: type: string example: '!Q2w3e4r5' parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' - name: organization_id in: path schema: type: string required: true - name: environment_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /secrets-manager/api/v1/organizations/{organization_id}/environments/{environment_id}/secretGroups/{secretgroup_Id}/keystores: get: tags: - Management Center > Secret Manager > Keystores summary: Get keystores for secretgroup parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' - name: organization_id in: path schema: type: string required: true - name: environment_id in: path schema: type: string required: true - name: secretgroup_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} post: tags: - Management Center > Secret Manager > Keystores summary: Add standard keystore requestBody: content: multipart/form-data: schema: type: object properties: name: type: string example: khanamir type: type: string example: PEM certificate: type: string format: binary key: type: string format: binary keyPassphrase: type: integer example: '123456' parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' - name: organization_id in: path schema: type: string required: true - name: environment_id in: path schema: type: string required: true - name: secretgroup_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /secrets-manager/api/v1/organizations/{organization_id}/environments/{environment_id}/secretGroups/{secretgroup_Id}/keystores/{keystore_Id}: get: tags: - Management Center > Secret Manager > Keystores summary: Get single keystore by Id parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' - name: organization_id in: path schema: type: string required: true - name: environment_id in: path schema: type: string required: true - name: secretgroup_Id in: path schema: type: string required: true - name: keystore_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} put: tags: - Management Center > Secret Manager > Keystores summary: Change standard keystore requestBody: content: multipart/form-data: schema: type: object properties: name: type: string example: khanamir type: type: string example: PEM certificate: type: string format: binary key: type: string format: binary keyPassphrase: type: integer example: '123456' parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' - name: organization_id in: path schema: type: string required: true - name: environment_id in: path schema: type: string required: true - name: secretgroup_Id in: path schema: type: string required: true - name: keystore_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /secrets-manager/api/v1/organizations/{organization_id}/environments/{environment_id}/secretGroups/{secretgroup_Id}/truststores: get: tags: - Management Center > Secret Manager > Truststore summary: Get truststores for secretgroup parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' - name: organization_id in: path schema: type: string required: true - name: environment_id in: path schema: type: string required: true - name: secretgroup_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /secrets-manager/api/v1/organizations/{organization_id}/environments/{environment_id}/secretGroups/{secretgroup_Id}/certificates: get: tags: - Management Center > Secret Manager > Certificates summary: Get certificates for secretgroup parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' - name: organization_id in: path schema: type: string required: true - name: environment_id in: path schema: type: string required: true - name: secretgroup_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /secrets-manager/api/v1/organizations/{organization_id}/environments/{environment_id}/secretGroups/{secretgroup_Id}/certificatePinsets: get: tags: - Management Center > Secret Manager > Certificate Pinset summary: Get certificatepinsets for secretgroup parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' - name: organization_id in: path schema: type: string required: true - name: environment_id in: path schema: type: string required: true - name: secretgroup_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /secrets-manager/api/v1/organizations/{organization_id}/environments/{environment_id}/secretGroups/{secretgroup_Id}/sharedSecrets: get: tags: - Management Center > Secret Manager > Shared Secret summary: Get sharedsecrets for secretgroup parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' - name: organization_id in: path schema: type: string required: true - name: environment_id in: path schema: type: string required: true - name: secretgroup_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /secrets-manager/api/v1/organizations/{organization_id}/environments/{environment_id}/secretGroups/{secretgroup_Id}/crlDistributorConfigs: get: tags: - Management Center > Secret Manager > CRL Distributor Config summary: Get crlDistributorConfigs for secretgroup parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' - name: organization_id in: path schema: type: string required: true - name: environment_id in: path schema: type: string required: true - name: secretgroup_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /secrets-manager/api/v1/organizations/{organization_id}/environments/{environment_id}/secretGroups/{secretgroup_Id}/tlsContexts: get: tags: - Management Center > Secret Manager > TSL Context summary: Get tlsContexts for secretgroup parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' - name: organization_id in: path schema: type: string required: true - name: environment_id in: path schema: type: string required: true - name: secretgroup_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /secrets-manager/api/v1/organizations/{organization_id}/environments/{environment_id}/secretGroups: get: tags: - Management Center > Secret Manager summary: Get all secretgroups parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' - name: organization_id in: path schema: type: string required: true - name: environment_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} post: tags: - Management Center > Secret Manager summary: Create a secretgroup requestBody: content: application/json: schema: type: object example: name: test22 downloadable: true parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' - name: organization_id in: path schema: type: string required: true - name: environment_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /secrets-manager/api/v1/organizations/{organization_id}/environments/{environment_id}/secretGroups/{secretgroup_Id}: get: tags: - Management Center > Secret Manager summary: Get single secretgroup parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' - name: organization_id in: path schema: type: string required: true - name: environment_id in: path schema: type: string required: true - name: secretgroup_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} delete: tags: - Management Center > Secret Manager summary: Delete single secretgroup parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' - name: force in: query schema: type: boolean example: 'true' - name: organization_id in: path schema: type: string required: true - name: environment_id in: path schema: type: string required: true - name: secretgroup_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} patch: tags: - Management Center > Secret Manager summary: Rename secretgroup requestBody: content: application/json: schema: type: object example: name: test32 downloadable: true parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' - name: organization_id in: path schema: type: string required: true - name: environment_id in: path schema: type: string required: true - name: secretgroup_Id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /apimanager/xapi/v1/organizations/{organization_id}/exchange-policy-templates: get: tags: - Management Center > Automated Policies summary: Get exchange policy-templates for environment parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: environmentId in: query schema: type: string example: '{{environment_id}}' - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /apimanager/xapi/v1/organizations/{organization_id}/automated-policies: get: tags: - Management Center > Automated Policies summary: Get exchange automated policies for environment parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: environmentId in: query schema: type: string example: '{{environment_id}}' - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /apimanager/api/v1/organizations/{organization_id}/automated-policies: post: tags: - Management Center > Automated Policies summary: Add automated policies (example spike-control) requestBody: content: application/json: schema: type: object example: configurationData: maximumRequests: 1 timePeriodInMilliseconds: 1000 delayTimeInMillis: 1000 delayAttempts: 1 queuingLimit: 5 exposeHeaders: false id: null pointcutData: null ruleOfApplication: environmentId: '{{environment_id}}' organizationId: '{{organization_id}}' range: from: 4.1.1 groupId: 68ef9520-24e9-4cf2-b2f5-620025690913 assetId: spike-control assetVersion: 1.1.5 parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: organization_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /organizations/{organization}/environments/{environment}/{entityType}/{entityID}/{fileType}/{year}/{month}/{dayOfMonth}: get: tags: - >- Management Center > Anypoint Monitoring > Metric data for APIs > {organization}/environments > {environment} > {entity Type} > {entity ID} > {file Type} > {year} > {month} > {day Of Month} summary: >- /organizations/:organization/environments/:environment/:entityType/:entityID/:fileType/:year/:month/:dayOfMonth description: > Returns a list of data files under this node with each file containing archived metric data. parameters: - name: organization in: path schema: type: string required: true description: '(Required) ' example: aute reprehenderit Lorem - name: environment in: path schema: type: string required: true description: '(Required) ' example: aute reprehenderit Lorem - name: entityType in: path schema: type: string required: true description: '(Required) ' example: applications - name: entityID in: path schema: type: string required: true description: '(Required) ' example: aute reprehenderit Lorem - name: fileType in: path schema: type: string required: true description: '(Required) ' example: path - name: year in: path schema: type: integer required: true description: '(Required) ' example: '4236' - name: month in: path schema: type: integer required: true description: '(Required) ' example: '12' - name: dayOfMonth in: path schema: type: integer required: true description: '(Required) ' example: '08' responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: resources: - id: >- 312bc026-2f5d-49bc-ae9f-5940cf4ad9a6.2013-04-18T10.00.tag_worker0.part0.txt time: '2016-02-28T16:41:41.090Z' size: 125423 - id: >- 312bc026-2f5d-49bc-ae9f-5940cf4ad9a6.2013-04-18T10.00.tag_worker0.part0.txt time: '2016-02-28T16:41:41.090Z' size: 125423 '429': description: Too Many Requests headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '504': description: Gateway Timeout headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /organizations/{organization}/environments/{environment}/{entityType}/{entityID}/{fileType}/{year}/{month}/{dayOfMonth}/{fileName}: get: tags: - >- Management Center > Anypoint Monitoring > Metric data for APIs > {organization}/environments > {environment} > {entity Type} > {entity ID} > {file Type} > {year} > {month} > {day Of Month} summary: >- /organizations/:organization/environments/:environment/:entityType/:entityID/:fileType/:year/:month/:dayOfMonth/:fileName description: >- Retrieve the contents of the given data file. A data file contains either metric data. parameters: - name: organization in: path schema: type: string required: true description: '(Required) ' example: aute reprehenderit Lorem - name: environment in: path schema: type: string required: true description: '(Required) ' example: aute reprehenderit Lorem - name: entityType in: path schema: type: string required: true description: '(Required) ' example: applications - name: entityID in: path schema: type: string required: true description: '(Required) ' example: aute reprehenderit Lorem - name: fileType in: path schema: type: string required: true description: '(Required) ' example: path - name: year in: path schema: type: integer required: true description: '(Required) ' example: '4236' - name: month in: path schema: type: integer required: true description: '(Required) ' example: '12' - name: dayOfMonth in: path schema: type: integer required: true description: '(Required) ' example: '08' - name: fileName in: path schema: type: string required: true description: '(Required) ' example: aute reprehenderit Lorem responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: voluptate laborum '404': description: Not Found headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /organizations/{organization}/environments/{environment}/{entityType}/{entityID}/{fileType}/{year}/{month}: get: tags: - >- Management Center > Anypoint Monitoring > Metric data for APIs > {organization}/environments > {environment} > {entity Type} > {entity ID} > {file Type} > {year} > {month} summary: >- /organizations/:organization/environments/:environment/:entityType/:entityID/:fileType/:year/:month description: > Returns a list of day identifiers for the days that have archived data. If this path contains no data, then an empty list is returned. parameters: - name: organization in: path schema: type: string required: true description: '(Required) ' example: aute reprehenderit Lorem - name: environment in: path schema: type: string required: true description: '(Required) ' example: aute reprehenderit Lorem - name: entityType in: path schema: type: string required: true description: '(Required) ' example: applications - name: entityID in: path schema: type: string required: true description: '(Required) ' example: aute reprehenderit Lorem - name: fileType in: path schema: type: string required: true description: '(Required) ' example: path - name: year in: path schema: type: integer required: true description: '(Required) ' example: '4236' - name: month in: path schema: type: integer required: true description: '(Required) ' example: '12' responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: resources: - id: '09' - id: '19' '429': description: Too Many Requests headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '504': description: Gateway Timeout headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /organizations/{organization}/environments/{environment}/{entityType}/{entityID}/{fileType}/{year}: get: tags: - >- Management Center > Anypoint Monitoring > Metric data for APIs > {organization}/environments > {environment} > {entity Type} > {entity ID} > {file Type} > {year} summary: >- /organizations/:organization/environments/:environment/:entityType/:entityID/:fileType/:year description: > Returns a list of month identifiers for the months that have archived data. If this path contains no data, then an empty list is returned. parameters: - name: organization in: path schema: type: string required: true description: '(Required) ' example: aute reprehenderit Lorem - name: environment in: path schema: type: string required: true description: '(Required) ' example: aute reprehenderit Lorem - name: entityType in: path schema: type: string required: true description: '(Required) ' example: applications - name: entityID in: path schema: type: string required: true description: '(Required) ' example: aute reprehenderit Lorem - name: fileType in: path schema: type: string required: true description: '(Required) ' example: path - name: year in: path schema: type: integer required: true description: '(Required) ' example: '4236' responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: resources: - id: '07' - id: '03' '429': description: Too Many Requests headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '504': description: Gateway Timeout headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /organizations/{organization}/environments/{environment}/{entityType}/{entityID}/{fileType}: get: tags: - >- Management Center > Anypoint Monitoring > Metric data for APIs > {organization}/environments > {environment} > {entity Type} > {entity ID} > {file Type} summary: >- /organizations/:organization/environments/:environment/:entityType/:entityID/:fileType description: > Returns a list of year identifiers for the years that have archived data. If this path contains no data, then an empty list is returned. parameters: - name: organization in: path schema: type: string required: true description: '(Required) ' example: aute reprehenderit Lorem - name: environment in: path schema: type: string required: true description: '(Required) ' example: aute reprehenderit Lorem - name: entityType in: path schema: type: string required: true description: '(Required) ' example: applications - name: entityID in: path schema: type: string required: true description: '(Required) ' example: aute reprehenderit Lorem - name: fileType in: path schema: type: string required: true description: '(Required) ' example: path responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: resources: - id: 2019 - id: 2020 '429': description: Too Many Requests headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '504': description: Gateway Timeout headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /organizations/{organization}/environments/{environment}/{entityType}/{entityID}: get: tags: - >- Management Center > Anypoint Monitoring > Metric data for APIs > {organization}/environments > {environment} > {entity Type} > {entity ID} summary: >- /organizations/:organization/environments/:environment/:entityType/:entityID description: > Returns a list of file type identifiers for the file types that have archived data. If this path contains no data, then an empty list is returned. parameters: - name: organization in: path schema: type: string required: true description: '(Required) ' example: aute reprehenderit Lorem - name: environment in: path schema: type: string required: true description: '(Required) ' example: aute reprehenderit Lorem - name: entityType in: path schema: type: string required: true description: '(Required) ' example: applications - name: entityID in: path schema: type: string required: true description: '(Required) ' example: aute reprehenderit Lorem responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: resources: - id: ip - id: ip '429': description: Too Many Requests headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '504': description: Gateway Timeout headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /organizations/{organization}/environments/{environment}/{entityType}: get: tags: - >- Management Center > Anypoint Monitoring > Metric data for APIs > {organization}/environments > {environment} > {entity Type} summary: /organizations/:organization/environments/:environment/:entityType description: > Returns a list of entity identifiers for the entities that have archived data. If this path contains no data, then an empty list is returned. parameters: - name: organization in: path schema: type: string required: true description: '(Required) ' example: aute reprehenderit Lorem - name: environment in: path schema: type: string required: true description: '(Required) ' example: aute reprehenderit Lorem - name: entityType in: path schema: type: string required: true description: '(Required) ' example: applications responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: resources: - id: cupida - id: in non aute '429': description: Too Many Requests headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '504': description: Gateway Timeout headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /organizations/{organization}/environments/{environment}: get: tags: - >- Management Center > Anypoint Monitoring > Metric data for APIs > {organization}/environments > {environment} summary: /organizations/:organization/environments/:environment description: > Returns a list of entity type identifiers for the entity types that have archived data. If this path contains no data, then an empty list is returned. parameters: - name: organization in: path schema: type: string required: true description: '(Required) ' example: aute reprehenderit Lorem - name: environment in: path schema: type: string required: true description: '(Required) ' example: aute reprehenderit Lorem responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: resources: - id: apis - id: apis '429': description: Too Many Requests headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '504': description: Gateway Timeout headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /organizations/{organization_id}/environments: get: tags: - >- Management Center > Anypoint Monitoring > Metric data for APIs > {organization}/environments summary: /organizations/:organization/environments description: > Returns a list of environment identifiers for the environments that have archived data. If this path contains no data, then an empty list is returned. parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' - name: organization_id in: path schema: type: string required: true responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: resources: - id: proident aute - id: in nisi adipisicing enim '429': description: Too Many Requests headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '504': description: Gateway Timeout headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /monitoring/archive/api/v1/organizations: get: tags: - Management Center > Anypoint Monitoring > Metric data for APIs summary: /organizations description: > Returns a list of organization identifiers for the organizations that have archived data. If this path contains no data, then an empty list is returned. parameters: - name: Authorization in: header schema: type: string example: Bearer {{token}} - name: X-ANYPNT-ORG-ID in: header schema: type: string example: '{{organization_id}}' - name: X-ANYPNT-ENV-ID in: header schema: type: string example: '{{environment_id}}' responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: resources: - id: in incididu - id: cillum culpa '429': description: Too Many Requests headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '504': description: Gateway Timeout headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: ''