Delete Node

Delete Node

The proxy id is required for deleting a proxy node which can either be NodeId or model key. Examples : 10000:901:649591578347200326 (id) or IAPG7M8JS18458ROSJQRGQ0LLV (node_id). Only the admin user can perform this operation. Only the proxy nodes can be deleted using this API.

Request
URI
DELETE
https://{api_host}/api/ni/infra/nodes/{id}
COPY
Path Parameters
string
id
Required

The Entity ID of object requestion information on


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns Node of type(s) application/json
{
    "id": "string",
    "entity_type": "string",
    "node_type": "string",
    "node_id": "string",
    "ip_address": "string",
    "ipv6_address": "string",
    "name": "string",
    "is_physical_flow_collector": false,
    "sddc_details": {
        "sddc_id": "string",
        "org_id": "string",
        "aap_id": "string"
    },
    "version": "string",
    "health": {
        "health_status": "HEALTH",
        "health_details": [
            {
                "message": "Invalid credentials",
                "code": "string"
            }
        ]
    },
    "registered_timestamp": 0,
    "last_updated_timestamp": 0
}
string
id
Optional

id

entity_type
Optional

entity_type

string
node_type
Optional

node_type

Possible values are : PROXY_VM, PLATFORM_VM,
string
node_id
Optional

node_id

string
ip_address
Optional

ip_address

string
ipv6_address
Optional

ipv6_address

string
name
Optional

name

boolean
is_physical_flow_collector
Optional

is_physical_flow_collector

sddc_details
Optional

sddc_details

string
version
Optional

version

health
Optional

health

integer As int64 As int64
registered_timestamp
Optional

registered_timestamp

integer As int64 As int64
last_updated_timestamp
Optional

last_updated_timestamp


401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

500

Internal Error

Operation doesn't return any data structure