# Public Cloud › Analytics › Kafka › Connectors API

> Part of the OVHcloud developer hub. Index of every page and section: https://developers.eu.ovhcloud.com/llms.txt
> The Public Cloud product's sections: https://developers.eu.ovhcloud.com/reference/public-cloud/llms.txt
> Everything in one file: https://developers.eu.ovhcloud.com/llms-full.txt

> 9 operations of the OVHcloud API. Calls carry `authorization: Bearer $OVH_TOKEN`; the EU host is shown, Canada and the United States answer on api.ca.ovhcloud.com and api.us.ovhcloud.com.

Page: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/kafka/connectors/

OpenAPI v1: https://api.eu.ovhcloud.com/1.0/__schemas/developer-hub-navigation/public-cloud/analytics/kafka/connectors.json?format=openapi3
OpenAPI v2: https://api.eu.ovhcloud.com/v2/__schemas/developer-hub-navigation/public-cloud/analytics/kafka/connectors.json?format=openapi3

## Operations

- `GET /publicCloud/project/{projectId}/managedAnalytics/kafkaConnect/{serviceId}/connector` — List connectors
- `GET /publicCloud/project/{projectId}/managedAnalytics/kafkaConnect/{serviceId}/connector/{connectorId}` — Get a connector
- `POST /publicCloud/project/{projectId}/managedAnalytics/kafkaConnect/{serviceId}/connector` — Create a connector
- `DELETE /publicCloud/project/{projectId}/managedAnalytics/kafkaConnect/{serviceId}/connector/{connectorId}` — Delete a connector
- `PUT /publicCloud/project/{projectId}/managedAnalytics/kafkaConnect/{serviceId}/connector/{connectorId}` — Update a connector configuration
- `PATCH /publicCloud/project/{projectId}/managedAnalytics/kafkaConnect/{serviceId}/connector/{connectorId}` — Change the connector status
- `GET /publicCloud/project/{projectId}/managedAnalytics/kafkaConnect/{serviceId}/connector/{connectorId}/task` — List connector tasks
- `GET /publicCloud/project/{projectId}/managedAnalytics/kafkaConnect/{serviceId}/connector/{connectorId}/task/{taskId}` — Get a connector task
- `POST /publicCloud/project/{projectId}/managedAnalytics/kafkaConnect/{serviceId}/connector/{connectorId}/task/{taskId}/restart` — Restart a connector task

## List connectors

`GET /v2/publicCloud/project/{projectId}/managedAnalytics/kafkaConnect/{serviceId}/connector`

Link: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/kafka/connectors/#get-publiccloud-project-projectid-managedanalytics-kafkaconnect-serviceid-connector

**Status:** Beta version  
**IAM actions:** `publicCloudProject:apiovh:analytics/kafkaConnect/connector/get`

Returns the connectors of the service with their status.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `X-Pagination-Cursor` | header | string |  | Pagination cursor |
| `X-Pagination-Size` | header | integer |  | Pagination size |
| `projectId` | path | string | yes | Project ID |
| `serviceId` | path | string (uuid) | yes | Service ID |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | publicCloud.database.kafkaConnect.Connector[] | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `checksum` | string | read-only | Hash of the resource used for concurrency control |
| `configuration` | object | read-only | Connector configuration key-value pairs |
| `connectorCapabilityId` | string (uuid) | read-only | Identifier of the connector type from capabilities |
| `createdAt` | string (date-time) | read-only | Date at which the resource was created |
| `id` | string (uuid) | read-only | Unique identifier of the connector |
| `name` | string | read-only | Name of the connector |
| `status` | publicCloud.database.kafkaConnect.ConnectorStatusEnum | read-only | Current status of the connector — one of `CREATING`, `FAILED`, `PAUSED`, `RUNNING`, `UNASSIGNED` |
| `updatedAt` | string (date-time) | read-only | Date of the last update to the resource |

