Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

IBM Turbonomic Entities API

Query and manage entities (VMs, containers, applications, storage)

IBM Turbonomic Entities API is one of 10 APIs that IBM Turbonomic publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Entities. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and an API reference.

This API exposes 4 operations across 4 paths, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version v3.

Requests are made against a single base URL, https://{turbonomic_host}/api/v3.

4 operations 4 paths 4 schemas 4 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v3
Base URL
https://{turbonomic_host}/api/v3
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

IBM Turbonomic Entities API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth).

  • bearerAuth — Bearer token obtained by calling POST /api/v3/login with username and password. Include in the Authorization header as 'Bearer {token}'.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 GET. Each is listed below with its method, path, parameters, and response codes.

Entities 4

Query and manage entities (VMs, containers, applications, storage)

GET
/entities
Get All Entities
getEntities 3 params → 200
GET
/entities/{uuid}
Get Entity By UUID
getEntityByUuid 1 param → 200404
GET
/entities/{uuid}/actions
Get Entity Actions
getEntityActions 1 param → 200
GET
/entities/{uuid}/stats
Get Entity Statistics
getEntityStats 3 params → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Action (12 properties), Entity (7 properties), EntityRef (3 properties), StatSnapshot (2 properties). Each schema is shown below with its type and property counts.

Action
object
An optimization action recommended by Turbonomic
12 properties
EntityRef
object
A reference to an entity
3 properties
StatSnapshot
object
A statistical snapshot for a resource metric
2 properties
Entity
object
A managed entity in the Turbonomic environment
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

turbonomic-entities-api-openapi.yml Raw ↑

Other APIs IBM Turbonomic publishes across the network.

IBM Turbonomic Actions API
IBM Turbonomic Authentication API
IBM Turbonomic Groups API
IBM Turbonomic Markets API
IBM Turbonomic Policies API
IBM Turbonomic Statistics API
IBM Turbonomic Targets API
IBM Turbonomic Templates API
IBM Turbonomic Topology API