Connections > Kafka

APIs for managing connections that use the Kafka template.

For further information about the various configuration options see Lenses documentation.

get

Returns the list of available connections

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

HTTPcURLJavaScriptPython

GET /api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/Kafka/connections HTTP/1.1
Host: 
Accept: */*

[
  {
    "name": "text",
    "lrn": "text",
    "templateName": "text",
    "templateVersion": 1,
    "tags": [
      "text"
    ],
    "deletable": true
  }
]

post

Adds a new connection

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

HTTPcURLJavaScriptPython

POST /api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/Kafka/connections HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 1066

{
  "name": "the-connection",
  "tags": [
    "text"
  ],
  "configurationObject": {
    "kafkaBootstrapServers": [
      "PLAINTEXT://kafka1:9092"
    ],
    "protocol": "PLAINTEXT",
    "sslKeystore": {
      "fileId": "123e4567-e89b-12d3-a456-426614174000"
    },
    "sslKeystorePassword": "password",
    "sslKeyPassword": "password",
    "sslTruststore": {
      "fileId": "123e4567-e89b-12d3-a456-426614174000"
    },
    "sslTruststorePassword": "password",
    "saslMechanism": "GSSAPI",
    "saslJaasConfig": "com.sun.security.auth.module.Krb5LoginModule required\n  useKeyTab=true\n  storeKey=true\n  useTicketCache=false\n  serviceName=\"kafka\"\n  principal=\"principal@MYREALM\";",
    "keytab": {
      "fileId": "123e4567-e89b-12d3-a456-426614174000"
    },
    "additionalProperties": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "metricsType": "JMX",
    "metricsPort": 9581,
    "metricsSsl": true,
    "metricsUsername": "username",
    "metricsPassword": "password",
    "metricsHttpSuffix": "/jolokia",
    "metricsHttpTimeout": 5000,
    "metricsCustomUrlMappings": {
      "kafka1:9092": "kafka1_jmx:9581"
    },
    "metricsCustomPortMappings": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "metricsRateLimitingMaxRetries": 5,
    "metricsRateLimitingBackoff": 30000
  }
}

{
  "name": "the-connection"
}

post

Adds a new connection V2

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

HTTPcURLJavaScriptPython

POST /api/v1/environments/{environment}/proxy/api/v2/connection/connection-templates/Kafka/connections HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 1180

{
  "name": "the-connection",
  "tags": [
    "text"
  ],
  "configuration": {
    "kafkaBootstrapServers": [
      "PLAINTEXT://kafka1:9092"
    ],
    "protocol": {
      "value": "PLAINTEXT"
    },
    "sslKeystore": {
      "value": {
        "fileId": "123e4567-e89b-12d3-a456-426614174000"
      }
    },
    "sslKeystorePassword": {
      "value": "password"
    },
    "sslKeyPassword": {
      "value": "password"
    },
    "sslTruststore": {
      "value": {
        "fileId": "123e4567-e89b-12d3-a456-426614174000"
      }
    },
    "sslTruststorePassword": {
      "value": "password"
    },
    "saslMechanism": "GSSAPI",
    "saslJaasConfig": "com.sun.security.auth.module.Krb5LoginModule required\n  useKeyTab=true\n  storeKey=true\n  useTicketCache=false\n  serviceName=\"kafka\"\n  principal=\"principal@MYREALM\";",
    "keytab": {
      "value": {
        "fileId": "123e4567-e89b-12d3-a456-426614174000"
      }
    },
    "additionalProperties": {
      "value": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "metricsType": {
      "value": "JMX"
    },
    "metricsPort": 9581,
    "metricsSsl": {
      "value": true
    },
    "metricsUsername": "username",
    "metricsPassword": {
      "value": "password"
    },
    "metricsHttpSuffix": "/jolokia",
    "metricsHttpTimeout": 5000,
    "metricsCustomUrlMappings": {
      "kafka1:9092": "kafka1_jmx:9581"
    },
    "metricsCustomPortMappings": {
      "value": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "metricsRateLimitingMaxRetries": 5,
    "metricsRateLimitingBackoff": 30000
  }
}

{
  "name": "the-connection"
}

post

Validates the connection

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/Kafka/connections/test

HTTPcURLJavaScriptPython

POST /api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/Kafka/connections/test HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 1064

{
  "name": "the-connection",
  "configurationObject": {
    "kafkaBootstrapServers": [
      "PLAINTEXT://kafka1:9092"
    ],
    "protocol": "PLAINTEXT",
    "sslKeystore": {
      "fileId": "123e4567-e89b-12d3-a456-426614174000"
    },
    "sslKeystorePassword": "password",
    "sslKeyPassword": "password",
    "sslTruststore": {
      "fileId": "123e4567-e89b-12d3-a456-426614174000"
    },
    "sslTruststorePassword": "password",
    "saslMechanism": "GSSAPI",
    "saslJaasConfig": "com.sun.security.auth.module.Krb5LoginModule required\n  useKeyTab=true\n  storeKey=true\n  useTicketCache=false\n  serviceName=\"kafka\"\n  principal=\"principal@MYREALM\";",
    "keytab": {
      "fileId": "123e4567-e89b-12d3-a456-426614174000"
    },
    "additionalProperties": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "metricsType": "JMX",
    "metricsPort": 9581,
    "metricsSsl": true,
    "metricsUsername": "username",
    "metricsPassword": "password",
    "metricsHttpSuffix": "/jolokia",
    "metricsHttpTimeout": 5000,
    "metricsCustomUrlMappings": {
      "kafka1:9092": "kafka1_jmx:9581"
    },
    "metricsCustomPortMappings": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "metricsRateLimitingMaxRetries": 5,
    "metricsRateLimitingBackoff": 30000
  },
  "update": true
}

No content

post

Validates the connection V2

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/Kafka/connections/test

HTTPcURLJavaScriptPython

POST /api/v1/environments/{environment}/proxy/api/v2/connection/connection-templates/Kafka/connections/test HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 1178

{
  "name": "the-connection",
  "configuration": {
    "kafkaBootstrapServers": [
      "PLAINTEXT://kafka1:9092"
    ],
    "protocol": {
      "value": "PLAINTEXT"
    },
    "sslKeystore": {
      "value": {
        "fileId": "123e4567-e89b-12d3-a456-426614174000"
      }
    },
    "sslKeystorePassword": {
      "value": "password"
    },
    "sslKeyPassword": {
      "value": "password"
    },
    "sslTruststore": {
      "value": {
        "fileId": "123e4567-e89b-12d3-a456-426614174000"
      }
    },
    "sslTruststorePassword": {
      "value": "password"
    },
    "saslMechanism": "GSSAPI",
    "saslJaasConfig": "com.sun.security.auth.module.Krb5LoginModule required\n  useKeyTab=true\n  storeKey=true\n  useTicketCache=false\n  serviceName=\"kafka\"\n  principal=\"principal@MYREALM\";",
    "keytab": {
      "value": {
        "fileId": "123e4567-e89b-12d3-a456-426614174000"
      }
    },
    "additionalProperties": {
      "value": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "metricsType": {
      "value": "JMX"
    },
    "metricsPort": 9581,
    "metricsSsl": {
      "value": true
    },
    "metricsUsername": "username",
    "metricsPassword": {
      "value": "password"
    },
    "metricsHttpSuffix": "/jolokia",
    "metricsHttpTimeout": 5000,
    "metricsCustomUrlMappings": {
      "kafka1:9092": "kafka1_jmx:9581"
    },
    "metricsCustomPortMappings": {
      "value": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "metricsRateLimitingMaxRetries": 5,
    "metricsRateLimitingBackoff": 30000
  },
  "update": true
}

No content

get

Returns the connection details

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/Kafka/connections/{name}

HTTPcURLJavaScriptPython

GET /api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/Kafka/connections/{name} HTTP/1.1
Host: 
Accept: */*

