IBM Turbonomic

opencollection: 1.0.0
info:
  name: Turbonomic REST API
  version: v3
items:
- info:
    name: Authentication
    type: folder
  items:
  - info:
      name: Login to Turbonomic
      type: http
    http:
      method: POST
      url: https://{turbonomic_host}/api/v3/login
      body:
        type: json
        data: '{}'
    docs: Authenticate with the Turbonomic server and obtain a session token for subsequent API calls.
  - info:
      name: Logout from Turbonomic
      type: http
    http:
      method: POST
      url: https://{turbonomic_host}/api/v3/logout
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Invalidate the current session token.
- info:
    name: Entities
    type: folder
  items:
  - info:
      name: Get All Entities
      type: http
    http:
      method: GET
      url: https://{turbonomic_host}/api/v3/entities
      params:
      - name: entity_type
        value: ''
        type: query
        description: Filter by entity type (e.g., VirtualMachine, Container, Application)
      - name: limit
        value: ''
        type: query
        description: Maximum number of entities to return
      - name: cursor
        value: ''
        type: query
        description: Pagination cursor for the next page of results
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Retrieve all entities in the Turbonomic environment. Entities include virtual machines, containers, applications,
      storage volumes, hosts, and other infrastructure components.
  - info:
      name: Get Entity By UUID
      type: http
    http:
      method: GET
      url: https://{turbonomic_host}/api/v3/entities/:uuid
      params:
      - name: uuid
        value: ''
        type: path
        description: The unique identifier of the entity
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Retrieve a specific entity by its unique identifier.
  - info:
      name: Get Entity Actions
      type: http
    http:
      method: GET
      url: https://{turbonomic_host}/api/v3/entities/:uuid/actions
      params:
      - name: uuid
        value: ''
        type: path
        description: The unique identifier of the entity
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Retrieve pending optimization actions for a specific entity.
  - info:
      name: Get Entity Statistics
      type: http
    http:
      method: GET
      url: https://{turbonomic_host}/api/v3/entities/:uuid/stats
      params:
      - name: uuid
        value: ''
        type: path
        description: The unique identifier of the entity
      - name: start_date
        value: ''
        type: query
        description: Start date for statistics (ISO 8601 format)
      - name: end_date
        value: ''
        type: query
        description: End date for statistics (ISO 8601 format)
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Retrieve historical and projected resource utilization statistics for an entity.
- info:
    name: Markets
    type: folder
  items:
  - info:
      name: Get All Markets
      type: http
    http:
      method: GET
      url: https://{turbonomic_host}/api/v3/markets
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Retrieve all Turbonomic markets. Markets represent simulation scenarios used to project the state of the environment
      and evaluate optimization actions.
  - info:
      name: Get Market Actions
      type: http
    http:
      method: GET
      url: https://{turbonomic_host}/api/v3/markets/:uuid/actions
      params:
      - name: uuid
        value: ''
        type: path
        description: Market UUID (use 'Market' for the realtime market)
      - name: ascending
        value: ''
        type: query
        description: Sort order for results
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Retrieve all pending optimization actions for a market. By default, queries the realtime market (Market) for all
      pending actions.
  - info:
      name: Get Market Action Statistics
      type: http
    http:
      method: POST
      url: https://{turbonomic_host}/api/v3/markets/:uuid/actions/stats
      params:
      - name: uuid
        value: ''
        type: path
        description: Market UUID
      body:
        type: json
        data: '{}'
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Retrieve aggregate statistics for actions in a market filtered by criteria.
- info:
    name: Actions
    type: folder
  items:
  - info:
      name: Get Action By UUID
      type: http
    http:
      method: GET
      url: https://{turbonomic_host}/api/v3/actions/:uuid
      params:
      - name: uuid
        value: ''
        type: path
        description: The unique identifier of the action
      - name: accept
        value: ''
        type: query
        description: If true, execute (accept) this action
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Retrieve details for a specific optimization action.
- info:
    name: Groups
    type: folder
  items:
  - info:
      name: Get All Groups
      type: http
    http:
      method: GET
      url: https://{turbonomic_host}/api/v3/groups
      params:
      - name: group_type
        value: ''
        type: query
        description: Filter by group type
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Retrieve all entity groups defined in the Turbonomic environment.
  - info:
      name: Create Group
      type: http
    http:
      method: POST
      url: https://{turbonomic_host}/api/v3/groups
      body:
        type: json
        data: '{}'
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Create a new entity group for scoped policy application and reporting.
  - info:
      name: Get Group By UUID
      type: http
    http:
      method: GET
      url: https://{turbonomic_host}/api/v3/groups/:uuid
      params:
      - name: uuid
        value: ''
        type: path
        description: The unique identifier of the group
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Retrieve a specific entity group by its unique identifier.
  - info:
      name: Update Group
      type: http
    http:
      method: PUT
      url: https://{turbonomic_host}/api/v3/groups/:uuid
      params:
      - name: uuid
        value: ''
        type: path
        description: The unique identifier of the group
      body:
        type: json
        data: '{}'
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Update an existing entity group.
  - info:
      name: Delete Group
      type: http
    http:
      method: DELETE
      url: https://{turbonomic_host}/api/v3/groups/:uuid
      params:
      - name: uuid
        value: ''
        type: path
        description: The unique identifier of the group
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Delete an entity group.
- info:
    name: Policies
    type: folder
  items:
  - info:
      name: Get All Policies
      type: http
    http:
      method: GET
      url: https://{turbonomic_host}/api/v3/policies
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Retrieve all automation and placement policies defined in Turbonomic.
  - info:
      name: Create Policy
      type: http
    http:
      method: POST
      url: https://{turbonomic_host}/api/v3/policies
      body:
        type: json
        data: '{}'
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Create a new automation or placement policy.
  - info:
      name: Get Policy By UUID
      type: http
    http:
      method: GET
      url: https://{turbonomic_host}/api/v3/policies/:uuid
      params:
      - name: uuid
        value: ''
        type: path
        description: The unique identifier of the policy
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Retrieve a specific policy by its unique identifier.
  - info:
      name: Update Policy
      type: http
    http:
      method: PUT
      url: https://{turbonomic_host}/api/v3/policies/:uuid
      params:
      - name: uuid
        value: ''
        type: path
        description: The unique identifier of the policy
      body:
        type: json
        data: '{}'
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Update an existing policy.
  - info:
      name: Delete Policy
      type: http
    http:
      method: DELETE
      url: https://{turbonomic_host}/api/v3/policies/:uuid
      params:
      - name: uuid
        value: ''
        type: path
        description: The unique identifier of the policy
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Delete a policy.
- info:
    name: Statistics
    type: folder
  items:
  - info:
      name: Get Statistics
      type: http
    http:
      method: POST
      url: https://{turbonomic_host}/api/v3/stats
      body:
        type: json
        data: '{}'
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Retrieve aggregated statistics for entities matching the specified criteria.
- info:
    name: Targets
    type: folder
  items:
  - info:
      name: Get All Targets
      type: http
    http:
      method: GET
      url: https://{turbonomic_host}/api/v3/targets
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Retrieve all discovery targets configured in Turbonomic, including cloud accounts, hypervisors, container platforms,
      and monitoring systems.
  - info:
      name: Get Target By UUID
      type: http
    http:
      method: GET
      url: https://{turbonomic_host}/api/v3/targets/:uuid
      params:
      - name: uuid
        value: ''
        type: path
        description: The unique identifier of the target
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Retrieve a specific discovery target by its unique identifier.
- info:
    name: Templates
    type: folder
  items:
  - info:
      name: Get All Templates
      type: http
    http:
      method: GET
      url: https://{turbonomic_host}/api/v3/templates
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Retrieve all resource and hardware templates defined in Turbonomic.
  - info:
      name: Create Template
      type: http
    http:
      method: POST
      url: https://{turbonomic_host}/api/v3/templates
      body:
        type: json
        data: '{}'
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Create a new resource or hardware template.
  - info:
      name: Get Template By UUID
      type: http
    http:
      method: GET
      url: https://{turbonomic_host}/api/v3/templates/:uuid
      params:
      - name: uuid
        value: ''
        type: path
        description: The unique identifier of the template
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Retrieve a specific template by its unique identifier.
  - info:
      name: Delete Template
      type: http
    http:
      method: DELETE
      url: https://{turbonomic_host}/api/v3/templates/:uuid
      params:
      - name: uuid
        value: ''
        type: path
        description: The unique identifier of the template
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Delete a template.
- info:
    name: Topology
    type: folder
  items:
  - info:
      name: Get Topology Definitions
      type: http
    http:
      method: GET
      url: https://{turbonomic_host}/api/v3/topology
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Retrieve topology definitions describing infrastructure relationships and supply chains.
bundled: true