Update Connector Instance

Update Connector Instance

Update the Connector Configuration e.g. number of tasks replicationFactor, add remove topics for replication

Request
URI
PUT
https://{api_host}/tcsa.host.com/dcc/v1/connectors/{connector-name}
COPY
Path Parameters
string
connector-name
Required

Instance id of the connector

connector-name example 
demo-connector
Request Body

Update the Connector Configuration e.g. number of tasks replicationFactor, add remove topics for replication

UpdateConnectorRequest of type(s) application/json
Required

Show optional properties

{
    "targetCluster": {
        "authentication": {
            "accessToken": "access token",
            "certificate": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURCRENDQWV3Q0UxOVF2d25uR25YNWREemZQR2huYXZEU0ZKSXdEUVlKS29aSWh2Y05BUUVMQlFBd1B6RWIKTUJrR0ExVUVDZ3dTVmsxWFlYSmxJRVZ1WjJsdVpXVnlhVzVuTVNBd0hnWURWUVFEREJkMFkyOXdjeTV6ZG1NdQpZMngxYzNSbGNpNXNiMk5oYkRBZUZ3MHlNakF4TVRneE5qSTJNVE5hRncweU16QXhNVGd4TmpJMk1UTmFNRDh4CklEQWVCZ05WQkFNTUYzUmpiM0J6TG5OMll5NWpiSFZ6ZEdWeUxteHZZMkZzTVJzd0dRWURWUVFLREJKV1RWZGgKY21VZ1JXNW5hVzVsWlhKcGJtY3dnZ0VpTUEwR0NTcUdTSWIzRFFFQkFRVUFBNElCRHdBd2dnRUtBb0lCQVFDdQpoNklsUDMzTFBXM2FTbXd6SFRoTGkzMjFPMThDRVlSWW1pNzBBa2xHWXNzbUh0VG0rL2tvYk0yOHc1V1IwSS92CkJzVHdQaW4wT3ZINXg4dTlJY0ZSTnN0TTFraHJoRmo2SlR0a05CanVxK0huZkxBdjFiSS9RNUVySVQ4aUp5TVgKV2MwTGltUEhpK090ODZCaGQ5QWJwNjlMcTdjbDRReXBWb1dNalFWV01Dc0w2S3R0NTlGOEFGeDVtS25UV1lRbApaNWxYK2NxcGE5ZFVRNXBSdDVRZ04xWUJ6N0c2eFFOS1pERHZrdnVkRm9nMUlyZnNmaTV2d3ByZHJ0OW55Uy9vCnVkcDIyVUpjSjFiYnBnZU5keWMrRWE3ci8zRG5SUXdDY1VMUnZ2WWJUbHdueFVwYXFRN3NYblB3UitvN2ttV0EKTDg0aEZiZlBkS0FaaVJYdml6VnRBZ01CQUFFd0RRWUpLb1pJaHZjTkFRRUxCUUFEZ2dFQkFDaUpUVTQrTlkrZApmMVhaS2s5RTd3QllTY1psdzI4RnJhcnkrVUJzYkJYYVc1R1Z6RXdpdDV1YkRZYjlGc2VhdGdGY0lCbkR5Rkp2CnBlSXovaUxHVWIvQ1VRa3EzSndKSEthRmRWNkdQWmp3WVd3MktXaEtRYVhlTUIvUXpuZkNQNTdWaENlQnlVMVYKSjl5V3VWUGkzZkh1KzJtMThiYU1Ub2o2UTlrdjBsRVVLc3I3NzVOYnJ1QzVOZ3lMK3d0bmx0S0pXUEJNNmdLVgpOc3BrRmRqQU9DTGdqUTlYSWVIdWtodllTYTU5cURySHhKR3NnNmRTeUVnbFBxRW5zUkRnemJkVWg1Ukp2NUtPCkFZL0IweXJsMTFoc1Y2YUpiS1ZBVERDV0J0dXlaRURLSFVPcUg5VWNPR0NRcmR6T0YxRjdaNlYxQVg0cVpzcmoKY25jTUt0YWZQRk09Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0",
            "clientId": "clientId",
            "clientSecret": "clientSecret",
            "enabled": true,
            "key": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURCRENDQWV3Q0UxOVF2d25uR25YNWREemZQR2huYXZEU0ZKSXdEUVlKS29aSWh2Y05BUUVMQlFBd1B6RWIKTUJrR0ExVUVDZ3dTVmsxWFlYSmxJRVZ1WjJsdVpXVnlhVzVuTVNBd0hnWURWUVFEREJkMFkyOXdjeTV6ZG1NdQpZMngxYzNSbGNpNXNiMk5oYkRBZUZ3MHlNakF4TVRneE5qSTJNVE5hRncweU16QXhNVGd4TmpJMk1UTmFNRDh4CklEQWVCZ05WQkFNTUYzUmpiM0J6TG5OMll5NWpiSFZ6ZEdWeUxteHZZMkZzTVJzd0dRWURWUVFLREJKV1RWZGgKY21VZ1JXNW5hVzVsWlhKcGJtY3dnZ0VpTUEwR0NTcUdTSWIzRFFFQkFRVUFBNElCRHdBd2dnRUtBb0lCQVFDdQpoNklsUDMzTFBXM2FTbXd6SFRoTGkzMjFPMThDRVlSWW1pNzBBa2xHWXNzbUh0VG0rL2tvYk0yOHc1V1IwSS92CkJzVHdQaW4wT3ZINXg4dTlJY0ZSTnN0TTFraHJoRmo2SlR0a05CanVxK0huZkxBdjFiSS9RNUVySVQ4aUp5TVgKV2MwTGltUEhpK090ODZCaGQ5QWJwNjlMcTdjbDRReXBWb1dNalFWV01Dc0w2S3R0NTlGOEFGeDVtS25UV1lRbApaNWxYK2NxcGE5ZFVRNXBSdDVRZ04xWUJ6N0c2eFFOS1pERHZrdnVkRm9nMUlyZnNmaTV2d3ByZHJ0OW55Uy9vCnVkcDIyVUpjSjFiYnBnZU5keWMrRWE3ci8zRG5SUXdDY1VMUnZ2WWJUbHdueFVwYXFRN3NYblB3UitvN2ttV0EKTDg0aEZiZlBkS0FaaVJYdml6VnRBZ01CQUFFd0RRWUpLb1pJaHZjTkFRRUxCUUFEZ2dFQkFDaUpUVTQrTlkrZApmMVhaS2s5RTd3QllTY1psdzI4RnJhcnkrVUJzYkJYYVc1R1Z6RXdpdDV1YkRZYjlGc2VhdGdGY0lCbkR5Rkp2CnBlSXovaUxHVWIvQ1VRa3EzSndKSEthRmRWNkdQWmp3WVd3MktXaEtRYVhlTUIvUXpuZkNQNTdWaENlQnlVMVYKSjl5V3VWUGkzZkh1KzJtMThiYU1Ub2o2UTlrdjBsRVVLc3I3NzVOYnJ1QzVOZ3lMK3d0bmx0S0pXUEJNNmdLVgpOc3BrRmRqQU9DTGdqUTlYSWVIdWtodllTYTU5cURySHhKR3NnNmRTeUVnbFBxRW5zUkRnemJkVWg1Ukp2NUtPCkFZL0IweXJsMTFoc1Y2YUpiS1ZBVERDV0J0dXlaRURLSFVPcUg5VWNPR0NRcmR6T0YxRjdaNlYxQVg0cVpzcmoKY25jTUt0YWZQRk09Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0",
            "oauthCertificate": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURCRENDQWV3Q0UxOVF2d25uR25YNWREemZQR2huYXZEU0ZKSXdEUVlKS29aSWh2Y05BUUVMQlFBd1B6RWIKTUJrR0ExVUVDZ3dTVmsxWFlYSmxJRVZ1WjJsdVpXVnlhVzVuTVNBd0hnWURWUVFEREJkMFkyOXdjeTV6ZG1NdQpZMngxYzNSbGNpNXNiMk5oYkRBZUZ3MHlNakF4TVRneE5qSTJNVE5hRncweU16QXhNVGd4TmpJMk1UTmFNRDh4CklEQWVCZ05WQkFNTUYzUmpiM0J6TG5OMll5NWpiSFZ6ZEdWeUxteHZZMkZzTVJzd0dRWURWUVFLREJKV1RWZGgKY21VZ1JXNW5hVzVsWlhKcGJtY3dnZ0VpTUEwR0NTcUdTSWIzRFFFQkFRVUFBNElCRHdBd2dnRUtBb0lCQVFDdQpoNklsUDMzTFBXM2FTbXd6SFRoTGkzMjFPMThDRVlSWW1pNzBBa2xHWXNzbUh0VG0rL2tvYk0yOHc1V1IwSS92CkJzVHdQaW4wT3ZINXg4dTlJY0ZSTnN0TTFraHJoRmo2SlR0a05CanVxK0huZkxBdjFiSS9RNUVySVQ4aUp5TVgKV2MwTGltUEhpK090ODZCaGQ5QWJwNjlMcTdjbDRReXBWb1dNalFWV01Dc0w2S3R0NTlGOEFGeDVtS25UV1lRbApaNWxYK2NxcGE5ZFVRNXBSdDVRZ04xWUJ6N0c2eFFOS1pERHZrdnVkRm9nMUlyZnNmaTV2d3ByZHJ0OW55Uy9vCnVkcDIyVUpjSjFiYnBnZU5keWMrRWE3ci8zRG5SUXdDY1VMUnZ2WWJUbHdueFVwYXFRN3NYblB3UitvN2ttV0EKTDg0aEZiZlBkS0FaaVJYdml6VnRBZ01CQUFFd0RRWUpLb1pJaHZjTkFRRUxCUUFEZ2dFQkFDaUpUVTQrTlkrZApmMVhaS2s5RTd3QllTY1psdzI4RnJhcnkrVUJzYkJYYVc1R1Z6RXdpdDV1YkRZYjlGc2VhdGdGY0lCbkR5Rkp2CnBlSXovaUxHVWIvQ1VRa3EzSndKSEthRmRWNkdQWmp3WVd3MktXaEtRYVhlTUIvUXpuZkNQNTdWaENlQnlVMVYKSjl5V3VWUGkzZkh1KzJtMThiYU1Ub2o2UTlrdjBsRVVLc3I3NzVOYnJ1QzVOZ3lMK3d0bmx0S0pXUEJNNmdLVgpOc3BrRmRqQU9DTGdqUTlYSWVIdWtodllTYTU5cURySHhKR3NnNmRTeUVnbFBxRW5zUkRnemJkVWg1Ukp2NUtPCkFZL0IweXJsMTFoc1Y2YUpiS1ZBVERDV0J0dXlaRURLSFVPcUg5VWNPR0NRcmR6T0YxRjdaNlYxQVg0cVpzcmoKY25jTUt0YWZQRk09Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0",
            "oauthType": "clientSecret",
            "password": "kafka_password",
            "refreshToken": "refresh token",
            "tls": true,
            "tokenEndpointUri": "http://10.192.255.163:8180/auth/realms/access-gateway/protocol/openid-connect/token",
            "type": "plain",
            "username": "kafka_username"
        },
        "tls": {
            "certificate": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURCRENDQWV3Q0UxOVF2d25uR25YNWREemZQR2huYXZEU0ZKSXdEUVlKS29aSWh2Y05BUUVMQlFBd1B6RWIKTUJrR0ExVUVDZ3dTVmsxWFlYSmxJRVZ1WjJsdVpXVnlhVzVuTVNBd0hnWURWUVFEREJkMFkyOXdjeTV6ZG1NdQpZMngxYzNSbGNpNXNiMk5oYkRBZUZ3MHlNakF4TVRneE5qSTJNVE5hRncweU16QXhNVGd4TmpJMk1UTmFNRDh4CklEQWVCZ05WQkFNTUYzUmpiM0J6TG5OMll5NWpiSFZ6ZEdWeUxteHZZMkZzTVJzd0dRWURWUVFLREJKV1RWZGgKY21VZ1JXNW5hVzVsWlhKcGJtY3dnZ0VpTUEwR0NTcUdTSWIzRFFFQkFRVUFBNElCRHdBd2dnRUtBb0lCQVFDdQpoNklsUDMzTFBXM2FTbXd6SFRoTGkzMjFPMThDRVlSWW1pNzBBa2xHWXNzbUh0VG0rL2tvYk0yOHc1V1IwSS92CkJzVHdQaW4wT3ZINXg4dTlJY0ZSTnN0TTFraHJoRmo2SlR0a05CanVxK0huZkxBdjFiSS9RNUVySVQ4aUp5TVgKV2MwTGltUEhpK090ODZCaGQ5QWJwNjlMcTdjbDRReXBWb1dNalFWV01Dc0w2S3R0NTlGOEFGeDVtS25UV1lRbApaNWxYK2NxcGE5ZFVRNXBSdDVRZ04xWUJ6N0c2eFFOS1pERHZrdnVkRm9nMUlyZnNmaTV2d3ByZHJ0OW55Uy9vCnVkcDIyVUpjSjFiYnBnZU5keWMrRWE3ci8zRG5SUXdDY1VMUnZ2WWJUbHdueFVwYXFRN3NYblB3UitvN2ttV0EKTDg0aEZiZlBkS0FaaVJYdml6VnRBZ01CQUFFd0RRWUpLb1pJaHZjTkFRRUxCUUFEZ2dFQkFDaUpUVTQrTlkrZApmMVhaS2s5RTd3QllTY1psdzI4RnJhcnkrVUJzYkJYYVc1R1Z6RXdpdDV1YkRZYjlGc2VhdGdGY0lCbkR5Rkp2CnBlSXovaUxHVWIvQ1VRa3EzSndKSEthRmRWNkdQWmp3WVd3MktXaEtRYVhlTUIvUXpuZkNQNTdWaENlQnlVMVYKSjl5V3VWUGkzZkh1KzJtMThiYU1Ub2o2UTlrdjBsRVVLc3I3NzVOYnJ1QzVOZ3lMK3d0bmx0S0pXUEJNNmdLVgpOc3BrRmRqQU9DTGdqUTlYSWVIdWtodllTYTU5cURySHhKR3NnNmRTeUVnbFBxRW5zUkRnemJkVWg1Ukp2NUtPCkFZL0IweXJsMTFoc1Y2YUpiS1ZBVERDV0J0dXlaRURLSFVPcUg5VWNPR0NRcmR6T0YxRjdaNlYxQVg0cVpzcmoKY25jTUt0YWZQRk09Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0",
            "enabled": true
        },
        "bootstrapServers": "target-kafka-cluster:9092"
    },
    "topics": [
        "string"
    ]
}
{
    "tasksMax": 6,
    "replicationFactor": 2,
    "topics": [
        "string"
    ],
    "targetCluster": {
        "bootstrapServers": "target-kafka-cluster:9092",
        "tls": {
            "enabled": true,
            "certificate": "base64 encoded certificate"
        },
        "authentication": {
            "enabled": true,
            "type": "auth type plain/scram-sha-512/oauth/tls",
            "username": "targetuser",
            "password": "target password"
        }
    },
    "logging": {
        "type": "inline",
        "level": "INFO"
    },
    "resources": {
        "limits": {
            "cpu": "4000m",
            "memory": "8192Mi"
        },
        "requests": {
            "cpu": "1000m",
            "memory": "2048Mi"
        }
    }
}
number
tasksMax
Optional

