1Get Connection

Overview

This API retrieves details of the specified Connection.

Method: GET

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

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

Parameter Name	Type	Description	Possible Values
connection-name (Required)	String	Name of the Connection whose details need to be retrieved.	–

Responses

200 Success

{
    "configuration":[
        {
            "encrypted":"false",
            "name":"kyvos.connection.user",
            "value":"kyvos"
        },
        {
            "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":"ABCEDF123DFGFD/ABCDEF/a+g/2n6prTGDa76HYEKb5TKsZqE7Z7h9zuRdrb3n0jpJ1liSRe+Nboab46gh23454I6jUkf6fSFT/dA=="
        },
        {
            "encrypted":"false",
            "name":"kyvos.connection.properties.version",
            "value":"12"
        },
        {
            "encrypted":"false",
            "name":"kyvos.connection.url",
            "value":"https://gitlab.com/kyvos/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"
}

Status Code	Description

Status Code	Description
401	Authorization information is missing or invalid.
404	Connection, database, schema, or table not found.
500	Internal Server Error