Get

/triggers/all

Returns a list of all triggers with fully typed responses. Each trigger in the response is a discriminated union of ElementTriggerResponse or ScheduleTriggerResponse, with the 'type' field as discriminator. This replaces the deprecated GET /triggers endpoint which returns a flat, schema-less config object.

Query parameters

cursor

string

limit

integer

Default100

order_by

string

Sort order - ascending (asc) or descending (desc)

Valid values[ "asc", "desc" ]

Default"asc"

guid

string

Filter by trigger GUID

vrn

string

Filter by trigger VRN

name

string

Filter by trigger name

owner_name

string

Filter by owner name

type

string

Filter by trigger type

Valid values[ "Element", "Schedule" ]

topic

string

Filter by topic VRN

source_bucket_name

string

Filter by source bucket name (for Element triggers)

status

string

Filter by trigger status

created_after

integer (int64)

Filter triggers created after this timestamp (microseconds since epoch)

created_before

integer (int64)

Filter triggers created before this timestamp (microseconds since epoch)

updated_after

integer (int64)

Filter triggers updated after this timestamp (microseconds since epoch)

updated_before

integer (int64)

Filter triggers updated before this timestamp (microseconds since epoch)

Responses

200

A list of Triggers with full type-specific details

Expand All

object

Response schema for listing triggers with full type-specific details.

pagination

object

next_cursor

string

The cursor for the next page

previous_cursor

string

The cursor for the last page

data

Array of object (TypedTriggerResponse)

object

A discriminated union of all trigger response types. The 'type' field is used as the discriminator to determine which trigger type schema applies.

type

string

Valid values[ "Element", "Schedule" ]

name

string

A name for the resource.

Examplenaomis-resource

description

string

A description of the resource.

ExampleA good and detailed description that makes everyone understand.

tags

Array of string

Custom tags for organizing and categorizing resources in the GUI.

Max items32

Example[ "tagA", "tagB", "tagC" ]

string

id

integer (int64)

A globally unique identifier (ID) for the resource.

guid

string (uuid)

A globally unique identifier (GUID) for the resource.

Examplea7f4aa24-a00d-4dc5-a113-2031eb8c2c79

tenant_guid

string (uuid)

A globally unique identifier (GUID) for the resource.

Examplea7f4aa24-a00d-4dc5-a113-2031eb8c2c79

owner

object (UserID)

Represents the owner of the resource.

id

string

The unique identifier for the owner.

id_type

string

The type of identifier for the owner.

Valid values[ "uid", "vid", "sid", "access_key", "sid_str", "login_name", "username" ]

name

string

The presentable name of the owner

created_at

string (date-time)

Timestamp when the resource was created.

Example2024-12-25T15:30:00Z

updated_at

string (date-time)

Timestamp when the resource was last updated.

Example2024-12-28T18:00:00Z

vrn

string

A logical path for resource grouping and policy assignment. The structure of the logical path is: vast:dataengine:: where resource type is one of: triggers / functions / pipelines / topics / kubernetes-clusters / container-registries / mtls-authentication-credentials.

Examplevast:dataengine:functions:foo

broker

object (Broker)

type

string

Valid values[ "External", "Internal" ]

url

string Deprecated

Deprecated. The broker URL is now resolved from VMS by broker name. This field is ignored for VMS-registered brokers and only used as a legacy fallback for brokers not yet registered in VMS. It will be removed in a future release.

Examplehttps://kafka.example.com:6969

name

string

Broker name for external or Bucket (View) name for internal.

Max length40

Examplemy-kafka-broker

is_accessible_to_data_engine

boolean

When true (default), the Data Engine will periodically validate that the broker is accessible. Set to false if the broker is not reachable from the Data Engine (e.g., external brokers behind firewalls).

Defaulttrue

topic_name

string

The name of the topic in the broker. Used with broker field for automatic topic creation.

Examplemy-topic

custom_extensions

object

Custom key/value pairs to be passed as event output extensions. custom key must contain only lowercase letters and digits, start with a letter, and be 1-20 characters long

config

object (ElementTriggerConfig)

events

Array of string (TriggerEvent)

Events that trigger the element trigger. TODO: Make this field required once deprecated POST/PUT /triggers APIs are removed.

Min items1

string

action the trigger listens to

Valid values[ "ObjectCreated:*", "ObjectRemoved:*", "ObjectTagging:Put", "ObjectTagging:Delete" ]

