Create a new delivery configuration.
POST/integrations/deliveryconfig
201 Description
If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.
Roles
At least one of the roles below is required to access this endpoint.
FullAccessDeliveryConfigAdmin
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 a new delivery configuration.
POST/integrations/deliveryconfig
201 Description
If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.
Roles
At least one of the roles below is required to access this endpoint.
FullAccessDeliveryConfigAdmin
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 | --- | --- | --- | |
|
|