```json
[
  {
    "checksum": "string",
    "configuration": {
      "key": "string"
    },
    "connectorCapabilityId": "00000000-0000-0000-0000-000000000000",
    "createdAt": "2024-01-01T12:00:00Z",
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "status": "CREATING",
    "updatedAt": "2024-01-01T12:00:00Z"
  }
]
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/kafkaConnect/{serviceId}/connector" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/v2/publicCloud/project/{projectId}/managedAnalytics/kafkaConnect/{serviceId}/connector")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/v2/publicCloud/project/{projectId}/managedAnalytics/kafkaConnect/{serviceId}/connector");

print_r($result);
?>
```

## Get a connector

`GET /v2/publicCloud/project/{projectId}/managedAnalytics/kafkaConnect/{serviceId}/connector/{connectorId}`

Link: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/kafka/connectors/#get-publiccloud-project-projectid-managedanalytics-kafkaconnect-serviceid-connector-connectorid

**Status:** Beta version  
**IAM actions:** `publicCloudProject:apiovh:analytics/kafkaConnect/connector/get`

Returns the connector type, its configuration and its status.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `connectorId` | path | string (uuid) | yes | Connector ID |
| `projectId` | path | string | yes | Project ID |
| `serviceId` | path | string (uuid) | yes | Service ID |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | publicCloud.database.kafkaConnect.Connector | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `checksum` | string | read-only | Hash of the resource used for concurrency control |
| `configuration` | object | read-only | Connector configuration key-value pairs |
| `connectorCapabilityId` | string (uuid) | read-only | Identifier of the connector type from capabilities |
| `createdAt` | string (date-time) | read-only | Date at which the resource was created |
| `id` | string (uuid) | read-only | Unique identifier of the connector |
| `name` | string | read-only | Name of the connector |
| `status` | publicCloud.database.kafkaConnect.ConnectorStatusEnum | read-only | Current status of the connector — one of `CREATING`, `FAILED`, `PAUSED`, `RUNNING`, `UNASSIGNED` |
| `updatedAt` | string (date-time) | read-only | Date of the last update to the resource |

```json
{
  "checksum": "string",
  "configuration": {
    "key": "string"
  },
  "connectorCapabilityId": "00000000-0000-0000-0000-000000000000",
  "createdAt": "2024-01-01T12:00:00Z",
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "status": "CREATING",
  "updatedAt": "2024-01-01T12:00:00Z"
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/kafkaConnect/{serviceId}/connector/{connectorId}" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/v2/publicCloud/project/{projectId}/managedAnalytics/kafkaConnect/{serviceId}/connector/{connectorId}")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/v2/publicCloud/project/{projectId}/managedAnalytics/kafkaConnect/{serviceId}/connector/{connectorId}");

print_r($result);
?>
```

## Create a connector

`POST /v2/publicCloud/project/{projectId}/managedAnalytics/kafkaConnect/{serviceId}/connector`

Link: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/kafka/connectors/#post-publiccloud-project-projectid-managedanalytics-kafkaconnect-serviceid-connector

**Status:** Beta version  
**IAM actions:** `publicCloudProject:apiovh:analytics/kafkaConnect/connector/create`

Creates a connector of a type listed in the capabilities, with its configuration key-value pairs.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `projectId` | path | string | yes | Project ID |
| `serviceId` | path | string (uuid) | yes | Service ID |

### Request body (required)

Type: `publicCloud.database.kafkaConnect.ConnectorCreation`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `configuration` | object | yes | Connector configuration key-value pairs |
| `connectorCapabilityId` | string (uuid) | yes | Identifier of the connector type from capabilities |
| `name` | string | yes | Name of the connector |

```json
{
  "configuration": {
    "key": "string"
  },
  "connectorCapabilityId": "00000000-0000-0000-0000-000000000000",
  "name": "string"
}
```

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | publicCloud.database.kafkaConnect.Connector | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `checksum` | string | read-only | Hash of the resource used for concurrency control |
| `configuration` | object | read-only | Connector configuration key-value pairs |
| `connectorCapabilityId` | string (uuid) | read-only | Identifier of the connector type from capabilities |
| `createdAt` | string (date-time) | read-only | Date at which the resource was created |
| `id` | string (uuid) | read-only | Unique identifier of the connector |
| `name` | string | read-only | Name of the connector |
| `status` | publicCloud.database.kafkaConnect.ConnectorStatusEnum | read-only | Current status of the connector — one of `CREATING`, `FAILED`, `PAUSED`, `RUNNING`, `UNASSIGNED` |
| `updatedAt` | string (date-time) | read-only | Date of the last update to the resource |