source_bucket_name

string

The bucket name of a VMS View. Relevant for Element Trigger. TODO: Make this field required once deprecated POST/PUT /triggers APIs are removed.

Examplemy-bucket

tag_filters

object (TriggerFilters)

prefixes

Array of string

string

suffixes

Array of string

string

name_filters

object (TriggerFilters)

prefixes

Array of string

string

suffixes

Array of string

string

source_types

Array of string (SourceType)

Source types from which we want to trigger events. Relevant for Element Trigger

Example[ "S3" ]

string

The source protocol from which we want to trigger events. Relevant for Element Trigger

Valid values[ "S3", "NFS4" ]

events

Array of string (TriggerEvent)

Min items1

string

action the trigger listens to

Valid values[ "ObjectCreated:*", "ObjectRemoved:*", "ObjectTagging:Put", "ObjectTagging:Delete" ]

source_bucket_name

string

The bucket name of a VMS View. Relevant for Element Trigger

Examplemy-bucket

topic

string

A logical path for resource grouping and policy assignment. The structure of the logical path is: vast:dataengine:: where resource type is one of: triggers / functions / pipelines / topics / kubernetes-clusters / container-registries / mtls-authentication-credentials.

Examplevast:dataengine:functions:foo

status

string

Operational status of the object.

Valid values[ "Ready", "InProgress", "Error", "Draft", "Deleting" ]

ExampleReady

name

string

A name for the resource.

Examplenaomis-resource

description

string

A description of the resource.

ExampleA good and detailed description that makes everyone understand.

tags

Array of string

Custom tags for organizing and categorizing resources in the GUI.

Max items32

Example[ "tagA", "tagB", "tagC" ]

string

id

integer (int64)

A globally unique identifier (ID) for the resource.

guid

string (uuid)

A globally unique identifier (GUID) for the resource.

Examplea7f4aa24-a00d-4dc5-a113-2031eb8c2c79

tenant_guid

string (uuid)

A globally unique identifier (GUID) for the resource.

Examplea7f4aa24-a00d-4dc5-a113-2031eb8c2c79

owner

object (UserID)

Represents the owner of the resource.

id

string

The unique identifier for the owner.

id_type

string

The type of identifier for the owner.

Valid values[ "uid", "vid", "sid", "access_key", "sid_str", "login_name", "username" ]

name

string

The presentable name of the owner

created_at

string (date-time)

Timestamp when the resource was created.

Example2024-12-25T15:30:00Z

updated_at

string (date-time)

Timestamp when the resource was last updated.

Example2024-12-28T18:00:00Z

vrn

string

A logical path for resource grouping and policy assignment. The structure of the logical path is: vast:dataengine:: where resource type is one of: triggers / functions / pipelines / topics / kubernetes-clusters / container-registries / mtls-authentication-credentials.

Examplevast:dataengine:functions:foo

broker

object (Broker)

type

string

Valid values[ "External", "Internal" ]

url

string Deprecated

Deprecated. The broker URL is now resolved from VMS by broker name. This field is ignored for VMS-registered brokers and only used as a legacy fallback for brokers not yet registered in VMS. It will be removed in a future release.

Examplehttps://kafka.example.com:6969

name

string

Broker name for external or Bucket (View) name for internal.

Max length40

Examplemy-kafka-broker

is_accessible_to_data_engine

boolean

When true (default), the Data Engine will periodically validate that the broker is accessible. Set to false if the broker is not reachable from the Data Engine (e.g., external brokers behind firewalls).

Defaulttrue

topic_name

string

The name of the topic in the broker. Used with broker field for automatic topic creation.

Examplemy-topic

custom_extensions

object

Custom key/value pairs to be passed as event output extensions. custom key must contain only lowercase letters and digits, start with a letter, and be 1-20 characters long

config

object (ScheduleTriggerConfig)

cron_schedule

string

Cron schedule for a Schedule Trigger.

Example*/15 * * * *

topic

string

A logical path for resource grouping and policy assignment. The structure of the logical path is: vast:dataengine:: where resource type is one of: triggers / functions / pipelines / topics / kubernetes-clusters / container-registries / mtls-authentication-credentials.

Examplevast:dataengine:functions:foo

status

string

Operational status of the object.

Valid values[ "Ready", "InProgress", "Error", "Draft", "Deleting" ]

