Create or update a delivery configuration.
PUT/integrations/deliveryconfig/{deliveryConfigID}
200 Description
If an object with the same ID already exists, it will be overwritten.
Roles
At least one of the roles below is required to access this endpoint.
FullAccessDeliveryConfigAdmin
Parameters
| Name | Type | Description | Possible Values |
| deliveryConfigID | Required | string | ID of the delivery config. | --- |
Request Body
| Property | Type | Format | Max Length | Possible Values |
| ID | | string | --- | 100 characters | --- | |
| Name | Required | string | --- | 128 characters | --- | |
| Enabled | | boolean | --- | --- | --- | |
| DeliveryTargets | Required | object | --- | --- | --- | |
| Property | Type | Format | Max Length | Possible Values | | Kafka | | object | --- | --- | --- | | | Property | Type | Format | Max Length | Possible Values | | BootstrapServers | | string | --- | --- | --- | | | SaslUsername | | string | --- | --- | --- | | | SaslPassword | | string | --- | --- | --- | | | Topic | | string | --- | --- | --- | |
| | Http | | object | --- | --- | --- | | | Property | Type | Format | Max Length | Possible Values | | Endpoint | | string | --- | --- | --- | | | Secret | | string | --- | 50 characters | --- | |
| | SearchIngestion | | object | --- | --- | --- | | | Property | Type | Format | Max Length | Possible Values | | Domain | | string | --- | --- | --- | | | Source | | string | --- | --- | --- | | | Endpoint | | string | --- | --- | --- | | | Entity | | string | --- | --- | --- | | | ApiKey | | string | --- | --- | --- | |
| | SendEvent | | object | --- | --- | --- | | | Property | Type | Format | Max Length | Possible Values | | SiteID | | string | --- | --- | --- | | | ServiceEndpoint | | string | --- | --- | --- | |
| | DiscoverEvent | | object | --- | --- | --- | | | Property | Type | Format | Max Length | Possible Values | | ClientID | | string | --- | --- | --- | | | ApiKey | | string | --- | --- | --- | | | ServiceEndpoint | | string | --- | --- | --- | |
| | EventHub | | object | --- | --- | --- | | | Property | Type | Format | Max Length | Possible Values | | EventHubName | | string | --- | --- | --- | | | ConnectionString | | string | --- | --- | --- | |
| | AzureBlob | | object | --- | --- | --- | | | Property | Type | Format | Max Length | Possible Values | | ConnectionString | | string | --- | --- | --- | |
|
|
Response Body
| Property | Type | Format | Max Length | Possible Values |
| ID | | string | --- | 100 characters | --- | |
| Name | | string | --- | 128 characters | --- | |
| Enabled | | boolean | --- | --- | --- | |
| DeliveryTargets | | object | --- | --- | --- | |
| Property | Type | Format | Max Length | Possible Values | | Kafka | | object | --- | --- | --- | | | Property | Type | Format | Max Length | Possible Values | | BootstrapServers | | string | --- | --- | --- | | | SaslUsername | | string | --- | --- | --- | | | SaslPassword | | string | --- | --- | --- | | | Topic | | string | --- | --- | --- | |
| | Http | | object | --- | --- | --- | | | Property | Type | Format | Max Length | Possible Values | | Endpoint | | string | --- | --- | --- | | | Secret | | string | --- | 50 characters | --- | |
| | SearchIngestion | | object | --- | --- | --- | | | Property | Type | Format | Max Length | Possible Values | | Domain | | string | --- | --- | --- | | | Source | | string | --- | --- | --- | | | Endpoint | | string | --- | --- | --- | | | Entity | | string | --- | --- | --- | | | ApiKey | | string | --- | --- | --- | |
| | SendEvent | | object | --- | --- | --- | | | Property | Type | Format | Max Length | Possible Values | | SiteID | | string | --- | --- | --- | | | ServiceEndpoint | | string | --- | --- | --- | |
| | DiscoverEvent | | object | --- | --- | --- | | | Property | Type | Format | Max Length | Possible Values | | ClientID | | string | --- | --- | --- | | | ApiKey | | string | --- | --- | --- | | | ServiceEndpoint | | string | --- | --- | --- | |
| | EventHub | | object | --- | --- | --- | | | Property | Type | Format | Max Length | Possible Values | | EventHubName | | string | --- | --- | --- | | | ConnectionString | | string | --- | --- | --- | |
| | AzureBlob | | object | --- | --- | --- | | | Property | Type | Format | Max Length | Possible Values | | ConnectionString | | string | --- | --- | --- | |
|
|
Create or update a delivery configuration.
PUT/integrations/deliveryconfig/{deliveryConfigID}
200 Description
If an object with the same ID already exists, it will be overwritten.
Roles
At least one of the roles below is required to access this endpoint.
FullAccessDeliveryConfigAdmin
Parameters
| Name | Type | Description | Possible Values |
| deliveryConfigID | Required | string | ID of the delivery config. | --- |
Request Body
| Property | Type | Format | Max Length | Possible Values |
| ID | | string | --- | 100 characters | --- | |
| Name | Required | string | --- | 128 characters | --- | |
| Enabled | | boolean | --- | --- | --- | |
| DeliveryTargets | Required | object | --- | --- | --- | |
| Property | Type | Format | Max Length | Possible Values | | Kafka | | object | --- | --- | --- | | | Property | Type | Format | Max Length | Possible Values | | BootstrapServers | | string | --- | --- | --- | | | SaslUsername | | string | --- | --- | --- | | | SaslPassword | | string | --- | --- | --- | | | Topic | | string | --- | --- | --- | |
| | Http | | object | --- | --- | --- | | | Property | Type | Format | Max Length | Possible Values | | Endpoint | | string | --- | --- | --- | | | Secret | | string | --- | 50 characters | --- | |
| | SearchIngestion | | object | --- | --- | --- | | | Property | Type | Format | Max Length | Possible Values | | Domain | | string | --- | --- | --- | | | Source | | string | --- | --- | --- | | | Endpoint | | string | --- | --- | --- | | | Entity | | string | --- | --- | --- | | | ApiKey | | string | --- | --- | --- | |
| | SendEvent | | object | --- | --- | --- | | | Property | Type | Format | Max Length | Possible Values | | SiteID | | string | --- | --- | --- | | | ServiceEndpoint | | string | --- | --- | --- | |
| | DiscoverEvent | | object | --- | --- | --- | | | Property | Type | Format | Max Length | Possible Values | | ClientID | | string | --- | --- | --- | | | ApiKey | | string | --- | --- | --- | | | ServiceEndpoint | | string | --- | --- | --- | |
| | EventHub | | object | --- | --- | --- | | | Property | Type | Format | Max Length | Possible Values | | EventHubName | | string | --- | --- | --- | | | ConnectionString | | string | --- | --- | --- | |
| | AzureBlob | | object | --- | --- | --- | | | Property | Type | Format | Max Length | Possible Values | | ConnectionString | | string | --- | --- | --- | |
|
|
Response Body
| Property | Type | Format | Max Length | Possible Values |
| ID | | string | --- | 100 characters | --- | |
| Name | | string | --- | 128 characters | --- | |
| Enabled | | boolean | --- | --- | --- | |
| DeliveryTargets | | object | --- | --- | --- | |
| Property | Type | Format | Max Length | Possible Values | | Kafka | | object | --- | --- | --- | | | Property | Type | Format | Max Length | Possible Values | | BootstrapServers | | string | --- | --- | --- | | | SaslUsername | | string | --- | --- | --- | | | SaslPassword | | string | --- | --- | --- | | | Topic | | string | --- | --- | --- | |
| | Http | | object | --- | --- | --- | | | Property | Type | Format | Max Length | Possible Values | | Endpoint | | string | --- | --- | --- | | | Secret | | string | --- | 50 characters | --- | |
| | SearchIngestion | | object | --- | --- | --- | | | Property | Type | Format | Max Length | Possible Values | | Domain | | string | --- | --- | --- | | | Source | | string | --- | --- | --- | | | Endpoint | | string | --- | --- | --- | | | Entity | | string | --- | --- | --- | | | ApiKey | | string | --- | --- | --- | |
| | SendEvent | | object | --- | --- | --- | | | Property | Type | Format | Max Length | Possible Values | | SiteID | | string | --- | --- | --- | | | ServiceEndpoint | | string | --- | --- | --- | |
| | DiscoverEvent | | object | --- | --- | --- | | | Property | Type | Format | Max Length | Possible Values | | ClientID | | string | --- | --- | --- | | | ApiKey | | string | --- | --- | --- | | | ServiceEndpoint | | string | --- | --- | --- | |
| | EventHub | | object | --- | --- | --- | | | Property | Type | Format | Max Length | Possible Values | | EventHubName | | string | --- | --- | --- | | | ConnectionString | | string | --- | --- | --- | |
| | AzureBlob | | object | --- | --- | --- | | | Property | Type | Format | Max Length | Possible Values | | ConnectionString | | string | --- | --- | --- | |
|
|
