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 Groups API

Create and manage logical groups of entities

IBM Turbonomic Groups 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 Groups. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and an API reference.

This API exposes 5 operations across 2 paths, and defines 2 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.

5 operations 2 paths 2 schemas 1 DELETE2 GET1 POST1 PUT

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 Groups 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 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Groups 5

Create and manage logical groups of entities

GET
/groups
Get All Groups
getGroups 1 param → 200
POST
/groups
Create Group
createGroup body → 200
GET
/groups/{uuid}
Get Group By UUID
getGroupByUuid 1 param → 200404
PUT
/groups/{uuid}
Update Group
updateGroup 1 param body → 200
DELETE
/groups/{uuid}
Delete Group
deleteGroup 1 param → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are GroupInput (5 properties), Group (5 properties). Each schema is shown below with its type and property counts.

Group
object
A logical group of entities in Turbonomic
5 properties
GroupInput
object
Input for creating or updating a group
5 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

turbonomic-groups-api-openapi.yml Raw ↑

Other APIs IBM Turbonomic publishes across the network.

IBM Turbonomic Actions API
IBM Turbonomic Authentication API
IBM Turbonomic Entities 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