Update Connection
This documentation is for Kyvos 2026.8.x. To view documentation for other Kyvos versions, click here. |
|---|
Overview
This API updates an existing Connection.
Method: PUT
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 |
|---|---|---|---|
Content-Type (Required) | String | Specifies media type of request body. |
|
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 Connection that needs to be updated. | – |
Request Body
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
json (Required) | String | JSON definition containing the Connection details required to update the existing Connection. Note: An example JSON is provided under the Resources section below. | – |
Responses
200 Success
{
"code": 0,
"message": "Connection updated successfully."
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | Connection, database, schema, or table not found. |
412 | Precondition failed. Required parameter missing. |
500 | Internal Server Error |
Resources
Below is an example of JSON structure which can be used as a reference for the json parameter in the request body.
{
"configuration":[
{
"encrypted":"false",
"name":"kyvos.connection.user",
"value":"kyvos user"
},
{
"encrypted":"false",
"name":"kyvos.connection.version",
"value":""
},
{
"encrypted":"false",
"name":"kyvos.connection.isEncryptedConnection",
"value":"true"
},
{
"encrypted":"false",
"name":"kyvos.connection.provider",
"value":"GITLAB"
},
{
"encrypted":"true",
"name":"kyvos.connection.password",
"value":"Rw43Hf6KRjg4ZOFfkbTAkk7EZc/PBdmyX37d4QZ/a+g/2n6prTGDaVn6DDKb5TKsZqE7Z7hF5lxmvjK9SP7zuRdrb3n0jpJ1liSRe+Nbo9WfjdoccqV4I6jUkf6fSFT/dA=="
},
{
"encrypted":"false",
"name":"kyvos.connection.properties.version",
"value":"12"
},
{
"encrypted":"false",
"name":"kyvos.connection.url",
"value":"https://gitlab.intkyv.com/kyvos/kyvospushpullutility"
},
{
"encrypted":"false",
"name":"kyvos.connection.name",
"value":"TestConnection"
},
{
"encrypted":"false",
"name":"kyvos.connection.authenticationtype",
"value":"PAT"
},
{
"encrypted":"false",
"name":"kyvos.connection.lastUpdateTimestamp",
"value":"1778242779877"
}
],
"name":"TestConnection",
"accessRights":"1"
}