1Get Connection Metadata
Overview
This API retrieves the metadata for a specified provider and connection category. The returned metadata can be used to create connections by supplying the required and optional properties for the selected provider and connection type.
Method: GET
Request URL: {kyvos-url}/rest/v2/connections/metadata
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 |
|---|---|---|---|
category (Required) | String | The category of the connection as displayed in the UI (for example, The value is case-insensitive and must match one of the available connection categories. | – |
provider (Required) | String | The display name of the connection provider as shown in the UI (for example, The value is case-insensitive. | – |
Responses
200 Success
{
"properties": [
{
"isRequired": "true",
"insertURL": "false",
"displayName": "Connection Name",
"defaultValue": "",
"maxValue": "",
"description": "",
"preDefinedValues": [],
"applicableForValues": {
"parentParam": "",
"values": [],
"defaultValues": []
},
"defaultVisibility": "true",
"readOnly": "true",
"type": "TEXT",
"minValue": "",
"dependentParam": "false",
"decimalPlaces": 2,
"name": "kyvos.connection.name",
"isDecimal": false,
"conditions": []
},
{
"isRequired": "false",
"insertURL": "false",
"displayName": "Access ID",
"defaultValue": "",
"maxValue": "",
"description": "The property provides the access id for accessing aws services.",
"preDefinedValues": [],
"applicableForValues": {
"parentParam": "",
"values": [],
"defaultValues": []
},
"defaultVisibility": "true",
"readOnly": "false",
"type": "PASSWORD",
"minValue": "",
"dependentParam": "false",
"decimalPlaces": 2,
"name": "aws_bedrock_access_id",
"isDecimal": false,
"conditions": []
},
{
"isRequired": "false",
"insertURL": "false",
"displayName": "Secret Key",
"defaultValue": "",
"maxValue": "",
"description": "The property provides the secret key for accessing aws services.",
"preDefinedValues": [],
"applicableForValues": {
"parentParam": "",
"values": [],
"defaultValues": []
},
"defaultVisibility": "true",
"readOnly": "false",
"type": "PASSWORD",
"minValue": "",
"dependentParam": "false",
"decimalPlaces": 2,
"name": "aws_bedrock_secret_key",
"isDecimal": false,
"conditions": []
}
],
"advanceProperties": [
{
"note": "",
"full_name": "mapreduce.job.reduces",
"keywords": "",
"deprecated": true,
"name": "mapreduce.job.reduces",
"description": "<table class='custom-tbl col-tbl'><tr><td colspan='2'><p class='pd-b16'>The property is used to specify the number of tasks for the reduce stage of semantic model data process jobs. The value should be set based on the data volume to be processed, the capacity of the cluster, and the memory allocated to the job.</p></td></tr><tr><td><label>Default Value</label></td><td>120</td></tr></table>",
"default_val": "120",
"parentGroup": "Hadoop",
"type": "textbox",
"group": "MapReduce"
},
{
"note": "",
"full_name": "mapreduce.input.fileinputformat.input.dir.recursive",
"keywords": "",
"sub_type": "",
"deprecated": true,
"name": "mapreduce.input.fileinputformat.input.dir.recursive",
"description": "",
"default_val": "",
"parentGroup": "Hadoop",
"type": "textbox",
"group": "MapReduce"
},
{
"note": "",
"full_name": "yarn.timeline-service.enabled",
"keywords": "",
"sub_type": "",
"deprecated": true,
"name": "yarn.timeline-service.enabled",
"description": "",
"default_val": "",
"parentGroup": "Hadoop",
"type": "textbox",
"group": "MapReduce"
},
{
"note": "",
"full_name": "mapreduce.map.memory.mb",
"keywords": "",
"deprecated": true,
"name": "mapreduce.map.memory.mb",
"description": "<table class='custom-tbl col-tbl'><tr><td colspan='2'><p class='pd-b16'>The property is used to specify the container memory for the map tasks in the MapReduce jobs launched during the semantic model data process. The value of the mapreduce.map.memory.opts property should be set to 55-65% of the memory specified in this property.</p></td></tr><tr><td><label>Default Value</label></td><td>8192</td></tr></table>",
"default_val": "8192",
"parentGroup": "Hadoop",
"type": "textbox",
"group": "MapReduce"
}
]
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
412 | Precondition failed. Parameter missing. |
500 | Internal Server Error |