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
                      deployedRegion: example_value
                      staticIPAddress: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  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.
  parameters:
    OrgId:
      name: orgId
      in: path
      required: true
      description: The unique identifier of the organization
      schema:
        type: string
        format: uuid
    EnvId:
      name: envId
      in: path
      required: true
      description: The unique identifier of the environment
      schema:
        type: string
        format: uuid
    Domain:
      name: domain
      in: path
      required: true
      description: The unique domain name of the CloudHub application
      schema:
        type: string
        pattern: '^[a-z0-9-]+$'
  responses:
    BadRequest:
      description: Invalid request parameters or body
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Authentication credentials are missing or invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: The requested resource was not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Organization:
      type: object
      description: >-
        An Anypoint Platform organization or business group. Organizations are
        the top-level containers that hold all platform resources including
        users, environments, and deployed applications.
      required:
      - id
      - name
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier of the organization
          example: abc123
        name:
          type: string
          description: Display name of the organization
          example: Example Title
        createdAt:
          type: string
          format: date-time
          description: Timestamp when the organization was created
          example: '2026-01-15T10:30:00Z'
        updatedAt:
          type: string
          format: date-time
          description: Timestamp when the organization was last updated
          example: '2026-01-15T10:30:00Z'
        ownerId:
          type: string
          format: uuid
          description: User ID of the organization owner
          example: '500123'
        clientId:
          type: string
          description: Client ID for the organization used in API authentication
          example: '500123'
        idprovider_id:
          type: string
          description: Identity provider ID if external identity management is configured
          example: '500123'
        isFederated:
          type: boolean
          description: Whether the organization uses federated identity management
          example: true
        parentOrganizationIds:
          type: array
          items:
            type: string
            format: uuid
          description: IDs of parent organizations in the business group hierarchy
          example: []
        subOrganizationIds:
          type: array
          items:
            type: string
            format: uuid
          description: IDs of child business groups
          example: []
        tenantOrganizationIds:
          type: array
          items:
            type: string
            format: uuid
          description: IDs of tenant organizations
          example: []
        mfaRequired:
          type: boolean
          description: Whether multi-factor authentication is required
          example: true
        isAutomaticAdminPromotionExempt:
          type: boolean
          description: Whether automatic admin promotion is disabled
          example: true
        domain:
          type: string
          description: Domain associated with the organization
          example: example_value
        isMaster:
          type: boolean
          description: Whether this is the root (master) organization
          example: true
        subscription:
          $ref: '#/components/schemas/Subscription'
        entitlements:
          $ref: '#/components/schemas/Entitlements'
        environments:
          type: array
          items:
            $ref: '#/components/schemas/Environment'
          description: Environments belonging to this organization
          example: []
    OrganizationUpdate:
      type: object
      description: Fields that can be updated on an organization
      properties:
        name:
          type: string
          description: Display name of the organization
          example: Example Title
        ownerId:
          type: string
          format: uuid
          description: User ID of the new organization owner
          example: '500123'
        sessionTimeout:
          type: integer
          description: Session timeout in minutes
          minimum: 15
          maximum: 180
          example: 10
        mfaRequired:
          type: boolean
          description: Whether multi-factor authentication is required
          example: true
    Subscription:
      type: object
      description: Subscription plan details for the organization
      properties:
        category:
          type: string
          description: Subscription category
          example: example_value
        type:
          type: string
          description: Subscription type
          example: example_value
        expiration:
          type: string
          format: date-time
          description: Subscription expiration date
          example: '2026-01-15T10:30:00Z'
    Entitlements:
      type: object
      description: Platform entitlements and resource limits for the organization
      properties:
        createEnvironments:
          type: boolean
          description: Whether the organization can create new environments
          example: true
        globalDeployment:
          type: boolean
          description: Whether global deployment is enabled
          example: true
        createSubOrgs:
          type: boolean
          description: Whether the organization can create sub-organizations
          example: true
        vCoresProduction:
          $ref: '#/components/schemas/ResourceAllocation'
        vCoresSandbox:
          $ref: '#/components/schemas/ResourceAllocation'
        vCoresDesign:
          $ref: '#/components/schemas/ResourceAllocation'
        staticIps:
          $ref: '#/components/schemas/ResourceAllocation'
        vpcs:
          $ref: '#/components/schemas/ResourceAllocation'
        loadBalancer:
          $ref: '#/components/schemas/ResourceAllocation'
    ResourceAllocation:
      type: object
      description: Resource allocation with assigned and reassigned counts
      properties:
        assigned:
          type: number
          description: Number of resources assigned to this organization
          example: 42.5
        reassigned:
          type: number
          description: Number of resources reassigned to sub-organizations
          example: 42.5
    Environment:
      type: object
      description: >-
        A deployment environment within an organization. Environments provide
        isolated contexts for deploying Mule applications, with types including
        Design, Sandbox, and Production.
      required:
      - id
      - name
      - organizationId
      - type
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier of the environment
          example: abc123
        name:
          type: string
          description: Display name of the environment
          example: Example Title
        organizationId:
          type: string
          format: uuid
          description: ID of the organization this environment belongs to
          example: '500123'
        isProduction:
          type: boolean
          description: Whether this is a production environment
          example: true
        type:
          type: string
          description: The environment type classification
          enum:
          - design
          - sandbox
          - production
          example: design
        clientId:
          type: string
          description: Client ID associated with this environment
          example: '500123'
        createdAt:
          type: string
          format: date-time
          description: Timestamp when the environment was created
          example: '2026-01-15T10:30:00Z'
        updatedAt:
          type: string
          format: date-time
          description: Timestamp when the environment was last updated
          example: '2026-01-15T10:30:00Z'
    EnvironmentCreate:
      type: object
      description: Request body for creating a new environment
      required:
      - name
      - type
      properties:
        name:
          type: string
          description: Display name for the new environment
          example: Example Title
        type:
          type: string
          description: The environment type classification
          enum:
          - design
          - sandbox
          - production
          example: design
    EnvironmentUpdate:
      type: object
      description: Request body for updating an environment
      properties:
        name:
          type: string
          description: New display name for the environment
          example: Example Title
        type:
          type: string
          description: New environment type classification
          enum:
          - design
          - sandbox
          - production
          example: design
    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
    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
    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
    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
    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: []
    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