Delete Connection
This documentation is for Kyvos 2026.8.x. To view documentation for other Kyvos versions, click here. |
|---|
Overview
This API deletes the specified Connection.
Method: DELETE
Request URL: {kyvos-url}/rest/v2/connections/{connection-name}
Authorization
API Key: sessionid
This method authenticates requests using a session ID which acts like an API key.
BasicAuth: HTTP Authorization Scheme
This method authenticates requests using a username and password sent in the HTTP Authorization header.
Headers
Header Name | Type | Description | Possible Values |
|---|---|---|---|
sessionid | String | The session ID is the token received from the login API. Note: Session ID is required for token-based authentication. | – |
Path Parameters
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
connection-name (Required) | String | Name of the Connection that needs to be deleted. | – |
Responses
200 Success
{
"code": 0,
"message": "Connection deleted successfully."
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | Connection, database, schema, or table not found. |
500 | Internal Server Error. |