API deprecation history

The following endpoints, requests, DTOs, and/or parameters have been deprecated in the Turbonomic API. The changes were finalized and removed from the API in the listed release.

Note:

See the instructions for alternative usage for deprecated items.

8.14.1

No items were scheduled for deprecation in version 8.14.1.

8.13.1

API component Changes
Endpoints None
Requests None
Request Parameters None
DTOs None
DTO Parameters

DTO: RequestHeader

Parameter name: updateSecret

Instruction: No replacement parameter is needed to update the secret in a header request. You need only to specify "isSecret": true and include the updated secret value in the header. If you do not specify a new value for the secret, the existing value is reused

8.12.1

API component Changes
Endpoints None
Requests None
Request Parameters

  • Request: GET /search

    Parameter Name: entity_types

    Instruction: This parameter was previously deprecated and is scheduled for removal in 8.12.1.

    The mandatory types or group_type parameters are the preferred parameters to specify an object or group type in a search request.
DTOs

  • BusinessUnitRelatedApiDTO

    Instruction: This DTO was used with the /pricelists endpoints from Turbonomic Classic, which was never implemented in Turbonomic 8.x and was deleted in version 8.9.3. This DTO was never implemented or used in Turbonomic, but it is referenced in the BusinessUnitApiDTO DTO. Because the DTO was never implemented, no alternative is required.
DTO Parameters

  • DTO: ActionApiDTO

    Parameter: actionState

    Enums: RECOMMENDED and PENDING_ACCEPT are removed as possible values for the actionState parameter. The parameter is otherwise unchanged.

    Instruction: Both these action states are replaced by the READY action state.

8.11.1

API component Changes
Endpoints

  • GET /tags/<tagKey>/entities

    Instruction: Use GET /tags/entities?key=<tagKey>. This endpoint better supports searches for certain special characters, such as a slash (/), within tag names.
Requests None
Request Parameters None
DTOs None
DTO Parameters None

8.10.1

API component Changes
Endpoints None
Requests None
Request Parameters None
DTOs None
DTO Parameters

  • DTO: StatApiInputDTO

    Parameter Name: costPrice

    Instruction: Use the dedicated cost endpoints in /entities, /groups, and /markets instead.

    Note:

    These are marked "In Development" currently but will reach GA soon.

    • /entities/{entity_Uuid}/cost

    • /groups/{group_Uuid}/cost

    • /markets/{market_Uuid}/cost

8.9.1

API component Changes
Endpoints None
Requests None
Request Parameters None
DTOs

  • DTO: ScenarioApiDTO

    Parameter Name: changes

    Instruction: Use the loadChanges or configChanges parameters.
DTO Parameters

  • DTO: StatApiInputDTO

    Parameter Name: costPrice

    Instruction: Use the dedicated cost endpoints in /entities, /groups, and /markets instead.

    Note:

    These are marked "In Development" currently but will reach GA soon.

    • /entities/{entity_Uuid}/cost

    • /groups/{group_Uuid}/cost

    • /markets/{market_Uuid}/cost

8.8.1

API component Changes
Endpoints None
Requests

  • GET /search/market/

    Instruction: Use GET /markets.

  • GET /search/target/

    Instruction: Use GET /targets.

  • GET /groups/<groupId>/actions/<actionId>

    Instruction: Do not use this call (not implemented).

  • GET, POST /target/<targetId>/stats

    Instruction: Do not use this call (not implemented).

  • GET /businessunits/<busUnitId>/stats

    Instruction: Use GET /entities/<entityId>/stats or GET /stats/<entityId>/stats. These calls use the business unit entity ID.

  • POST /businessunits/<busUnitId>/stats

    Instruction: Use POST /stats/<entityId>/stats or POST /stats.