The maximum number of tasks for the Kafka Connector.

number
replicationFactor
Optional

Replication factor for the internal topics and replicated topics.

array of string
topics
Required

Topic names to be replicated

TargetClusterObject
targetCluster
Required

Object having details of target kafka cluster and authentication

LoggingObject
logging
Optional

Logging object containing logging type and logging level

ResourcesObject
resources
Optional

Maximum limits for CPU and memory resources and the requested initial resources.

Authentication
This operation uses the following authentication methods.
Responses
200

Returns the Config for updated connector

Returns UpdateConnectorResponse of type(s) application/json 
{
    "message": "Connector successfully updated",
    "time": "2022-03-29 10:08:55.346489",
    "name": "dashboardkafka",
    "instanceId": "dashboardkafka",
    "display_name": "DashboardKafka",
    "status": "pending"
}
string
display_name
Optional

The display name of the connector created as provided by the user

string
instanceId
Optional

The instanceId of the connector created.

string
message
Optional

The message informs of the success or failure in updating the conenctor

string
name
Optional

The Name of the connector created.

string
status
Optional

This specifeis the status of the connector updated. It can be "started", "stopped" or "pending"

string
time
Optional

The time at which the connector was updated

array of string
topics
Optional

Topic names to be replicated

TargetClusterObject
targetCluster
Optional

Object having details of target kafka cluster and authentication

LoggingObject
logging
Optional

Logging object containing logging type and logging level

ResourcesObject
resources
Optional

Maximum limits for CPU and memory resources and the requested initial resources.


400

Invalid Request sent by the user

Operation doesn't return any data structure

401

User authentication failed

Operation doesn't return any data structure

403

Access to the requested resource/operation is forbidden

Operation doesn't return any data structure

404

Cannot find requested resource

Operation doesn't return any data structure

500

Internal server error

Operation doesn't return any data structure

On This Page
Connector Operations
POST
Create Connector
DELETE
Delete Connector
GET
Get Connector Instance
GET
List Connector Instances
POST
Management Of Connector Lifecycle
PUT
Update Connector Instance