ServiceOfferingInstance offboard request

Description

This API removes a service offering instance from BMC Cloud Lifecycle Management and optionally from BMC Service Automation. This API does not decommission the servers that host the service offering instance. If you want to remove the service offering instance and decommission the servers that host the instance, use the ServiceOfferingInstance-decommission-request instead.

The following constraints apply to this API:

Both the provisioned service offering instance and associated compute container must be either running or stopped. You cannot offboard a service offering instance that is in any other state.
You cannot offboard multi-tier service offering instances.
You cannot offboard a service offering instance that has load balancer entries or firewall rules. You must delete them before sending the offboard request.

API stability classification

Unstable

Availability

Available in BMC Cloud Lifecycle Management version 2.1 SP2 and later

API overview

HTTP request message

Query string parameters

This API does not use query string parameters.

Request message headers

This API uses only common request headers listed in HTTP-request-and-response-headers.

Request message body

This API uses the following objects in the request message body JSON:

The following table lists the input parameters to include in the operationParams object:

HTTP response message

Response message headers

This API uses only common response headers listed in HTTP-request-and-response-headers.

Response message body

The response message body contains a Task object.

Unknown macro: confluence_report-block. Click on this message for details.