```json
{
  "checksum": "string",
  "configuration": {
    "key": "string"
  },
  "connectorCapabilityId": "00000000-0000-0000-0000-000000000000",
  "createdAt": "2024-01-01T12:00:00Z",
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "status": "CREATING",
  "updatedAt": "2024-01-01T12:00:00Z"
}
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/kafkaConnect/{serviceId}/connector" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN" \
  -H "content-type: application/json" \
  -d '{ }'
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

# Request body type: publicCloud.database.kafkaConnect.ConnectorCreation
result = client.post("/v2/publicCloud/project/{projectId}/managedAnalytics/kafkaConnect/{serviceId}/connector",
	configuration = None, # Connector configuration key-value pairs (type: object)
	connectorCapabilityId = None, # Identifier of the connector type from capabilities (type: string)
	name = None, # Name of the connector (type: string)
)

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

// Request body type: publicCloud.database.kafkaConnect.ConnectorCreation
$result = $ovh->post("/v2/publicCloud/project/{projectId}/managedAnalytics/kafkaConnect/{serviceId}/connector", array(
	configuration => null, // Connector configuration key-value pairs (type: object)
	connectorCapabilityId => null, // Identifier of the connector type from capabilities (type: string)
	name => null, // Name of the connector (type: string)
));

print_r($result);
?>
```

## Delete a connector

`DELETE /v2/publicCloud/project/{projectId}/managedAnalytics/kafkaConnect/{serviceId}/connector/{connectorId}`

Link: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/kafka/connectors/#delete-publiccloud-project-projectid-managedanalytics-kafkaconnect-serviceid-connector-connectorid

**Status:** Beta version  
**IAM actions:** `publicCloudProject:apiovh:analytics/kafkaConnect/connector/delete`

Deletes the connector.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `connectorId` | path | string (uuid) | yes | Connector ID |
| `projectId` | path | string | yes | Project ID |
| `serviceId` | path | string (uuid) | yes | Service ID |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | publicCloud.database.kafkaConnect.Connector | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `checksum` | string | read-only | Hash of the resource used for concurrency control |
| `configuration` | object | read-only | Connector configuration key-value pairs |
| `connectorCapabilityId` | string (uuid) | read-only | Identifier of the connector type from capabilities |
| `createdAt` | string (date-time) | read-only | Date at which the resource was created |
| `id` | string (uuid) | read-only | Unique identifier of the connector |
| `name` | string | read-only | Name of the connector |
| `status` | publicCloud.database.kafkaConnect.ConnectorStatusEnum | read-only | Current status of the connector — one of `CREATING`, `FAILED`, `PAUSED`, `RUNNING`, `UNASSIGNED` |
| `updatedAt` | string (date-time) | read-only | Date of the last update to the resource |

```json
{
  "checksum": "string",
  "configuration": {
    "key": "string"
  },
  "connectorCapabilityId": "00000000-0000-0000-0000-000000000000",
  "createdAt": "2024-01-01T12:00:00Z",
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "status": "CREATING",
  "updatedAt": "2024-01-01T12:00:00Z"
}
```

### Example

```bash
curl -X DELETE \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/kafkaConnect/{serviceId}/connector/{connectorId}" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.delete("/v2/publicCloud/project/{projectId}/managedAnalytics/kafkaConnect/{serviceId}/connector/{connectorId}")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->delete("/v2/publicCloud/project/{projectId}/managedAnalytics/kafkaConnect/{serviceId}/connector/{connectorId}");

print_r($result);
?>
```

## Update a connector configuration

`PUT /v2/publicCloud/project/{projectId}/managedAnalytics/kafkaConnect/{serviceId}/connector/{connectorId}`

