Delete Service Deployment

Delete Service Deployment

Remove the service deployment. Will remove all the Service VMs that were created as part of this deployment. User can send optional force delete option which will force remove the deployment, but should be used only when the regular delete is not working. Regular delete will ensure proper cleanup of Service VMs and related objects. Directly calling this API without trying regular undeploy will result in unexpected results, and orphan objects.

Request

URI

DELETE

https://nsxmanager.your.domain/api/v1/serviceinsertion/services/{service-id}/service-deployments/{service-deployment-id}

COPY

Path Parameters

string

service-id

Required

service-id

string

service-deployment-id

Required

service-deployment-id

Query Parameters

boolean

force

Optional

Constraints: default: false

Force delete the resource even if it is being used somewhere

Authentication

This operation uses the following authentication methods.

Responses

202

Accepted

Operation doesn't return any data structure

400

Bad Request

Returns BadRequest of type(s) application/json

{
    "details": "string",
    "error_code": 0,
    "error_data": {},
    "error_message": "string",
    "module_name": "string",
    "related_errors": [
        {
            "details": "string",
            "error_code": 0,
            "error_data": {},
            "error_message": "string",
            "module_name": "string"
        }
    ]
}

403

Returns Forbidden of type(s) application/json

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

412

Returns PreconditionFailed of type(s) application/json

Operation doesn't return any data structure

500

Returns InternalServerError of type(s) application/json

Operation doesn't return any data structure

503

Returns ServiceUnavailable of type(s) application/json

Operation doesn't return any data structure

Code Samples

COPY

                    curl -X DELETE -H 'Authorization: <value>' https://{api_host}/api/v1/serviceinsertion/services/{service-id}/service-deployments/{service-deployment-id}

On This Page

Description

Request

Path Parameters

Query Parameters

Authentication

Response

202 Response Body

Errors

Management Plane Api Operations

Get Exclude List

Update Exclude List

Check Member If Exists

List Firewall Profiles

Create Firewall Profile

Delete Firewall Profile

Get Firewall Profile

Update Firewall Profile

Read Firewall Rule

Get Sections Summary

Add Rule In Section

Get Firewall Section Stats

Get Firewall Stats

Add Rules In Section

Get Section State

Get Section With Rules

Revise Section With Rules

Update Section With Rules

Add Section With Rules

Reset Firewall Rule Stats

List Firewall Status

Get Firewall Status

Update Firewall Status

Get Firewall Status On Target Resource

Disable Firewall On Target Resource

Enable Firewall On Target Resource

List Compute Collection Statuses

List Transport Node Statuses By Compute Collection Id

Get Compute Collection Status By Id

List Enabled Compute Collections

Delete Enabled Compute Collection

Get Enabled Compute Collection

Update Enabled Compute Collection

Get Master Switch Setting

Update Master Switch Setting

Get Nsgroup Vm Details

Get Standalone Hosts Switch Setting

Update Standalone Hosts Switch Setting

Get System Stats

List Virtual Machine Statuses By Transport Node Id

List User Sessions

Get Mps Compute Collection Status

Delete Mps Service Deployment

Get Mps Service Deployment

Deploy Mps Service

Mps Change Appliance

Get Mps Deployment Spec

Malware Prevention Teaser List Regions

Create Malware Prevention Teaser Registration Url

Malware Prevention Teaser Check Status

Get Mps Transport Node Status

List Service Configs

Create Service Config

Service Config Batch Operation

Effective Profiles

Delete Service Config

Read Service Config

Update Service Config

List Service Attachments

Add Service Attachment

Delete Service Attachment

Get Service Attachment

Update Service Attachment

List Service Chains

Add Service Chain

Delete Service Chain

Get Service Chain

List Service Paths

List Service Instances

List Service Managers

Register Service Manager

Delete Service Manager

Get Service Manager

Update Service Manager

List Service Insertion Services

Add Service Insertion Service

Delete Service Insertion Service

Get Service Insertion Service

Update Service Insertion Service

Get Service Deployments

Delete Service Deployment

Get Service Deployment

Update Service Deployment

Get Service Deployment State

Get Service Deployment Status

Upgrade Service Deployment

List Service Instances For Service

Add Service Instance

Delete Service Instance

Get Service Instance

Update Service Instance

Get Service Instance NS Groups

List Instance Endpoints

Add Instance Endpoint

Delete Instance Endpoint

Get Instance Endpoint

List Instance Runtimes

Update Service Vm State

Get Runtime Interface Statistics

Get Runtime Interface Operational Status

Delete Service V Ms

Deploy Service V Ms

Upgrade Service V Ms

Get Service Instance State

Get Service Instance Status

List SI Service Profiles

Add SI Service Profile

Delete SI Service Profile

Get SI Service Profile

Get Service Profile NS Groups

List Service Chain Mappings

List Solution Configs

Create Solution Config

Delete Solution Config

Get Solution Config

Update Solution Config

Delete Extended Solution Config

Get Extended Solution Config

Create Extended Solution Config

Update Extended Solution Config

List Vendor Templates

Add Vendor Template

Delete Vendor Template

Get Vendor Template

Resolve Source Entities

Node: apidepo-liferay-dxp-v1-be-w-1:8080: