Delete Vsphere Provider

Unregister a vSphere provider

Deletes the specified vSphere provider registration from the installer's database.

Side Effects:

This does NOT delete any resources inside vCenter itself.
Warning: If platforms are currently deployed and actively tied to this provider, deleting the provider record will orphan them and prevent future LCM operations on those clusters.

Request

URI

DELETE

https://{api_host}/sspi/providers/{provider-id}

COPY

Path Parameters

string

provider-id

Required

A globally unique UUID representing the vSphere provider to delete.

provider-id example

434348d8-681e-4809-8dc1-427127d2bee7

Authentication

This operation uses the following authentication methods.

enterprise_admin

Responses

200

Operation doesn't return any data structure

400

Bad Request

Returns BadRequest of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

401

Unauthorized

Returns Unauthorized of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

403

Forbidden

Returns Forbidden of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

412

Precondition Failed

Returns PreconditionFailed of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

428

Precondition Required

Returns PreconditionRequired of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

429

Too Many Requests

Returns TooManyRequests of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

default

An error occurred while checking the Platform Installer service.

Returns Error of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

Code Samples

COPY

                    curl -X DELETE -H 'Authorization: <value>' https://{api_host}/sspi/providers/{provider-id}

On This Page

Description

Request

Path Parameters

Authentication

Response

200 Response Body

Errors

Provider Management Operations

GET

Get All Vsphere Providers

POST

Create Vsphere Provider

GET

Get Vsphere Provider

PUT

Update Vsphere Provider

DELETE

Delete Vsphere Provider

GET

Get Provider Status