MuleSoft Anypoint Platform Management API

openapi: 3.1.0
info:
  title: MuleSoft Anypoint Platform API
  description: >-
    The Anypoint Platform API provides programmatic access to manage
    organizations, environments, and applications within the MuleSoft Anypoint
    Platform. It enables automation of platform administration tasks including
    creating and configuring organizations and business groups, managing
    deployment environments, and controlling the lifecycle of Mule applications
    across CloudHub, Runtime Fabric, and hybrid deployment targets.
  version: 1.0.0
  contact:
    name: MuleSoft Support
    url: https://help.mulesoft.com/s/support
  termsOfService: https://www.mulesoft.com/legal/terms/EULA
  license:
    name: MuleSoft EULA
    url: https://www.mulesoft.com/legal/terms/EULA
externalDocs:
  description: Anypoint Platform API Documentation
  url: https://docs.mulesoft.com/access-management/
servers:
- url: https://anypoint.mulesoft.com
  description: Anypoint Platform US Control Plane
- url: https://eu1.anypoint.mulesoft.com
  description: Anypoint Platform EU Control Plane
tags:
- name: Applications
  description: >-
    Manage Mule applications deployed to CloudHub, Runtime Fabric, or hybrid
    targets. Includes operations for deploying, starting, stopping, and
    monitoring application instances.
- name: Environments
  description: >-
    Manage deployment environments within an organization. Environments
    provide isolated contexts for deploying and running Mule applications,
    such as Design, Sandbox, and Production.
- name: Organizations
  description: >-
    Manage organizations and business groups within the Anypoint Platform.
    Organizations are the top-level containers for all platform resources
    including environments, users, and applications.
