Vital home page

Get API Keys
GitHub
Get API Keys

Team ETL Pipeline

Set Team ETL Pipelines

Team

GET
List Teams
POST
Create Team
GET
Get Team
DEL
Delete Team
PATCH
Update Team

Team API Keys

GET
List Team API Keys
POST
Create Team API Key
DEL
Delete Team API Keys

Team Custom Credentials

GET
Get Team Custom Credentials
POST
Set Team Custom Credentials
DEL
Delete Team Custom Credentials
POST
Prepare Team Custom Credentials

Team Data Pull Preferences

GET
Get Team Data Pull Preferences
POST
Post Team Data Pull Preferences
DEL
Delete Team Data Pull Preferences

Team ETL Pipeline

GET
Get Team ETL Pipelines
POST
Set Team ETL Pipelines
DEL
Delete Team ETL Pipelines

Team Scope Requirements

GET
Get Team Scope Requirements
POST
Set Team Scope Requirements

Member

GET
List Members
DEL
Delete Member

Invite

GET
List Invites
POST
Create or Resend Invite
DEL
Revoke Invite

Org

GET
Get Org
PATCH
Update Org

Team ETL Pipeline

Set Team ETL Pipelines

POST

org

{org_id}

team_etl_pipelines

{env}

{region}

X-Vital-Org-Key

string

X-Vital-Org-Key

Required

string

org_id

string

org_id

Required

string

env

enum<string>

env

Required

enum<string>

An enumeration.

region

enum<string>

region

Required

enum<string>

object

team_ids

array

team_ids

array

push_historical_data

boolean

push_historical_data

boolean

provider_raw_data

boolean

provider_raw_data

boolean

preferences

object

preferences

object

preferred

enum<string>

preferred

Required

enum<string>

enabled

array

enabled

Required

array

cloud_pubsub

object

cloud_pubsub

object

project

string

project

Required

string

topic

string

topic

Required

string

message_ordering

boolean

message_ordering

Required

boolean

rabbitmq

object

rabbitmq

object

uri

string

uri

Required

string

exchange

string

exchange

Required

string

svix

object

svix

object

regional

boolean, deprecated

regional

Deprecated

boolean

azure_amqp

object

azure_amqp

object

connection_string

string

connection_string

Required

string

default_event_hub

string

default_event_hub

Required

string

event_hub_matchers

array

event_hub_matchers

array

compression

enum<string>

compression

enum<string>

event_type_prefixes

array

event_type_prefixes

array

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.

Authorizations

X-Vital-Org-Key

string

headerrequired

Path Parameters

org_id

string

required

env

enum<string>

required

An enumeration.

Available options:

production,

sandbox

region

enum<string>

required

Available options:

us,

eu

Body

application/json

team_ids

string[]

push_historical_data

boolean

provider_raw_data

boolean

preferences

object

preferences.preferred

enum<string>

required

Available options:

cloud_pubsub,

rabbitmq,

svix,

azure_amqp

preferences.enabled

enum<string>[]

required

Available options:

cloud_pubsub,

rabbitmq,

svix,

azure_amqp

cloud_pubsub

object

cloud_pubsub.project

string

required

cloud_pubsub.topic

string

required

cloud_pubsub.message_ordering

boolean

required

rabbitmq

object

rabbitmq.uri

string

required

rabbitmq.exchange

string

required

svix

object

svix.regional

boolean

default: truedeprecated

azure_amqp

object

azure_amqp.connection_string

string

required

azure_amqp.default_event_hub

string

required

azure_amqp.event_hub_matchers

object[]

azure_amqp.event_hub_matchers.event_type_prefix

string

Match event types by prefix. If set, event_type_regex must not be specified.

azure_amqp.event_hub_matchers.event_type_regex

string

Match event types by Google RE2. If set, event_type_prefix must not be specified.

azure_amqp.event_hub_matchers.event_hub

string

The destination event hub for matched event types. If set, blob_storage must not be specified

azure_amqp.event_hub_matchers.blob_storage

object

The destination blob storage for matched event types. If set, event_hub must not be specified

azure_amqp.event_hub_matchers.blob_storage.connection_string

string

required

azure_amqp.event_hub_matchers.blob_storage.container_name

string

required

azure_amqp.compression

enum<string>

default: auto

Available options:

always,

auto

event_type_prefixes

string[]

Response

200 - application/json

team_id

string

required

push_historical_data

boolean

default: false

provider_raw_data

boolean

default: false

preferences

object

required

preferences.preferred

enum<string>

required

Available options:

cloud_pubsub,

rabbitmq,

svix,

azure_amqp

preferences.enabled

enum<string>[]

required

Available options:

cloud_pubsub,

rabbitmq,

svix,

azure_amqp

cloud_pubsub

object

cloud_pubsub.project

string

required

cloud_pubsub.topic

string

required

cloud_pubsub.message_ordering

boolean

required

rabbitmq

object

rabbitmq.uri

string

required

rabbitmq.exchange

string

required

svix

object

svix.regional

boolean

default: truedeprecated

azure_amqp

object

azure_amqp.connection_string

string

required

azure_amqp.default_event_hub

string

required

azure_amqp.event_hub_matchers

object[]

azure_amqp.event_hub_matchers.event_type_prefix

string

Match event types by prefix. If set, event_type_regex must not be specified.

azure_amqp.event_hub_matchers.event_type_regex

string

Match event types by Google RE2. If set, event_type_prefix must not be specified.

azure_amqp.event_hub_matchers.event_hub

string

The destination event hub for matched event types. If set, blob_storage must not be specified

azure_amqp.event_hub_matchers.blob_storage

object

The destination blob storage for matched event types. If set, event_hub must not be specified

azure_amqp.event_hub_matchers.blob_storage.connection_string

string

required

azure_amqp.event_hub_matchers.blob_storage.container_name

string

required

azure_amqp.compression

enum<string>

default: auto

Available options:

always,

auto

event_type_prefixes

string[]

An allowlist of event type prefixes. Note that both an empty list and null are interpreted as allow-all.

Get Team ETL Pipelines Delete Team ETL Pipelines

website twitter linkedin