Link: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/kafka/connectors/#put-publiccloud-project-projectid-managedanalytics-kafkaconnect-serviceid-connector-connectorid

**Status:** Beta version  
**IAM actions:** `publicCloudProject:apiovh:analytics/kafkaConnect/connector/edit`

Updates the configuration of the connector. Keys omitted from the request are removed.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `connectorId` | path | string (uuid) | yes | Connector ID |
| `projectId` | path | string | yes | Project ID |
| `serviceId` | path | string (uuid) | yes | Service ID |

### Request body (required)

Type: `publicCloud.database.kafkaConnect.ConnectorReplace`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `configuration` | object | yes | Connector configuration key-value pairs. The whole configuration is replaced: keys omitted here are removed from the connector. |

```json
{
  "configuration": {
    "key": "string"
  }
}
```

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | publicCloud.database.kafkaConnect.Connector | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `checksum` | string | read-only | Hash of the resource used for concurrency control |
| `configuration` | object | read-only | Connector configuration key-value pairs |
| `connectorCapabilityId` | string (uuid) | read-only | Identifier of the connector type from capabilities |
| `createdAt` | string (date-time) | read-only | Date at which the resource was created |
| `id` | string (uuid) | read-only | Unique identifier of the connector |
| `name` | string | read-only | Name of the connector |
| `status` | publicCloud.database.kafkaConnect.ConnectorStatusEnum | read-only | Current status of the connector — one of `CREATING`, `FAILED`, `PAUSED`, `RUNNING`, `UNASSIGNED` |
| `updatedAt` | string (date-time) | read-only | Date of the last update to the resource |

```json
{
  "checksum": "string",
  "configuration": {
    "key": "string"
  },
  "connectorCapabilityId": "00000000-0000-0000-0000-000000000000",
  "createdAt": "2024-01-01T12:00:00Z",
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "status": "CREATING",
  "updatedAt": "2024-01-01T12:00:00Z"
}
```

### Example

```bash
curl -X PUT \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/kafkaConnect/{serviceId}/connector/{connectorId}" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN" \
  -H "content-type: application/json" \
  -d '{ }'
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

# Request body type: publicCloud.database.kafkaConnect.ConnectorReplace
result = client.put("/v2/publicCloud/project/{projectId}/managedAnalytics/kafkaConnect/{serviceId}/connector/{connectorId}",
	configuration = None, # Connector configuration key-value pairs. The whole configuration is replaced: keys omitted here are removed from the connector. (type: object)
)

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

// Request body type: publicCloud.database.kafkaConnect.ConnectorReplace
$result = $ovh->put("/v2/publicCloud/project/{projectId}/managedAnalytics/kafkaConnect/{serviceId}/connector/{connectorId}", array(
	configuration => null, // Connector configuration key-value pairs. The whole configuration is replaced: keys omitted here are removed from the connector. (type: object)
));

print_r($result);
?>
```

## Change the connector status

`PATCH /v2/publicCloud/project/{projectId}/managedAnalytics/kafkaConnect/{serviceId}/connector/{connectorId}`

Link: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/kafka/connectors/#patch-publiccloud-project-projectid-managedanalytics-kafkaconnect-serviceid-connector-connectorid

**Status:** Beta version  
**IAM actions:** `publicCloudProject:apiovh:analytics/kafkaConnect/connector/edit`

Pauses, resumes or restarts the connector, depending on the requested action.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `connectorId` | path | string (uuid) | yes | Connector ID |
| `projectId` | path | string | yes | Project ID |
| `serviceId` | path | string (uuid) | yes | Service ID |

### Request body (required)

Type: `publicCloud.database.kafkaConnect.ConnectorStatusUpdate`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `action` | publicCloud.database.kafkaConnect.ConnectorActionEnum | yes | Action to perform on the connector — one of `PAUSE`, `RESTART`, `RESUME` |