security:
- bearerAuth: []
paths:
  /accounts/api/organizations:
    get:
      operationId: listOrganizations
      summary: Mulesoft List Organizations
      description: >-
        Retrieves a list of organizations accessible to the authenticated user,
        including the root organization and any business groups.
      tags:
      - Organizations
      responses:
        '200':
          description: List of organizations retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Organization'
              examples:
                Listorganizations200Example:
                  summary: Default listOrganizations 200 response
                  x-microcks-default: true
                  value:
                    data:
                    - id: abc123
                      name: Example Title
                      createdAt: '2026-01-15T10:30:00Z'
                      updatedAt: '2026-01-15T10:30:00Z'
                      ownerId: '500123'
                      clientId: '500123'
                      idprovider_id: '500123'
                      isFederated: true
                      parentOrganizationIds:
                      - {}
                      subOrganizationIds:
                      - {}
                      tenantOrganizationIds:
                      - {}
                      mfaRequired: true
                      isAutomaticAdminPromotionExempt: true
                      domain: example_value
                      isMaster: true
                      environments:
                      - {}
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /accounts/api/organizations/{orgId}:
    get:
      operationId: getOrganization
      summary: Mulesoft Get Organization Details
      description: >-
        Retrieves detailed information about a specific organization, including
        its name, owner, entitlements, and associated business groups.
      tags:
      - Organizations
      parameters:
      - $ref: '#/components/parameters/OrgId'
      responses:
        '200':
          description: Organization details retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Organization'
              examples:
                Getorganization200Example:
                  summary: Default getOrganization 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    createdAt: '2026-01-15T10:30:00Z'
                    updatedAt: '2026-01-15T10:30:00Z'
                    ownerId: '500123'
                    clientId: '500123'
                    idprovider_id: '500123'
                    isFederated: true
                    parentOrganizationIds:
                    - example_value
                    subOrganizationIds:
                    - example_value
                    tenantOrganizationIds:
                    - example_value
                    mfaRequired: true
                    isAutomaticAdminPromotionExempt: true
                    domain: example_value
                    isMaster: true
                    subscription:
                      category: example_value
                      type: example_value
                      expiration: '2026-01-15T10:30:00Z'
                    entitlements:
                      createEnvironments: true
                      globalDeployment: true
                      createSubOrgs: true
                    environments:
                    - id: abc123
                      name: Example Title
                      organizationId: '500123'
                      isProduction: true
                      type: design
                      clientId: '500123'
                      createdAt: '2026-01-15T10:30:00Z'
                      updatedAt: '2026-01-15T10:30:00Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: updateOrganization
      summary: Mulesoft Update Organization
      description: >-
        Updates the properties of an existing organization, such as its name,
        session timeout, or entitlement settings.
      tags:
      - Organizations
      parameters:
      - $ref: '#/components/parameters/OrgId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrganizationUpdate'
            examples:
              UpdateorganizationRequestExample:
                summary: Default updateOrganization request
                x-microcks-default: true
                value:
                  name: Example Title
                  ownerId: '500123'
                  sessionTimeout: 10
                  mfaRequired: true
      responses:
        '200':
          description: Organization updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Organization'
              examples:
                Updateorganization200Example:
                  summary: Default updateOrganization 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    createdAt: '2026-01-15T10:30:00Z'
                    updatedAt: '2026-01-15T10:30:00Z'
                    ownerId: '500123'
                    clientId: '500123'
                    idprovider_id: '500123'
                    isFederated: true
                    parentOrganizationIds:
                    - example_value
                    subOrganizationIds:
                    - example_value
                    tenantOrganizationIds:
                    - example_value
                    mfaRequired: true
                    isAutomaticAdminPromotionExempt: true
                    domain: example_value
                    isMaster: true
                    subscription:
                      category: example_value
                      type: example_value
                      expiration: '2026-01-15T10:30:00Z'
                    entitlements:
                      createEnvironments: true
                      globalDeployment: true
                      createSubOrgs: true
                    environments:
                    - id: abc123
                      name: Example Title
                      organizationId: '500123'
                      isProduction: true
                      type: design
                      clientId: '500123'
                      createdAt: '2026-01-15T10:30:00Z'
                      updatedAt: '2026-01-15T10:30:00Z'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteOrganization
      summary: Mulesoft Delete Organization
      description: >-
        Deletes a business group. The root organization cannot be deleted.
        All environments and resources within the business group are removed.
      tags:
      - Organizations
      parameters:
      - $ref: '#/components/parameters/OrgId'
      responses:
        '204':
          description: Organization deleted successfully
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /accounts/api/organizations/{orgId}/environments:
    get:
      operationId: listEnvironments
      summary: Mulesoft List Environments
      description: >-
        Retrieves all environments within the specified organization. Each
        environment represents an isolated deployment target such as Design,
        Sandbox, or Production.
      tags:
      - Environments
      parameters:
      - $ref: '#/components/parameters/OrgId'
      responses:
        '200':
          description: List of environments retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Environment'
                  total:
                    type: integer
                    description: Total number of environments
              examples:
                Listenvironments200Example:
                  summary: Default listEnvironments 200 response
                  x-microcks-default: true
                  value:
                    data:
                    - id: abc123
                      name: Example Title
                      organizationId: '500123'
                      isProduction: true
                      type: design
                      clientId: '500123'
                      createdAt: '2026-01-15T10:30:00Z'
                      updatedAt: '2026-01-15T10:30:00Z'
                    total: 10
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createEnvironment
      summary: Mulesoft Create Environment
      description: >-
        Creates a new environment within the specified organization. The
        environment type determines its purpose and available features.
      tags:
      - Environments
      parameters:
      - $ref: '#/components/parameters/OrgId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnvironmentCreate'
            examples:
              CreateenvironmentRequestExample:
                summary: Default createEnvironment request
                x-microcks-default: true
                value:
                  name: Example Title
                  type: design
      responses:
        '201':
          description: Environment created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Environment'
              examples:
                Createenvironment201Example:
                  summary: Default createEnvironment 201 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    organizationId: '500123'
                    isProduction: true
                    type: design
                    clientId: '500123'
                    createdAt: '2026-01-15T10:30:00Z'
                    updatedAt: '2026-01-15T10:30:00Z'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '409':
          description: Environment with this name already exists
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /accounts/api/organizations/{orgId}/environments/{envId}:
    get:
      operationId: getEnvironment
      summary: Mulesoft Get Environment Details
      description: >-
        Retrieves detailed information about a specific environment, including
        its type, client ID, and configuration settings.
      tags:
      - Environments
      parameters:
      - $ref: '#/components/parameters/OrgId'
      - $ref: '#/components/parameters/EnvId'
      responses:
        '200':
          description: Environment details retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Environment'
              examples:
                Getenvironment200Example:
                  summary: Default getEnvironment 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    organizationId: '500123'
                    isProduction: true
                    type: design
                    clientId: '500123'
                    createdAt: '2026-01-15T10:30:00Z'
                    updatedAt: '2026-01-15T10:30:00Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: updateEnvironment
      summary: Mulesoft Update Environment
      description: >-
        Updates the properties of an existing environment, such as its name
        or type classification.
      tags:
      - Environments
      parameters:
      - $ref: '#/components/parameters/OrgId'
      - $ref: '#/components/parameters/EnvId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnvironmentUpdate'
            examples:
              UpdateenvironmentRequestExample:
                summary: Default updateEnvironment request
                x-microcks-default: true
                value:
                  name: Example Title
                  type: design
      responses:
        '200':
          description: Environment updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Environment'
              examples:
                Updateenvironment200Example:
                  summary: Default updateEnvironment 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    organizationId: '500123'
                    isProduction: true
                    type: design
                    clientId: '500123'
                    createdAt: '2026-01-15T10:30:00Z'
                    updatedAt: '2026-01-15T10:30:00Z'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteEnvironment
      summary: Mulesoft Delete Environment
      description: >-
        Deletes an environment and all resources deployed within it. Production
        environments may require additional confirmation.
      tags:
      - Environments
      parameters:
      - $ref: '#/components/parameters/OrgId'
      - $ref: '#/components/parameters/EnvId'
      responses:
        '204':
          description: Environment deleted successfully
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /cloudhub/api/v2/applications:
    get:
      operationId: listApplications
      summary: Mulesoft List Applications
      description: >-
        Retrieves a list of all Mule applications deployed to CloudHub within
        the current environment. Returns application metadata, deployment
        status, and runtime information.
      tags:
      - Applications
      parameters:
      - name: X-ANYPNT-ENV-ID
        in: header
        required: true
        description: The environment ID to list applications from
        schema:
          type: string
          format: uuid
        example: '500123'
      - name: X-ANYPNT-ORG-ID
        in: header
        required: true
        description: The organization ID
        schema:
          type: string
          format: uuid
        example: '500123'
      responses:
        '200':
          description: List of applications retrieved successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Application'
              examples:
                Listapplications200Example:
                  summary: Default listApplications 200 response
                  x-microcks-default: true
                  value:
                  - domain: example_value
                    fullDomain: example_value
                    status: STARTED
                    description: A sample description.
                    region: example_value
                    muleVersion:
                      version: example_value
                      updateId: '500123'
                      endOfSupportDate: '2026-01-15'
                    workers:
                      amount: 10
                      type: {}
                    properties: example_value
                    lastUpdateTime: 10
                    fileName: example_value
                    monitoringEnabled: true
                    monitoringAutoRestart: true
                    staticIPsEnabled: true
                    persistentQueues: true
                    persistentQueuesEncrypted: true
                    objectStoreV1: true
                    loggingNgEnabled: true
                    trackingSettings:
                      trackingLevel: DISABLED
                    vpnId: '500123'
                    vpnConfig:
                      vpnId: '500123'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createApplication
      summary: Mulesoft Create Application
      description: >-
        Deploys a new Mule application to CloudHub. The application
        configuration includes the runtime version, worker size, number of
        workers, and application properties.
      tags:
      - Applications
      parameters:
      - name: X-ANYPNT-ENV-ID
        in: header
        required: true
        description: The environment ID to deploy to
        schema:
          type: string
          format: uuid
        example: '500123'
      - name: X-ANYPNT-ORG-ID
        in: header
        required: true
        description: The organization ID
        schema:
          type: string
          format: uuid
        example: '500123'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationCreate'
            examples:
              CreateapplicationRequestExample:
                summary: Default createApplication request
                x-microcks-default: true
                value:
                  domain: example_value
                  muleVersion:
                    version: example_value
                  region: example_value
                  workers:
                    amount: 10
                    type:
                      name: Micro
                      weight: 0.1
                      cpu: example_value
                      memory: example_value
                  properties: example_value
                  monitoringAutoRestart: true
                  persistentQueues: true
                  staticIPsEnabled: true
                  loggingNgEnabled: true
      responses:
        '200':
          description: Application created and deployment initiated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application'
              examples:
                Createapplication200Example:
                  summary: Default createApplication 200 response
                  x-microcks-default: true
                  value:
                    domain: example_value
                    fullDomain: example_value
                    status: STARTED
                    description: A sample description.
                    region: example_value
                    muleVersion:
                      version: example_value
                      updateId: '500123'
                      endOfSupportDate: '2026-01-15'
                    workers:
                      amount: 10
                      type:
                        name: Micro
                        weight: 0.1
                        cpu: example_value
                        memory: example_value
                    properties: example_value
                    lastUpdateTime: 10
                    fileName: example_value
                    monitoringEnabled: true
                    monitoringAutoRestart: true
                    staticIPsEnabled: true
                    persistentQueues: true
                    persistentQueuesEncrypted: true
                    objectStoreV1: true
                    loggingNgEnabled: true
                    trackingSettings:
                      trackingLevel: DISABLED
                    vpnId: '500123'
                    vpnConfig:
                      vpnId: '500123'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '409':
          description: Application with this domain already exists
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /cloudhub/api/v2/applications/{domain}:
    get:
      operationId: getApplication
      summary: Mulesoft Get Application Details
      description: >-
        Retrieves detailed information about a specific CloudHub application,
        including its deployment status, runtime version, worker
        configuration, and application properties.
      tags:
      - Applications
      parameters:
      - $ref: '#/components/parameters/Domain'
      - name: X-ANYPNT-ENV-ID
        in: header
        required: true
        description: The environment ID
        schema:
          type: string
          format: uuid
        example: '500123'
      - name: X-ANYPNT-ORG-ID
        in: header
        required: true
        description: The organization ID
        schema:
          type: string
          format: uuid
        example: '500123'
      responses:
        '200':
          description: Application details retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application'
              examples:
                Getapplication200Example:
                  summary: Default getApplication 200 response
                  x-microcks-default: true
                  value:
                    domain: example_value
                    fullDomain: example_value
                    status: STARTED
                    description: A sample description.
                    region: example_value
                    muleVersion:
                      version: example_value
                      updateId: '500123'
                      endOfSupportDate: '2026-01-15'
                    workers:
                      amount: 10
                      type:
                        name: Micro
                        weight: 0.1
                        cpu: example_value
                        memory: example_value
                    properties: example_value
                    lastUpdateTime: 10
                    fileName: example_value
                    monitoringEnabled: true
                    monitoringAutoRestart: true
                    staticIPsEnabled: true
                    persistentQueues: true
                    persistentQueuesEncrypted: true
                    objectStoreV1: true
                    loggingNgEnabled: true
                    trackingSettings:
                      trackingLevel: DISABLED
                    vpnId: '500123'
                    vpnConfig:
                      vpnId: '500123'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: updateApplication
      summary: Mulesoft Update Application
      description: >-
        Updates the configuration of an existing CloudHub application. Can be
        used to change runtime version, worker configuration, properties,
        or redeploy with a new application archive.
      tags:
      - Applications
      parameters:
      - $ref: '#/components/parameters/Domain'
      - name: X-ANYPNT-ENV-ID
        in: header
        required: true
        description: The environment ID
        schema:
          type: string
          format: uuid
        example: '500123'
      - name: X-ANYPNT-ORG-ID
        in: header
        required: true
        description: The organization ID
        schema:
          type: string
          format: uuid
        example: '500123'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationUpdate'
            examples:
              UpdateapplicationRequestExample:
                summary: Default updateApplication request
                x-microcks-default: true
                value:
                  muleVersion:
                    version: example_value
                  workers:
                    amount: 10
                    type:
                      name: Micro
                      weight: 0.1
                      cpu: example_value
                      memory: example_value
                  properties: example_value
                  monitoringAutoRestart: true
                  region: example_value
                  staticIPsEnabled: true
                  loggingNgEnabled: true
                  persistentQueues: true
      responses:
        '200':
          description: Application updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application'
              examples:
                Updateapplication200Example:
                  summary: Default updateApplication 200 response
                  x-microcks-default: true
                  value:
                    domain: example_value
                    fullDomain: example_value
                    status: STARTED
                    description: A sample description.
                    region: example_value
                    muleVersion:
                      version: example_value
                      updateId: '500123'
                      endOfSupportDate: '2026-01-15'
                    workers:
                      amount: 10
                      type:
                        name: Micro
                        weight: 0.1
                        cpu: example_value
                        memory: example_value
                    properties: example_value
                    lastUpdateTime: 10
                    fileName: example_value
                    monitoringEnabled: true
                    monitoringAutoRestart: true
                    staticIPsEnabled: true
                    persistentQueues: true
                    persistentQueuesEncrypted: true
                    objectStoreV1: true
                    loggingNgEnabled: true
                    trackingSettings:
                      trackingLevel: DISABLED
                    vpnId: '500123'
                    vpnConfig:
                      vpnId: '500123'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteApplication
      summary: Mulesoft Delete Application
      description: >-
        Deletes a CloudHub application and stops all running workers. The
        application domain becomes available for reuse after deletion.
      tags:
      - Applications
      parameters:
      - $ref: '#/components/parameters/Domain'
      - name: X-ANYPNT-ENV-ID
        in: header
        required: true
        description: The environment ID
        schema:
          type: string
          format: uuid
        example: '500123'
      - name: X-ANYPNT-ORG-ID
        in: header
        required: true
        description: The organization ID
        schema:
          type: string
          format: uuid
        example: '500123'
      responses:
        '204':
          description: Application deleted successfully
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /cloudhub/api/v2/applications/{domain}/status:
    get:
      operationId: getApplicationStatus
      summary: Mulesoft Get Application Status
      description: >-
        Retrieves the current deployment status of a CloudHub application,
        including the status of each worker instance.
      tags:
      - Applications
      parameters:
      - $ref: '#/components/parameters/Domain'
      - name: X-ANYPNT-ENV-ID
        in: header
        required: true
        description: The environment ID
        schema:
          type: string
          format: uuid
        example: '500123'
      - name: X-ANYPNT-ORG-ID
        in: header
        required: true
        description: The organization ID
        schema:
          type: string
          format: uuid
        example: '500123'
      responses:
        '200':
          description: Application status retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationStatus'
              examples:
                Getapplicationstatus200Example:
                  summary: Default getApplicationStatus 200 response
                  x-microcks-default: true
                  value:
                    domain: example_value
                    status: example_value
                    deploymentUpdateStatus: example_value
                    workers:
                    - id: abc123
                      host: example_value
                      port: 10
                      status: example_value
          

# --- truncated at 32 KB (51 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mulesoft/refs/heads/main/openapi/mulesoft-anypoint-platform-openapi.yml