1Get Connections List
Overview
This API retrieves a list of available Connections.
Method: GET
Request URL: {kyvos-url}/rest/v2/connections
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. | – |
Query Parameters
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
connectionType | String | Specifies the type of Connections to retrieve. If not provided, all types of Connections are returned. | ALL: Get list of all the connections. BUILD: Get list of build connections. Default: ALL |
Responses
200 Success
{
"connections":[
{
"configuration":[
{
"encrypted":"false",
"name":"kyvos.connection.user",
"value":"admin"
},
{
"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":"ABHYSHF4275DSK/PBdmyX37d4QZ/a+g/2n6prTGDaVn6DDKb5TKsZqE7Z7hF5lxmvjK9SP7zuRdrb3n0jpJ14I6jUkf6fSFT/dA=="
},
{
"encrypted":"false",
"name":"kyvos.connection.properties.version",
"value":"12"
},
{
"encrypted":"false",
"name":"kyvos.connection.url",
"value":"https://gitlab.com/admin/demoutility"
},
{
"encrypted":"false",
"name":"kyvos.connection.name",
"value":"GitConnection"
},
{
"encrypted":"false",
"name":"kyvos.connection.authenticationtype",
"value":"PAT"
},
{
"encrypted":"false",
"name":"kyvos.connection.lastUpdateTimestamp",
"value":"1778242779877"
}
],
"name":"GitConnection",
"accessRights":"1"
},
{
"configuration":[
{
"encrypted":"false",
"name":"kyvos.connection.version",
"value":"13.3"
},
{
"encrypted":"false",
"name":"kyvos.connection.server",
"value":"172.26.43.21"
},
{
"encrypted":"false",
"name":"kyvos.connection.isEncryptedConnection",
"value":"true"
},
{
"encrypted":"false",
"name":"kyvos.connection.provider",
"value":"POSTGRESQL"
},
{
"encrypted":"false",
"name":"kyvos.connection.properties.version",
"value":"12"
},
{
"encrypted":"false",
"name":"kyvos.connection.port",
"value":"45421"
},
{
"encrypted":"false",
"name":"kyvos.connection.display.name",
"value":"DemoConnection"
},
{
"encrypted":"false",
"name":"kyvos.connection.lastUpdateTimestamp",
"value":"1779809277063"
},
{
"encrypted":"false",
"name":"kyvos.connection.pooling.enabled",
"value":"lazy"
},
{
"encrypted":"false",
"name":"kyvos.connection.user",
"value":"postgres"
},
{
"encrypted":"true",
"name":"kyvos.connection.password",
"value":"KHKHhkh22+LSHDLHS8SDKSDS/325DxGJIVMXQsXR8cOt/t5oRRckh5vpk="
},
{
"encrypted":"false",
"name":"kyvos.connection.database",
"value":"demorepo"
},
{
"encrypted":"false",
"name":"kyvos.connection.name",
"value":"DemoDBConnection"
},
{
"encrypted":"false",
"name":"kyvos.connection.isrepository",
"value":"true"
}
],
"name":"DemoRepositoryDB",
"accessRights":"1"
}
]
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | Connection, database, schema, or table not found. |
500 | Internal Server Error |