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.

List connection templates

get

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)

Authorizations

bearerAuthcookieAuth

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

Query parameters

kindstring · enumOptional

Filter by template kind

Possible values:

Responses

200Success

application/json

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

get

/api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates

HTTPcURLJavaScriptPython

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
  }
]

Add a new connection

post

Adds a new connection

Authorizations

bearerAuthcookieAuth

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

Body

application/json

namestringRequired

Name of the connection

Example: the-connection

tagsstring[]Optional

templateNamestring · min: 1Required

The template of the connection

Example: Kafka

configurationobjectOptional

The configuration of the connection. The schema of this object is defined by the template configuration

Responses

201Success

application/json

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

post

/api/v1/environments/{environment}/proxy/api/v2/connection/connections

HTTPcURLJavaScriptPython

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"
}

Validate a connection

post

Validates the connection

Authorizations

bearerAuthcookieAuth

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

Body

application/json

namestringRequired

templateNamestring · min: 1Required

The template of the connection

Example: Kafka

configurationobjectOptional

The configuration of the connection. The schema of this object is defined by the template configuration

updatebooleanOptional

true if testing an update to an existing connection, false if testing a new connection

Responses

200Success

No content

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

post

/api/v1/environments/{environment}/proxy/api/v2/connection/connections/test

HTTPcURLJavaScriptPython

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

Get connection details

get

Returns the connection details

Authorizations

bearerAuthcookieAuth

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

namestringRequired

The name of the connection

Responses

200Success

application/json

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

get

/api/v1/environments/{environment}/proxy/api/v2/connection/connections/{name}

HTTPcURLJavaScriptPython

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
}

Update connection details

put

Updates the connection details

Authorizations

bearerAuthcookieAuth

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

namestringRequired

The name of the connection

Body

application/json

tagsstring[]Optional

templateNamestring · min: 1Optional

configurationobjectOptional

Responses

200Success

application/json

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

409

The supplied identifier is already being used by another resource

application/json

500

An internal server error has occurred

application/json

put

/api/v1/environments/{environment}/proxy/api/v2/connection/connections/{name}

HTTPcURLJavaScriptPython

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"
}

Delete a connection

delete

Deletes the connection

Authorizations

bearerAuthcookieAuth

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

namestringRequired

The name of the connection

Responses

200Success

No content

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

409

The supplied identifier is already being used by another resource

application/json

500

An internal server error has occurred

application/json

delete

/api/v1/environments/{environment}/proxy/api/v1/connection/connections/{name}

HTTPcURLJavaScriptPython

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

post

Upload a file

Authorizations

bearerAuthcookieAuth

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

Body

multipart/form-data

filestring · binaryRequired

Responses

200Success

application/json

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

post

/api/v1/environments/{environment}/proxy/api/v1/files

HTTPcURLJavaScriptPython

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"
}