```json
{
  "action": "PAUSE"
}
```

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | publicCloud.database.kafkaConnect.Connector | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `checksum` | string | read-only | Hash of the resource used for concurrency control |
| `configuration` | object | read-only | Connector configuration key-value pairs |
| `connectorCapabilityId` | string (uuid) | read-only | Identifier of the connector type from capabilities |
| `createdAt` | string (date-time) | read-only | Date at which the resource was created |
| `id` | string (uuid) | read-only | Unique identifier of the connector |
| `name` | string | read-only | Name of the connector |
| `status` | publicCloud.database.kafkaConnect.ConnectorStatusEnum | read-only | Current status of the connector — one of `CREATING`, `FAILED`, `PAUSED`, `RUNNING`, `UNASSIGNED` |
| `updatedAt` | string (date-time) | read-only | Date of the last update to the resource |

```json
{
  "checksum": "string",
  "configuration": {
    "key": "string"
  },
  "connectorCapabilityId": "00000000-0000-0000-0000-000000000000",
  "createdAt": "2024-01-01T12:00:00Z",
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "status": "CREATING",
  "updatedAt": "2024-01-01T12:00:00Z"
}
```

### Example

```bash
curl -X PATCH \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/kafkaConnect/{serviceId}/connector/{connectorId}" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN" \
  -H "content-type: application/json" \
  -d '{ }'
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

# Request body type: publicCloud.database.kafkaConnect.ConnectorStatusUpdate
result = client.patch("/v2/publicCloud/project/{projectId}/managedAnalytics/kafkaConnect/{serviceId}/connector/{connectorId}",
	action = None, # Action to perform on the connector (type: publicCloud.database.kafkaConnect.ConnectorActionEnum)
)

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

// Request body type: publicCloud.database.kafkaConnect.ConnectorStatusUpdate
$result = $ovh->patch("/v2/publicCloud/project/{projectId}/managedAnalytics/kafkaConnect/{serviceId}/connector/{connectorId}", array(
	action => null, // Action to perform on the connector (type: publicCloud.database.kafkaConnect.ConnectorActionEnum)
));

print_r($result);
?>
```

## List connector tasks

`GET /v2/publicCloud/project/{projectId}/managedAnalytics/kafkaConnect/{serviceId}/connector/{connectorId}/task`

Link: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/kafka/connectors/#get-publiccloud-project-projectid-managedanalytics-kafkaconnect-serviceid-connector-connectorid-task

**Status:** Beta version  
**IAM actions:** `publicCloudProject:apiovh:analytics/kafkaConnect/connector/task/get`

Returns the tasks of the connector with their status.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `X-Pagination-Cursor` | header | string |  | Pagination cursor |
| `X-Pagination-Size` | header | integer |  | Pagination size |
| `connectorId` | path | string (uuid) | yes | Connector ID |
| `projectId` | path | string | yes | Project ID |
| `serviceId` | path | string (uuid) | yes | Service ID |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | publicCloud.database.kafkaConnect.connector.Task[] | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `checksum` | string | read-only | Hash of the resource used for concurrency control |
| `createdAt` | string (date-time) | read-only | Date at which the resource was created |
| `id` | integer | read-only | Identifier of the task within the connector |
| `status` | publicCloud.database.kafkaConnect.connector.TaskStatusEnum | read-only | Current status of the task — one of `FAILED`, `PAUSED`, `RUNNING` |
| `trace` | string | read-only | Error trace if the task is in error state |
| `updatedAt` | string (date-time) | read-only | Date of the last update to the resource |

```json
[
  {
    "checksum": "string",
    "createdAt": "2024-01-01T12:00:00Z",
    "id": 0,
    "status": "FAILED",
    "trace": "string",
    "updatedAt": "2024-01-01T12:00:00Z"
  }
]
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/kafkaConnect/{serviceId}/connector/{connectorId}/task" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/v2/publicCloud/project/{projectId}/managedAnalytics/kafkaConnect/{serviceId}/connector/{connectorId}/task")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/v2/publicCloud/project/{projectId}/managedAnalytics/kafkaConnect/{serviceId}/connector/{connectorId}/task");

print_r($result);
?>
```

## Get a connector task

