Post

/triggers/schedule

Body parameters

Expand All

object

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

broker

object (Broker)

type

string Required

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 Required

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) Required

cron_schedule

string Required

Cron schedule for a Schedule Trigger.

Example*/15 * * * *

Responses

201

The created Schedule Trigger

Expand All

object

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 * * * *

type

string

Valid values[ "Element", "Schedule" ]

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

400

Bad Request

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.

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.

404

Not Found

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.

409

Conflict

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.

422

Validation Error

object

detail

string

String representation of a mapping between field names and error messages

Example{"url": "URL must include a protocol", "port": "Port must be an integer"}

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.

Create a new Schedule Trigger