Skip to main content

Interface: $Properties

Properties of an EndpointSpec.

Extended by​

Properties​

description?​

optional description?: $Properties | null

Markdown description serialized as a single JSON string. If the Payload is encrypted, the UI and CLI may decrypt with the configured codec server endpoint. By default, the server enforces a limit of 20,000 bytes for this entire payload.

name?​

optional name?: string | null

Endpoint name, unique for this cluster. Must match [a-zA-Z_][a-zA-Z0-9_]*. Renaming an endpoint breaks all workflow callers that reference this endpoint, causing operations to fail.

target?​

optional target?: $Properties | null

Target to route requests to.