{
  "name": "the-connection",
  "lrn": "text",
  "templateVersion": 1,
  "templateName": "Kafka",
  "builtIn": true,
  "createdBy": "text",
  "createdAt": 1,
  "modifiedBy": "text",
  "modifiedAt": 1,
  "configurationObject": {
    "kafkaBootstrapServers": [
      "PLAINTEXT://kafka1:9092"
    ],
    "protocol": "PLAINTEXT",
    "sslKeystore": {
      "fileId": "123e4567-e89b-12d3-a456-426614174000"
    },
    "sslKeystorePassword": "password",
    "sslKeyPassword": "password",
    "sslTruststore": {
      "fileId": "123e4567-e89b-12d3-a456-426614174000"
    },
    "sslTruststorePassword": "password",
    "saslMechanism": "GSSAPI",
    "saslJaasConfig": "com.sun.security.auth.module.Krb5LoginModule required\n  useKeyTab=true\n  storeKey=true\n  useTicketCache=false\n  serviceName=\"kafka\"\n  principal=\"principal@MYREALM\";",
    "keytab": {
      "fileId": "123e4567-e89b-12d3-a456-426614174000"
    },
    "additionalProperties": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "metricsType": "JMX",
    "metricsPort": 9581,
    "metricsSsl": true,
    "metricsUsername": "username",
    "metricsPassword": "password",
    "metricsHttpSuffix": "/jolokia",
    "metricsHttpTimeout": 5000,
    "metricsCustomUrlMappings": {
      "kafka1:9092": "kafka1_jmx:9581"
    },
    "metricsCustomPortMappings": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "metricsRateLimitingMaxRetries": 5,
    "metricsRateLimitingBackoff": 30000
  },
  "tags": [
    "text"
  ],
  "deletable": true
}

