Connections
APIs for managing connections to external systems.
DEPRECATED: This endpoint is deprecated and will be removed in a future version. Use provisioning APIs instead.
Lists all connections templates.
A connection's template defines the type of the connection, and the schema of it's configuration. (DEPRECATED: Use provisioning instead)
The bearer token can be obtained by creating a ServiceAccount.
Filter by template kind
The request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
An internal server error has occurred
GET /api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"name": "Kafka",
"templateVersion": 1,
"version": "text",
"enabled": true,
"builtIn": true,
"category": "Connection",
"type": "Not Applicable",
"kind": "Not Applicable",
"metadata": {
"author": "text",
"description": "text"
},
"configuration": [
{
"key": "text",
"displayName": "text",
"placeholder": "text",
"description": "text",
"type": {
"name": "STRING",
"displayName": "text"
},
"enumValues": [
"text"
],
"required": true,
"mounted": true,
"provided": true
}
],
"jsonSchema": {},
"creatable": true
}
]Adds a new connection
The bearer token can be obtained by creating a ServiceAccount.
Name of the connection
the-connectionThe configuration of the connection. The schema of this object is defined by the template configuration
The request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
An internal server error has occurred
POST /api/v1/environments/{environment}/proxy/api/v2/connection/connections HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 83
{
"name": "the-connection",
"tags": [
"text"
],
"templateName": "Kafka",
"configuration": {}
}{
"name": "the-connection"
}Validates the connection
The bearer token can be obtained by creating a ServiceAccount.
The configuration of the connection. The schema of this object is defined by the template configuration
true if testing an update to an existing connection, false if testing a new connection
No content
The request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
An internal server error has occurred
POST /api/v1/environments/{environment}/proxy/api/v2/connection/connections/test HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 71
{
"name": "text",
"templateName": "Kafka",
"configuration": {},
"update": true
}No content
Returns the connection details
The bearer token can be obtained by creating a ServiceAccount.
The name of the connection
The request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
An internal server error has occurred
GET /api/v1/environments/{environment}/proxy/api/v2/connection/connections/{name} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"name": "the-connection",
"lrn": "Lenses Resource Name",
"templateVersion": 1,
"templateName": "Kafka",
"builtIn": true,
"createdBy": "text",
"createdAt": 1,
"modifiedBy": "text",
"modifiedAt": 1,
"configuration": {},
"tags": [
"text"
],
"deletable": true
}Updates the connection details
The bearer token can be obtained by creating a ServiceAccount.
The name of the connection
The request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
The supplied identifier is already being used by another resource
An internal server error has occurred
PUT /api/v1/environments/{environment}/proxy/api/v2/connection/connections/{name} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58
{
"tags": [
"text"
],
"templateName": "text",
"configuration": {}
}{
"name": "the-connection"
}Deletes the connection
The bearer token can be obtained by creating a ServiceAccount.
The name of the connection
No content
The request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
The supplied identifier is already being used by another resource
An internal server error has occurred
DELETE /api/v1/environments/{environment}/proxy/api/v1/connection/connections/{name} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Upload a file
The bearer token can be obtained by creating a ServiceAccount.
The request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
An internal server error has occurred
POST /api/v1/environments/{environment}/proxy/api/v1/files HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17
{
"file": "binary"
}{
"id": "45447f25-3ad2-441d-b849-49bf696606b8",
"filename": "keystore.jks",
"uploadedBy": "user",
"uploadedAt": "2021-01-01T00:00:00Z",
"size": 1024,
"contentType": "application/x-java-keystore"
}Last updated
Was this helpful?