Connections > Zookeeper

APIs for managing connections that use the Zookeeper template.

DEPRECATED: This endpoint is deprecated and will be removed in a future version. Use provisioning APIs instead.

List available connections

get

Returns the list of available connections

Authorizations

bearerAuthcookieAuth

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

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/Zookeeper/connections

HTTPcURLJavaScriptPython

GET /api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/Zookeeper/connections HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "name": "text",
    "lrn": "text",
    "templateName": "text",
    "templateVersion": 1,
    "tags": [
      "text"
    ],
    "deletable": 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

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/v1/connection/connection-templates/Zookeeper/connections

HTTPcURLJavaScriptPython

POST /api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/Zookeeper/connections HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 555

{
  "name": "the-connection",
  "tags": [
    "text"
  ],
  "configurationObject": {
    "zookeeperUrls": [
      "zk1:2181"
    ],
    "zookeeperChrootPath": "/chroot/path",
    "zookeeperSessionTimeout": 5000,
    "zookeeperConnectionTimeout": 5000,
    "metricsType": "JMX",
    "metricsPort": 9581,
    "metricsUsername": "username",
    "metricsPassword": "password",
    "metricsSsl": true,
    "metricsHttpSuffix": "/jolokia",
    "metricsHttpTimeout": 5000,
    "metricsCustomUrlMappings": {
      "zk1:2181": "zk1_jmx:9585"
    },
    "metricsCustomPortMappings": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "metricsRateLimitingMaxRetries": 5,
    "metricsRateLimitingBackoff": 30000
  }
}

{
  "name": "the-connection"
}

Add a new connection V2

post

Adds a new connection V2

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

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/connection-templates/Zookeeper/connections

HTTPcURLJavaScriptPython

POST /api/v1/environments/{environment}/proxy/api/v2/connection/connection-templates/Zookeeper/connections HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 589

