Team Custom Credentials
Team Data Pull Preferences
Team Scope Requirements
Get Team ETL Pipelines
curl --request GET \
--url https://api.tryvital.io/management/v1/org/{org_id}/team_etl_pipelines/{env}/{region} \
--header 'X-Vital-Org-Key: <api-key>'
{
"pipelines": [
{
"team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"push_historical_data": false,
"provider_raw_data": false,
"preferences": {
"preferred": "cloud_pubsub",
"enabled": [
"cloud_pubsub"
]
},
"cloud_pubsub": {
"project": "<string>",
"topic": "<string>",
"message_ordering": true
},
"rabbitmq": {
"uri": "<string>",
"exchange": "<string>"
},
"svix": {
"regional": true
},
"azure_amqp": {
"connection_string": "<string>",
"default_event_hub": "<string>",
"event_hub_matchers": [
{
"event_type_prefix": "<string>",
"event_type_regex": "<string>",
"event_hub": "<string>",
"blob_storage": {
"connection_string": "<string>",
"container_name": "<string>"
}
}
],
"compression": "auto"
},
"event_type_prefixes": [
"<string>"
]
}
],
"next_cursor": "<string>"
}Org Management API is available for the Scale plan.
The base URL of this endpoint is https://api.tryvital.io/management/.
The endpoint accepts only Org Key (X-Vital-Org-Key). Team API Key is not applicable.
curl --request GET \
--url https://api.tryvital.io/management/v1/org/{org_id}/team_etl_pipelines/{env}/{region} \
--header 'X-Vital-Org-Key: <api-key>'
Authorizations
Path Parameters
production, sandbox us, eu Response
The default Event Hub to use when none of the event_hub_matchers matches.
A list of matchers to route event types to specific Event Hubs.
String prefix matching is used, and the matchers are evaluated in array order.
If an event matches none of the matchers, it falls back to default_event_hub.
Match event types by prefix. If set, event_type_regex must not be specified.
Match event types by Google RE2. If set, event_type_prefix must not be specified.
The destination event hub for matched event types. If set, blob_storage must not be specified
auto mode compresses only payload blobs above a threshold (currently 1 KiB).
For all compressed payloads, Vital adds Content-Encoding: gzip to the
EventData.Properties of the event.
always mode compresses all blobs regardless of their size.
always, auto An allowlist of event type prefixes. Note that both an empty list and null are interpreted as allow-all.
curl --request GET \
--url https://api.tryvital.io/management/v1/org/{org_id}/team_etl_pipelines/{env}/{region} \
--header 'X-Vital-Org-Key: <api-key>'
{
"pipelines": [
{
"team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"push_historical_data": false,
"provider_raw_data": false,
"preferences": {
"preferred": "cloud_pubsub",
"enabled": [
"cloud_pubsub"
]
},
"cloud_pubsub": {
"project": "<string>",
"topic": "<string>",
"message_ordering": true
},
"rabbitmq": {
"uri": "<string>",
"exchange": "<string>"
},
"svix": {
"regional": true
},
"azure_amqp": {
"connection_string": "<string>",
"default_event_hub": "<string>",
"event_hub_matchers": [
{
"event_type_prefix": "<string>",
"event_type_regex": "<string>",
"event_hub": "<string>",
"blob_storage": {
"connection_string": "<string>",
"container_name": "<string>"
}
}
],
"compression": "auto"
},
"event_type_prefixes": [
"<string>"
]
}
],
"next_cursor": "<string>"
}