Request Parameters None
DTOs None
DTO Parameters

  • DTO: ActionApiDTO

    Parameter Name: CurrentLocation

    Instruction: The object in this parameter will only contain the following fields:

    • links

    • uuid

    • className

    • displayName

    • discoveredBy

    • environmentType

    • vendorIDs

  • DTO: ActionApiDTO

    Parameter Name: NewLocation

    Instruction: The object in this parameter will only contain the following fields:

    • links

    • uuid

    • className

    • displayName

    • discoveredBy

    • environmentType

    • vendorIDs

  • DTO: ProductVersionDTO

    Parameter Name: buildUser

    Instruction: Deprecated with no replacement. This parameter was not implemented in the 8.x product family.

  • DTO: GroupApiDTO

    Parameter Name: remoteId

    Instruction: Deprecated with no replacement. This parameter was not implemented in the 8.x product family.

  • DTO: UserApiDTO

    Parameter Names:

    • roleUuid

    • roleName

    Instruction: Deprecated. Use the roles parameter in UserApiDTO.
ENUM values

  • entityType:VMSpec

    Instruction: Use VirtualMachineSpec.

  • entityTypes:VMSpec

    Instruction: Use VirtualMachineSpec.

  • entityTypeFilter:VMSpec

    Instruction: Use VirtualMachineSpec.

  • providerEntityType:VMSpec

    Instruction: Use VirtualMachineSpec.

  • relatedEntityType:VMSpec

    Instruction: Use VirtualMachineSpec.

  • providerType:VMSpec

    Instruction: Use VirtualMachineSpec.

8.7.1

API component Changes
Endpoints None
Requests

  • DELETE /entities/<entityId>/tags/<tagKey>

    Instruction: Use DELETE /entities/<entityId>/tags?key=<tagKey>.

  • DELETE /groups/<groupId>/tags/<tagKey>

    Instruction: Use DELETE /groups/<groupId>/tags?key=<tagKey>.
Request Parameters None
DTOs

  • LicenseApiInputDTO

    Instruction: Use LicenseApiDTO.
DTO Parameters

  • DTO: HttpProxyDTO

    Parameter Name: portNumber

    Instruction: Use proxyPortNumber.

  • DTO: LogEntryApiDTO

    Parameter Name: reasonCommodity

    Instruction: Use the array, reasonCommodities.

8.6.1

Behavior Changes:

  • Pagination of Returned Data from /search requests:

    For searches, the API paginates the returned data. Starting with version 8.6.1, the default pagination limit is 100 entries, and the maximum pagination limit is 500. If you do not specify a pagination limit, then the API returns pages set to the default limit of 100. If you make no settings, and your search results include more than 100 entries, the results will be paginated. Your scripts should always check for a pagination cursor when processing search results.

    You can change these settings in the charts_v1alpha1_xl_cr.yaml resource. Find the entries for:

    • apiPaginationDefaultLimit

    • apiPaginationMaxLimit

API component Changes
Endpoints None
Requests None
Request Parameters None
DTOs

  • ReportScheduleApiDTO

    This release will remove ReportScheduleApiDTO.
DTO Parameters

  • DTO: ActionApiDTO

    Parameter Name: CurrentLocation

    Instruction: The object in this parameter will only contain the following fields:

    • links

    • uuid

    • className

    • displayName

    • discoveredBy

    • environmentType

    • vendorIDs

  • DTO: ActionApiDTO

    Parameter Name: NewLocation

    Instruction: The object in this parameter will only contain the following fields:

    • links

    • uuid

    • className

    • displayName

    • discoveredBy

    • environmentType

    • vendorIDs

  • DTO: ProductVersionDTO

    Parameter Name: buildUser

    Instruction: Deprecated with no replacement. This parameter was not implemented in the 8.x product family.

  • DTO: GroupApiDTO

    Parameter Name: remoteId

    Instruction: Deprecated with no replacement. This parameter was not implemented in the 8.x product family.

  • DTO: UserApiDTO

    Parameter Names:

    • roleUuid

    • roleName

    Instruction: Deprecated. Use the roles parameter in UserApiDTO.

Versions older than 8.6.0

To download documentation for versions older than 8.6.0, see the Archives.