ExampleReady

OneOf

ElementTriggerResponse

object (ElementTriggerResponse)

type

string

Valid values[ "Element", "Schedule" ]

name

string

A name for the resource.

Examplenaomis-resource

description

string

A description of the resource.

ExampleA good and detailed description that makes everyone understand.

tags

Array of string

Custom tags for organizing and categorizing resources in the GUI.

Max items32

Example[ "tagA", "tagB", "tagC" ]

string

id

integer (int64)

A globally unique identifier (ID) for the resource.

guid

string (uuid)

A globally unique identifier (GUID) for the resource.

Examplea7f4aa24-a00d-4dc5-a113-2031eb8c2c79

tenant_guid

string (uuid)

A globally unique identifier (GUID) for the resource.

Examplea7f4aa24-a00d-4dc5-a113-2031eb8c2c79

owner

object (UserID)

Represents the owner of the resource.

id

string

The unique identifier for the owner.

id_type

string

The type of identifier for the owner.

Valid values[ "uid", "vid", "sid", "access_key", "sid_str", "login_name", "username" ]

name

string

The presentable name of the owner

created_at

string (date-time)

Timestamp when the resource was created.

Example2024-12-25T15:30:00Z

updated_at

string (date-time)

Timestamp when the resource was last updated.

Example2024-12-28T18:00:00Z

vrn

string

A logical path for resource grouping and policy assignment. The structure of the logical path is: vast:dataengine:: where resource type is one of: triggers / functions / pipelines / topics / kubernetes-clusters / container-registries / mtls-authentication-credentials.

Examplevast:dataengine:functions:foo

broker

object (Broker)

type

string

Valid values[ "External", "Internal" ]

url

string Deprecated

Deprecated. The broker URL is now resolved from VMS by broker name. This field is ignored for VMS-registered brokers and only used as a legacy fallback for brokers not yet registered in VMS. It will be removed in a future release.

Examplehttps://kafka.example.com:6969

name

string

Broker name for external or Bucket (View) name for internal.

Max length40

Examplemy-kafka-broker

is_accessible_to_data_engine

boolean

When true (default), the Data Engine will periodically validate that the broker is accessible. Set to false if the broker is not reachable from the Data Engine (e.g., external brokers behind firewalls).

Defaulttrue

topic_name

string

The name of the topic in the broker. Used with broker field for automatic topic creation.

Examplemy-topic

custom_extensions

object

Custom key/value pairs to be passed as event output extensions. custom key must contain only lowercase letters and digits, start with a letter, and be 1-20 characters long

config

object (ElementTriggerConfig)

events

Array of string (TriggerEvent)

Events that trigger the element trigger. TODO: Make this field required once deprecated POST/PUT /triggers APIs are removed.

Min items1

string

action the trigger listens to

Valid values[ "ObjectCreated:*", "ObjectRemoved:*", "ObjectTagging:Put", "ObjectTagging:Delete" ]

source_bucket_name

string

The bucket name of a VMS View. Relevant for Element Trigger. TODO: Make this field required once deprecated POST/PUT /triggers APIs are removed.

Examplemy-bucket

tag_filters

object (TriggerFilters)

prefixes

Array of string

string

suffixes

Array of string

string

name_filters

object (TriggerFilters)

prefixes

Array of string

string

suffixes

Array of string

string

source_types

Array of string (SourceType)

Source types from which we want to trigger events. Relevant for Element Trigger

Example[ "S3" ]

string

The source protocol from which we want to trigger events. Relevant for Element Trigger

Valid values[ "S3", "NFS4" ]

events

Array of string (TriggerEvent)

Min items1

string

action the trigger listens to

Valid values[ "ObjectCreated:*", "ObjectRemoved:*", "ObjectTagging:Put", "ObjectTagging:Delete" ]

source_bucket_name

string

The bucket name of a VMS View. Relevant for Element Trigger

Examplemy-bucket

topic

string

A logical path for resource grouping and policy assignment. The structure of the logical path is: vast:dataengine:: where resource type is one of: triggers / functions / pipelines / topics / kubernetes-clusters / container-registries / mtls-authentication-credentials.

Examplevast:dataengine:functions:foo

status

string

Operational status of the object.

Valid values[ "Ready", "InProgress", "Error", "Draft", "Deleting" ]

ExampleReady

ScheduleTriggerResponse

object (ScheduleTriggerResponse)