`GET /v2/publicCloud/project/{projectId}/managedAnalytics/kafkaConnect/{serviceId}/connector/{connectorId}/task/{taskId}`

Link: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/kafka/connectors/#get-publiccloud-project-projectid-managedanalytics-kafkaconnect-serviceid-connector-connectorid-task-taskid

**Status:** Beta version  
**IAM actions:** `publicCloudProject:apiovh:analytics/kafkaConnect/connector/task/get`

Returns the status of the task and, when it failed, its error trace.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `connectorId` | path | string (uuid) | yes | Connector ID |
| `projectId` | path | string | yes | Project ID |
| `serviceId` | path | string (uuid) | yes | Service ID |
| `taskId` | path | integer | yes | Task ID |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | publicCloud.database.kafkaConnect.connector.Task | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `checksum` | string | read-only | Hash of the resource used for concurrency control |
| `createdAt` | string (date-time) | read-only | Date at which the resource was created |
| `id` | integer | read-only | Identifier of the task within the connector |
| `status` | publicCloud.database.kafkaConnect.connector.TaskStatusEnum | read-only | Current status of the task — one of `FAILED`, `PAUSED`, `RUNNING` |
| `trace` | string | read-only | Error trace if the task is in error state |
| `updatedAt` | string (date-time) | read-only | Date of the last update to the resource |

```json
{
  "checksum": "string",
  "createdAt": "2024-01-01T12:00:00Z",
  "id": 0,
  "status": "FAILED",
  "trace": "string",
  "updatedAt": "2024-01-01T12:00:00Z"
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/kafkaConnect/{serviceId}/connector/{connectorId}/task/{taskId}" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/v2/publicCloud/project/{projectId}/managedAnalytics/kafkaConnect/{serviceId}/connector/{connectorId}/task/{taskId}")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/v2/publicCloud/project/{projectId}/managedAnalytics/kafkaConnect/{serviceId}/connector/{connectorId}/task/{taskId}");

print_r($result);
?>
```

## Restart a connector task

`POST /v2/publicCloud/project/{projectId}/managedAnalytics/kafkaConnect/{serviceId}/connector/{connectorId}/task/{taskId}/restart`

Link: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/kafka/connectors/#post-publiccloud-project-projectid-managedanalytics-kafkaconnect-serviceid-connector-connectorid-task-taskid-restart

**Status:** Beta version  
**IAM actions:** `publicCloudProject:apiovh:analytics/kafkaConnect/connector/task/restart`

Restarts the task and returns it with its new status.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `connectorId` | path | string (uuid) | yes | Connector ID |
| `projectId` | path | string | yes | Project ID |
| `serviceId` | path | string (uuid) | yes | Service ID |
| `taskId` | path | integer | yes | Task ID |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | publicCloud.database.kafkaConnect.connector.Task | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `checksum` | string | read-only | Hash of the resource used for concurrency control |
| `createdAt` | string (date-time) | read-only | Date at which the resource was created |
| `id` | integer | read-only | Identifier of the task within the connector |
| `status` | publicCloud.database.kafkaConnect.connector.TaskStatusEnum | read-only | Current status of the task — one of `FAILED`, `PAUSED`, `RUNNING` |
| `trace` | string | read-only | Error trace if the task is in error state |
| `updatedAt` | string (date-time) | read-only | Date of the last update to the resource |

```json
{
  "checksum": "string",
  "createdAt": "2024-01-01T12:00:00Z",
  "id": 0,
  "status": "FAILED",
  "trace": "string",
  "updatedAt": "2024-01-01T12:00:00Z"
}
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/kafkaConnect/{serviceId}/connector/{connectorId}/task/{taskId}/restart" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.post("/v2/publicCloud/project/{projectId}/managedAnalytics/kafkaConnect/{serviceId}/connector/{connectorId}/task/{taskId}/restart")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->post("/v2/publicCloud/project/{projectId}/managedAnalytics/kafkaConnect/{serviceId}/connector/{connectorId}/task/{taskId}/restart");

print_r($result);
?>
```