IBM WebSphere

IBM WebSphere Scaling API

Scaling policy and auto-scaling management

Documentation GitHub OpenAPI

Operations 5

GET /scaling/policies List Scaling Policies #

POST /scaling/policies Create a Scaling Policy #

GET /scaling/policies/{policyName} Get Scaling Policy Details #

PUT /scaling/policies/{policyName} Update a Scaling Policy #

DELETE /scaling/policies/{policyName} Delete a Scaling Policy #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/websphere-scaling-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: WebSphere Liberty Collective Controller REST Scaling API
  description: API for managing Liberty collective environments, including member management, scaling, centralized administration, and cluster operations. Supports subscription-based notifications for API changes across collective members. The collective controller coordinates multiple Liberty servers for centralized management and workload distribution.
  version: 24.0.0
  license:
    name: IBM International License Agreement
    url: https://www.ibm.com/legal/terms
  contact:
    name: IBM Support
    url: https://www.ibm.com/mysupport
servers:
- url: https://localhost:9443/ibm/api/collective
  description: Default Liberty Collective Controller
security:
- basicAuth: []
tags:
- name: Scaling
  description: Scaling policy and auto-scaling management
paths:
  /scaling/policies:
    get:
      operationId: listScalingPolicies
      summary: List Scaling Policies
      description: Returns a list of auto-scaling policies.
      tags:
      - Scaling
      responses:
        '200':
          description: List of scaling policies
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ScalingPolicy'
              examples:
                Listscalingpolicies200Example:
                  summary: Default listScalingPolicies 200 response
                  x-microcks-default: true
                  value:
                  - name: Example Title
                    clusterName: example_value
                    enabled: true
                    minMembers: 10
                    maxMembers: 10
                    scaleUpTrigger:
                      metric: cpuUtilization
                      threshold: 42.5
                      duration: 10
                    scaleDownTrigger:
                      metric: cpuUtilization
                      threshold: 42.5
                      duration: 10
                    cooldownPeriod: 10
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createScalingPolicy
      summary: Create a Scaling Policy
      description: Creates a new auto-scaling policy for a cluster.
      tags:
      - Scaling
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScalingPolicy'
            examples:
              CreatescalingpolicyRequestExample:
                summary: Default createScalingPolicy request
                x-microcks-default: true
                value:
                  name: Example Title
                  clusterName: example_value
                  enabled: true
                  minMembers: 10
                  maxMembers: 10
                  scaleUpTrigger:
                    metric: cpuUtilization
                    threshold: 42.5
                    duration: 10
                  scaleDownTrigger:
                    metric: cpuUtilization
                    threshold: 42.5
                    duration: 10
                  cooldownPeriod: 10
      responses:
        '201':
          description: Scaling policy created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScalingPolicy'
              examples:
                Createscalingpolicy201Example:
                  summary: Default createScalingPolicy 201 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    clusterName: example_value
                    enabled: true
                    minMembers: 10
                    maxMembers: 10
                    scaleUpTrigger:
                      metric: cpuUtilization
                      threshold: 42.5
                      duration: 10
                    scaleDownTrigger:
                      metric: cpuUtilization
                      threshold: 42.5
                      duration: 10
                    cooldownPeriod: 10
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /scaling/policies/{policyName}:
    get:
      operationId: getScalingPolicy
      summary: Get Scaling Policy Details
      description: Returns details of a specific auto-scaling policy.
      tags:
      - Scaling
      parameters:
      - name: policyName
        in: path
        required: true
        description: Scaling policy name
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: Scaling policy details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScalingPolicy'
              examples:
                Getscalingpolicy200Example:
                  summary: Default getScalingPolicy 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    clusterName: example_value
                    enabled: true
                    minMembers: 10
                    maxMembers: 10
                    scaleUpTrigger:
                      metric: cpuUtilization
                      threshold: 42.5
                      duration: 10
                    scaleDownTrigger:
                      metric: cpuUtilization
                      threshold: 42.5
                      duration: 10
                    cooldownPeriod: 10
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: updateScalingPolicy
      summary: Update a Scaling Policy
      description: Updates an existing auto-scaling policy.
      tags:
      - Scaling
      parameters:
      - name: policyName
        in: path
        required: true
        schema:
          type: string
        example: example_value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScalingPolicy'
            examples:
              UpdatescalingpolicyRequestExample:
                summary: Default updateScalingPolicy request
                x-microcks-default: true
                value:
                  name: Example Title
                  clusterName: example_value
                  enabled: true
                  minMembers: 10
                  maxMembers: 10
                  scaleUpTrigger:
                    metric: cpuUtilization
                    threshold: 42.5
                    duration: 10
                  scaleDownTrigger:
                    metric: cpuUtilization
                    threshold: 42.5
                    duration: 10
                  cooldownPeriod: 10
      responses:
        '200':
          description: Scaling policy updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScalingPolicy'
              examples:
                Updatescalingpolicy200Example:
                  summary: Default updateScalingPolicy 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    clusterName: example_value
                    enabled: true
                    minMembers: 10
                    maxMembers: 10
                    scaleUpTrigger:
                      metric: cpuUtilization
                      threshold: 42.5
                      duration: 10
                    scaleDownTrigger:
                      metric: cpuUtilization
                      threshold: 42.5
                      duration: 10
                    cooldownPeriod: 10
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteScalingPolicy
      summary: Delete a Scaling Policy
      description: Deletes an auto-scaling policy.
      tags:
      - Scaling
      parameters:
      - name: policyName
        in: path
        required: true
        schema:
          type: string
        example: example_value
      responses:
        '204':
          description: Scaling policy deleted
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    Error:
      type: object
      properties:
        code:
          type: string
          example: example_value
        message:
          type: string
          example: example_value
      required:
      - code
      - message
    ScalingPolicy:
      type: object
      properties:
        name:
          type: string
          description: Policy name
          example: Example Title
        clusterName:
          type: string
          description: Target cluster
          example: example_value
        enabled:
          type: boolean
          description: Whether the policy is active
          example: true
        minMembers:
          type: integer
          description: Minimum number of cluster members
          example: 10
        maxMembers:
          type: integer
          description: Maximum number of cluster members
          example: 10
        scaleUpTrigger:
          type: object
          properties:
            metric:
              type: string
              enum:
              - cpuUtilization
              - memoryUtilization
              - responseTime
            threshold:
              type: number
            duration:
              type: integer
              description: Duration in seconds before triggering
          example: example_value
        scaleDownTrigger:
          type: object
          properties:
            metric:
              type: string
              enum:
              - cpuUtilization
              - memoryUtilization
              - responseTime
            threshold:
              type: number
            duration:
              type: integer
          example: example_value
        cooldownPeriod:
          type: integer
          description: Cooldown period in seconds between scaling events
          example: 10
  responses:
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication with administrator role
externalDocs:
  description: Liberty Collective REST API Documentation
  url: https://www.ibm.com/docs/en/was-liberty/base?topic=liberty-collective-rest-api

IBM WebSphere Scaling API

Operations 5

Documentation

Specifications

Schemas & Data

Other Resources