/connmgr/v1/connections/<connection_name>: DELETE

Deletes a connection.

The /connmgr/v1/connections/<connection_name>: DELETE endpoint deletes the specified connection from the connection table. The following table shows which roles can access this REST API endpoint:
Table 1. Access by role
Data admin Data user Collection Admin Admin Service user
✓ Χ Χ Χ Χ

Synopsis of the request URL

curl -k -H 'Authorization: Bearer <token>' https://<spectrum_discover_host>/connmgr/v1/
connections/<connection_name> -X DELETE

Supported request types and response formats

Supported request types:
  • DELETE
Supported response formats:
  • JSON

Examples

  1. The following example deletes a connection named con02:
    1. Issue the following request on one line:
      curl -k -H 'Authorization: Bearer <token>'  
https://<spectrum_discover_host>/connmgr/v1/connections/con02 -X DEL
    2. The following response is returned: 
      Connection 'con02' deleted
    To verify that the connection is deleted, issue a GET request to list the information about the specified connection or about all the connections in the connection table. For more information, see /connmgr/v1/connections: GET and /connmgr/v1/connections/<connection_name>: GET.