Team ETL Pipeline
Set Team ETL Pipelines
Team Custom Credentials
Team Data Pull Preferences
Team Scope Requirements
Team ETL Pipeline
Set Team ETL Pipelines
POST
/
v1
/
org
/
{org_id}
/
team_etl_pipelines
/
{env}
/
{region}
curl --request POST \
--url https://api.tryvital.io/management/v1/org/{org_id}/team_etl_pipelines/{env}/{region} \
--header 'Content-Type: application/json' \
--header 'X-Vital-Org-Key: <api-key>' \
--data '{
"team_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"push_historical_data": true,
"provider_raw_data": true,
"preferences": {
"preferred": "cloud_pubsub",
"enabled": [
"cloud_pubsub"
]
},
"cloud_pubsub": {
"project": "<string>",
"topic": "<string>",
"message_ordering": true
},
"rabbitmq": {
"uri": "<string>",
"exchange": "<string>"
},
"svix": {
"regional": true
},
"event_type_prefixes": [
"<string>"
]
}'
[
{
"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>"
]
}
]
Junction Management API is available for the Scale plan.
The base URL of this endpoint is https://api.tryvital.io/management/
.
The endpoint accepts only Management Key (X-Management-Key
).
Team API Key is not accepted.
curl --request POST \
--url https://api.tryvital.io/management/v1/org/{org_id}/team_etl_pipelines/{env}/{region} \
--header 'Content-Type: application/json' \
--header 'X-Vital-Org-Key: <api-key>' \
--data '{
"team_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"push_historical_data": true,
"provider_raw_data": true,
"preferences": {
"preferred": "cloud_pubsub",
"enabled": [
"cloud_pubsub"
]
},
"cloud_pubsub": {
"project": "<string>",
"topic": "<string>",
"message_ordering": true
},
"rabbitmq": {
"uri": "<string>",
"exchange": "<string>"
},
"svix": {
"regional": true
},
"event_type_prefixes": [
"<string>"
]
}'
Authorizations
Path Parameters
Available options:
production
, sandbox
Available options:
us
, eu
Body
application/json
Response
200
application/json
Successful Response
The response is of type object[]
.
curl --request POST \
--url https://api.tryvital.io/management/v1/org/{org_id}/team_etl_pipelines/{env}/{region} \
--header 'Content-Type: application/json' \
--header 'X-Vital-Org-Key: <api-key>' \
--data '{
"team_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"push_historical_data": true,
"provider_raw_data": true,
"preferences": {
"preferred": "cloud_pubsub",
"enabled": [
"cloud_pubsub"
]
},
"cloud_pubsub": {
"project": "<string>",
"topic": "<string>",
"message_ordering": true
},
"rabbitmq": {
"uri": "<string>",
"exchange": "<string>"
},
"svix": {
"regional": true
},
"event_type_prefixes": [
"<string>"
]
}'
[
{
"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>"
]
}
]