MuleSoft Applications API

openapi: 3.1.0
info:
  title: MuleSoft Anypoint Platform Applications 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
servers:
- url: https://anypoint.mulesoft.com
  description: Anypoint Platform US Control Plane
- url: https://eu1.anypoint.mulesoft.com
  description: Anypoint Platform EU Control Plane
security:
- bearerAuth: []
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.
paths:
  /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
                      deployedRegion: example_value
                      staticIPAddress: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  responses:
    Unauthorized:
      description: Authentication credentials are missing or invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Invalid request parameters or body
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: The requested resource was not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  parameters:
    Domain:
      name: domain
      in: path
      required: true
      description: The unique domain name of the CloudHub application
      schema:
        type: string
        pattern: ^[a-z0-9-]+$
  schemas:
    ApplicationStatus:
      type: object
      description: Detailed deployment status of a CloudHub application
      properties:
        domain:
          type: string
          description: Application domain name
          example: example_value
        status:
          type: string
          description: Overall application status
          example: example_value
        deploymentUpdateStatus:
          type: string
          description: Status of the most recent deployment update
          example: example_value
        workers:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: Worker instance identifier
              host:
                type: string
                description: Hostname of the worker instance
              port:
                type: integer
                description: Port number the worker is listening on
              status:
                type: string
                description: Status of this worker instance
              deployedRegion:
                type: string
                description: Region where this worker is running
              staticIPAddress:
                type: string
                description: Static IP address if allocated
          example: []
    ApplicationCreate:
      type: object
      description: Request body for creating a new CloudHub application
      required:
      - domain
      - muleVersion
      - workers
      properties:
        domain:
          type: string
          description: Unique domain name for the application
          pattern: ^[a-z0-9-]+$
          example: example_value
        muleVersion:
          type: object
          description: Target Mule runtime version
          required:
          - version
          properties:
            version:
              type: string
              description: Mule runtime version to deploy
          example: example_value
        region:
          type: string
          description: CloudHub region to deploy to
          example: example_value
        workers:
          $ref: '#/components/schemas/WorkerConfig'
        properties:
          type: object
          additionalProperties:
            type: string
          description: Application properties
          example: example_value
        monitoringAutoRestart:
          type: boolean
          description: Enable automatic restart on failure
          default: true
          example: true
        persistentQueues:
          type: boolean
          description: Enable persistent queues
          default: false
          example: true
        staticIPsEnabled:
          type: boolean
          description: Enable static IP allocation
          default: false
          example: true
        loggingNgEnabled:
          type: boolean
          description: Enable next-generation logging
          default: true
          example: true
    WorkerConfig:
      type: object
      description: Worker configuration defining the compute resources allocated to a CloudHub application, including the number of workers and their size.
      required:
      - amount
      - type
      properties:
        amount:
          type: integer
          description: Number of worker instances
          minimum: 1
          maximum: 8
          example: 10
        type:
          type: object
          description: Worker type defining the vCore size and memory
          properties:
            name:
              type: string
              description: Worker size name
              enum:
              - Micro
              - Small
              - Medium
              - Large
              - xLarge
              - xxLarge
              - 4xLarge
            weight:
              type: number
              description: vCore weight of the worker type
              enum:
              - 0.1
              - 0.2
              - 1
              - 2
              - 4
              - 8
              - 16
            cpu:
              type: string
              description: CPU allocation description
            memory:
              type: string
              description: Memory allocation description
          example: example_value
    ApplicationUpdate:
      type: object
      description: Request body for updating an existing CloudHub application
      properties:
        muleVersion:
          type: object
          description: New Mule runtime version
          properties:
            version:
              type: string
              description: Mule runtime version
          example: example_value
        workers:
          $ref: '#/components/schemas/WorkerConfig'
        properties:
          type: object
          additionalProperties:
            type: string
          description: Updated application properties
          example: example_value
        monitoringAutoRestart:
          type: boolean
          description: Enable or disable automatic restart
          example: true
        region:
          type: string
          description: Target CloudHub region
          example: example_value
        staticIPsEnabled:
          type: boolean
          description: Enable or disable static IPs
          example: true
        loggingNgEnabled:
          type: boolean
          description: Enable or disable next-generation logging
          example: true
        persistentQueues:
          type: boolean
          description: Enable or disable persistent queues
          example: true
    Error:
      type: object
      description: Error response from the Anypoint Platform API
      properties:
        status:
          type: integer
          description: HTTP status code
          example: 10
        message:
          type: string
          description: Human-readable error message
          example: example_value
    Application:
      type: object
      description: A Mule application deployed to CloudHub. Contains metadata about the application configuration, deployment status, worker settings, and runtime properties.
      required:
      - domain
      - status
      properties:
        domain:
          type: string
          description: Unique domain name for the application, used as the subdomain in the CloudHub URL (e.g., myapp.cloudhub.io)
          pattern: ^[a-z0-9-]+$
          example: example_value
        fullDomain:
          type: string
          description: Full domain including the cloudhub.io suffix
          example: example_value
        status:
          type: string
          description: Current deployment status of the application
          enum:
          - STARTED
          - STARTING
          - STOPPED
          - UNDEPLOYED
          - DEPLOYING
          - DEPLOY_FAILED
          - UPDATING
          example: STARTED
        description:
          type: string
          description: Human-readable description of the application
          example: A sample description.
        region:
          type: string
          description: CloudHub region where the application is deployed
          examples:
          - us-east-1
          - us-west-2
          - eu-west-1
          - ap-southeast-1
          - ap-southeast-2
        muleVersion:
          type: object
          description: Mule runtime version information
          properties:
            version:
              type: string
              description: Mule runtime version string
            updateId:
              type: string
              description: Runtime update identifier
            endOfSupportDate:
              type: string
              format: date
              description: Date when this runtime version reaches end of support
          example: example_value
        workers:
          $ref: '#/components/schemas/WorkerConfig'
        properties:
          type: object
          additionalProperties:
            type: string
          description: Application properties passed to the Mule runtime
          example: example_value
        lastUpdateTime:
          type: integer
          format: int64
          description: Unix timestamp of the last application update
          example: 10
        fileName:
          type: string
          description: Name of the deployed application archive file
          example: example_value
        monitoringEnabled:
          type: boolean
          description: Whether Anypoint Monitoring is enabled for this application
          example: true
        monitoringAutoRestart:
          type: boolean
          description: Whether automatic restart on failure is enabled
          example: true
        staticIPsEnabled:
          type: boolean
          description: Whether static IPs are allocated to this application
          example: true
        persistentQueues:
          type: boolean
          description: Whether persistent queues are enabled
          example: true
        persistentQueuesEncrypted:
          type: boolean
          description: Whether persistent queue data is encrypted
          example: true
        objectStoreV1:
          type: boolean
          description: Whether the application uses Object Store v1
          example: true
        loggingNgEnabled:
          type: boolean
          description: Whether next-generation logging is enabled
          example: true
        trackingSettings:
          type: object
          description: Transaction tracking configuration
          properties:
            trackingLevel:
              type: string
              description: Level of tracking detail
              enum:
              - DISABLED
              - API_ANALYTICS
              - DEBUG
          example: example_value
        vpnId:
          type: string
          description: ID of the VPN if the application is connected to one
          example: '500123'
        vpnConfig:
          type: object
          description: VPN configuration for the application
          properties:
            vpnId:
              type: string
              description: VPN identifier
          example: example_value
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Anypoint Platform access token obtained via the Access Management API login endpoint or a connected app OAuth 2.0 flow.
externalDocs:
  description: Anypoint Platform API Documentation
  url: https://docs.mulesoft.com/access-management/