type

string

Valid values[ "Element", "Schedule" ]

name

string

A name for the resource.

Examplenaomis-resource

description

string

A description of the resource.

ExampleA good and detailed description that makes everyone understand.

tags

Array of string

Custom tags for organizing and categorizing resources in the GUI.

Max items32

Example[ "tagA", "tagB", "tagC" ]

string

id

integer (int64)

A globally unique identifier (ID) for the resource.

guid

string (uuid)

A globally unique identifier (GUID) for the resource.

Examplea7f4aa24-a00d-4dc5-a113-2031eb8c2c79

tenant_guid

string (uuid)

A globally unique identifier (GUID) for the resource.

Examplea7f4aa24-a00d-4dc5-a113-2031eb8c2c79

owner

object (UserID)

Represents the owner of the resource.

id

string

The unique identifier for the owner.

id_type

string

The type of identifier for the owner.

Valid values[ "uid", "vid", "sid", "access_key", "sid_str", "login_name", "username" ]

name

string

The presentable name of the owner

created_at

string (date-time)

Timestamp when the resource was created.

Example2024-12-25T15:30:00Z

updated_at

string (date-time)

Timestamp when the resource was last updated.

Example2024-12-28T18:00:00Z

vrn

string

A logical path for resource grouping and policy assignment. The structure of the logical path is: vast:dataengine:: where resource type is one of: triggers / functions / pipelines / topics / kubernetes-clusters / container-registries / mtls-authentication-credentials.

Examplevast:dataengine:functions:foo

broker

object (Broker)

type

string

Valid values[ "External", "Internal" ]

url

string Deprecated

Deprecated. The broker URL is now resolved from VMS by broker name. This field is ignored for VMS-registered brokers and only used as a legacy fallback for brokers not yet registered in VMS. It will be removed in a future release.

Examplehttps://kafka.example.com:6969

name

string

Broker name for external or Bucket (View) name for internal.

Max length40

Examplemy-kafka-broker

is_accessible_to_data_engine

boolean

When true (default), the Data Engine will periodically validate that the broker is accessible. Set to false if the broker is not reachable from the Data Engine (e.g., external brokers behind firewalls).

Defaulttrue

topic_name

string

The name of the topic in the broker. Used with broker field for automatic topic creation.

Examplemy-topic

custom_extensions

object

Custom key/value pairs to be passed as event output extensions. custom key must contain only lowercase letters and digits, start with a letter, and be 1-20 characters long

config

object (ScheduleTriggerConfig)

cron_schedule

string

Cron schedule for a Schedule Trigger.

Example*/15 * * * *

topic

string

A logical path for resource grouping and policy assignment. The structure of the logical path is: vast:dataengine:: where resource type is one of: triggers / functions / pipelines / topics / kubernetes-clusters / container-registries / mtls-authentication-credentials.

Examplevast:dataengine:functions:foo

status

string

Operational status of the object.

Valid values[ "Ready", "InProgress", "Error", "Draft", "Deleting" ]

ExampleReady

401

Unauthorized

Expand All

object

detail

string

source

object (ErrorSource)

Represents the underlying problem that made Data Engine raise the error

source_type

string

The component where the error happened

Examplekubernetes | vms | vdb | registry

source_name

string

The name of the source compoenent

Examplemy-cluster

inner_error

string

The error message from the source component

ExampleFailed to connect to the cluster

code

string

Optional machine-readable error code for clients to branch on instead of parsing detail.

403

Forbidden

Expand All

object

detail

string

source

object (ErrorSource)

Represents the underlying problem that made Data Engine raise the error

source_type

string

The component where the error happened

Examplekubernetes | vms | vdb | registry

source_name

string

The name of the source compoenent

Examplemy-cluster

inner_error

string

The error message from the source component

ExampleFailed to connect to the cluster

code

string

Optional machine-readable error code for clients to branch on instead of parsing detail.

500

Internal Server Error

Expand All

object

detail

string

source

object (ErrorSource)

Represents the underlying problem that made Data Engine raise the error

source_type

string

The component where the error happened

Examplekubernetes | vms | vdb | registry

source_name

string

The name of the source compoenent

Examplemy-cluster

inner_error

string

The error message from the source component

ExampleFailed to connect to the cluster

code

string

Optional machine-readable error code for clients to branch on instead of parsing detail.

List all Triggers with full type-specific details