put

Updates the connection details

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/Kafka/connections/{name}

HTTPcURLJavaScriptPython

PUT /api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/Kafka/connections/{name} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 1042

{
  "tags": [
    "text"
  ],
  "configurationObject": {
    "kafkaBootstrapServers": [
      "PLAINTEXT://kafka1:9092"
    ],
    "protocol": "PLAINTEXT",
    "sslKeystore": {
      "fileId": "123e4567-e89b-12d3-a456-426614174000"
    },
    "sslKeystorePassword": "password",
    "sslKeyPassword": "password",
    "sslTruststore": {
      "fileId": "123e4567-e89b-12d3-a456-426614174000"
    },
    "sslTruststorePassword": "password",
    "saslMechanism": "GSSAPI",
    "saslJaasConfig": "com.sun.security.auth.module.Krb5LoginModule required\n  useKeyTab=true\n  storeKey=true\n  useTicketCache=false\n  serviceName=\"kafka\"\n  principal=\"principal@MYREALM\";",
    "keytab": {
      "fileId": "123e4567-e89b-12d3-a456-426614174000"
    },
    "additionalProperties": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "metricsType": "JMX",
    "metricsPort": 9581,
    "metricsSsl": true,
    "metricsUsername": "username",
    "metricsPassword": "password",
    "metricsHttpSuffix": "/jolokia",
    "metricsHttpTimeout": 5000,
    "metricsCustomUrlMappings": {
      "kafka1:9092": "kafka1_jmx:9581"
    },
    "metricsCustomPortMappings": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "metricsRateLimitingMaxRetries": 5,
    "metricsRateLimitingBackoff": 30000
  }
}

{
  "name": "the-connection"
}

delete

Deletes the connection

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/Kafka/connections/{name}

HTTPcURLJavaScriptPython

DELETE /api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/Kafka/connections/{name} HTTP/1.1
Host: 
Accept: */*

No content

put

Updates the connection details V2

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/Kafka/connections/{name}

HTTPcURLJavaScriptPython

PUT /api/v1/environments/{environment}/proxy/api/v2/connection/connection-templates/Kafka/connections/{name} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 1156

{
  "tags": [
    "text"
  ],
  "configuration": {
    "kafkaBootstrapServers": [
      "PLAINTEXT://kafka1:9092"
    ],
    "protocol": {
      "value": "PLAINTEXT"
    },
    "sslKeystore": {
      "value": {
        "fileId": "123e4567-e89b-12d3-a456-426614174000"
      }
    },
    "sslKeystorePassword": {
      "value": "password"
    },
    "sslKeyPassword": {
      "value": "password"
    },
    "sslTruststore": {
      "value": {
        "fileId": "123e4567-e89b-12d3-a456-426614174000"
      }
    },
    "sslTruststorePassword": {
      "value": "password"
    },
    "saslMechanism": "GSSAPI",
    "saslJaasConfig": "com.sun.security.auth.module.Krb5LoginModule required\n  useKeyTab=true\n  storeKey=true\n  useTicketCache=false\n  serviceName=\"kafka\"\n  principal=\"principal@MYREALM\";",
    "keytab": {
      "value": {
        "fileId": "123e4567-e89b-12d3-a456-426614174000"
      }
    },
    "additionalProperties": {
      "value": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "metricsType": {
      "value": "JMX"
    },
    "metricsPort": 9581,
    "metricsSsl": {
      "value": true
    },
    "metricsUsername": "username",
    "metricsPassword": {
      "value": "password"
    },
    "metricsHttpSuffix": "/jolokia",
    "metricsHttpTimeout": 5000,
    "metricsCustomUrlMappings": {
      "kafka1:9092": "kafka1_jmx:9581"
    },
    "metricsCustomPortMappings": {
      "value": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "metricsRateLimitingMaxRetries": 5,
    "metricsRateLimitingBackoff": 30000
  }
}

{
  "name": "the-connection"
}