{
  "name": "the-connection",
  "tags": [
    "text"
  ],
  "configuration": {
    "zookeeperUrls": [
      "zk1:2181"
    ],
    "zookeeperChrootPath": "/chroot/path",
    "zookeeperSessionTimeout": 5000,
    "zookeeperConnectionTimeout": 5000,
    "metricsType": {
      "value": "JMX"
    },
    "metricsPort": 9581,
    "metricsUsername": "username",
    "metricsPassword": {
      "value": "password"
    },
    "metricsSsl": {
      "value": true
    },
    "metricsHttpSuffix": "/jolokia",
    "metricsHttpTimeout": 5000,
    "metricsCustomUrlMappings": {
      "zk1:2181": "zk1_jmx:9585"
    },
    "metricsCustomPortMappings": {
      "value": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "metricsRateLimitingMaxRetries": 5,
    "metricsRateLimitingBackoff": 30000
  }
}

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

Name of the connection

Example: the-connection

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/v1/connection/connection-templates/Zookeeper/connections/test

HTTPcURLJavaScriptPython

POST /api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/Zookeeper/connections/test HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 553

{
  "name": "the-connection",
  "configurationObject": {
    "zookeeperUrls": [
      "zk1:2181"
    ],
    "zookeeperChrootPath": "/chroot/path",
    "zookeeperSessionTimeout": 5000,
    "zookeeperConnectionTimeout": 5000,
    "metricsType": "JMX",
    "metricsPort": 9581,
    "metricsUsername": "username",
    "metricsPassword": "password",
    "metricsSsl": true,
    "metricsHttpSuffix": "/jolokia",
    "metricsHttpTimeout": 5000,
    "metricsCustomUrlMappings": {
      "zk1:2181": "zk1_jmx:9585"
    },
    "metricsCustomPortMappings": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "metricsRateLimitingMaxRetries": 5,
    "metricsRateLimitingBackoff": 30000
  },
  "update": true
}

No content

Validate a connection V2

post

Validates the connection V2

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

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/connection-templates/Zookeeper/connections/test

HTTPcURLJavaScriptPython

POST /api/v1/environments/{environment}/proxy/api/v2/connection/connection-templates/Zookeeper/connections/test HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 587

{
  "name": "the-connection",
  "configuration": {
    "zookeeperUrls": [
      "zk1:2181"
    ],
    "zookeeperChrootPath": "/chroot/path",
    "zookeeperSessionTimeout": 5000,
    "zookeeperConnectionTimeout": 5000,
    "metricsType": {
      "value": "JMX"
    },
    "metricsPort": 9581,
    "metricsUsername": "username",
    "metricsPassword": {
      "value": "password"
    },
    "metricsSsl": {
      "value": true
    },
    "metricsHttpSuffix": "/jolokia",
    "metricsHttpTimeout": 5000,
    "metricsCustomUrlMappings": {
      "zk1:2181": "zk1_jmx:9585"
    },
    "metricsCustomPortMappings": {
      "value": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "metricsRateLimitingMaxRetries": 5,
    "metricsRateLimitingBackoff": 30000
  },
  "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/v1/connection/connection-templates/Zookeeper/connections/{name}

HTTPcURLJavaScriptPython

GET /api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/Zookeeper/connections/{name} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "name": "the-connection",
  "lrn": "text",
  "templateVersion": 1,
  "templateName": "Kafka",
  "builtIn": true,
  "createdBy": "text",
  "createdAt": 1,
  "modifiedBy": "text",
  "modifiedAt": 1,
  "configurationObject": {
    "zookeeperUrls": [
      "zk1:2181"
    ],
    "zookeeperChrootPath": "/chroot/path",
    "zookeeperSessionTimeout": 5000,
    "zookeeperConnectionTimeout": 5000,
    "metricsType": "JMX",
    "metricsPort": 9581,
    "metricsUsername": "username",
    "metricsPassword": "password",
    "metricsSsl": true,
    "metricsHttpSuffix": "/jolokia",
    "metricsHttpTimeout": 5000,
    "metricsCustomUrlMappings": {
      "zk1:2181": "zk1_jmx:9585"
    },
    "metricsCustomPortMappings": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "metricsRateLimitingMaxRetries": 5,
    "metricsRateLimitingBackoff": 30000
  },
  "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

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/v1/connection/connection-templates/Zookeeper/connections/{name}

HTTPcURLJavaScriptPython

PUT /api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/Zookeeper/connections/{name} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 531

{
  "tags": [
    "text"
  ],
  "configurationObject": {
    "zookeeperUrls": [
      "zk1:2181"
    ],
    "zookeeperChrootPath": "/chroot/path",
    "zookeeperSessionTimeout": 5000,
    "zookeeperConnectionTimeout": 5000,
    "metricsType": "JMX",
    "metricsPort": 9581,
    "metricsUsername": "username",
    "metricsPassword": "password",
    "metricsSsl": true,
    "metricsHttpSuffix": "/jolokia",
    "metricsHttpTimeout": 5000,
    "metricsCustomUrlMappings": {
      "zk1:2181": "zk1_jmx:9585"
    },
    "metricsCustomPortMappings": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "metricsRateLimitingMaxRetries": 5,
    "metricsRateLimitingBackoff": 30000
  }
}

{
  "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/connection-templates/Zookeeper/connections/{name}

HTTPcURLJavaScriptPython

DELETE /api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/Zookeeper/connections/{name} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update connection details V2

put

Updates the connection details V2

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

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/connection-templates/Zookeeper/connections/{name}

HTTPcURLJavaScriptPython

PUT /api/v1/environments/{environment}/proxy/api/v2/connection/connection-templates/Zookeeper/connections/{name} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 565

{
  "tags": [
    "text"
  ],
  "configuration": {
    "zookeeperUrls": [
      "zk1:2181"
    ],
    "zookeeperChrootPath": "/chroot/path",
    "zookeeperSessionTimeout": 5000,
    "zookeeperConnectionTimeout": 5000,
    "metricsType": {
      "value": "JMX"
    },
    "metricsPort": 9581,
    "metricsUsername": "username",
    "metricsPassword": {
      "value": "password"
    },
    "metricsSsl": {
      "value": true
    },
    "metricsHttpSuffix": "/jolokia",
    "metricsHttpTimeout": 5000,
    "metricsCustomUrlMappings": {
      "zk1:2181": "zk1_jmx:9585"
    },
    "metricsCustomPortMappings": {
      "value": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "metricsRateLimitingMaxRetries": 5,
    "metricsRateLimitingBackoff": 30000
  }
}

{
  "name": "the-connection"
}