Delete Host For CSG | Telco Cloud Foundation Manager API

Delete Host For CSG

Delete the specified host.

Request

URI

DELETE

https://{api_host}/hybridity/api/ztp/v1/csgs/{csg_id}/hosts/{host_id}

COPY

Path Parameters

string

csg_id

Required

The ID of the CSG

string

host_id

Required

The ID of the host

Query Parameters

boolean

wipeDisks

Optional

This flag specifies whether to wipe the disks on the host during the deletion process.

boolean

forceDelete

Optional

This flag specifies whether to forcefully clear the host from the inventory in case of deletion failure. If true, manual cleanup of the host maybe required after removal from inventory.

Authentication

This operation uses the following authentication methods.

x-hm-authorization

Responses

202

The request of host deletion has been accepted for processing.

Returns InlineZtpV1CsgsCsg_idHostsHost_id202Response of type(s) application/json

{
    "warnings": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ],
    "errors": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ]
}

array of object

warnings

Optional

The list of warnings.

array of object

errors

Optional

The list of errors.

301

API endpoint has permanently moved.

Returns InlineZtpV1CsgsCsg_idHostsHost_id301Response of type(s) application/json

{
    "redirectURL": "string"
}

string

redirectURL

Optional

redirectURL

Response Headers

string

Location

URI where the client will find the new endpoint.

400

Response may include details of why the request is bad.

Returns InlineZtpV1CsgsCsg_idHostsHost_id400Response of type(s) application/json

{
    "warnings": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ],
    "errors": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ]
}

array of object

warnings

Optional

The list of warnings.

array of object

errors

Optional

The list of errors.

401

User is not authenticated to invoke this endpoint.

Operation doesn't return any data structure

403

User is not authorized to invoke this endpoint.

Operation doesn't return any data structure

404

The specified host was not found.

Operation doesn't return any data structure

422

The request couldn't be processed by the server.

Returns InlineZtpV1CsgsCsg_idHostsHost_id422Response of type(s) application/json

{
    "warnings": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ],
    "errors": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ]
}

array of object

warnings

Optional

The list of warnings.

array of object

errors

Optional

The list of errors.

500

An internal server error has occurred.

Returns InlineZtpV1CsgsCsg_idHostsHost_id500Response of type(s) application/json

{
    "warnings": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ],
    "errors": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ]
}

array of object

warnings

Optional

The list of warnings.

array of object

errors

Optional

The list of errors.

On This Page

Description

Request

Path Parameters