Console

Start

Platform

App store purchases

Auth

Builds

Database

Flags

Hosting

Jobs and cron

Localization

Monitoring

Network

Notifications

Organizations

Payments

Queues

Events

Realtime

Runners

Sandboxes

Storage

Webhooks

Workflows

Getting Started

Installation

Authentication

AI Services

KV Store

Overview

Webhooks

Deploy & Infrastructure

Reference

On this page

Request
Workflow
ResourceMeta
WorkflowSpec
ServiceHandler
RetryPolicy
WorkflowTimeouts
Response
ResourceMeta
WorkflowSpec
WorkflowStatus
ServiceHandler
RetryPolicy
WorkflowTimeouts
Condition
Errors
Examples

Reference

Update a workflow

Updates a workflow.

Checked 2026-09-28

Updates a workflow.

Path PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/workflows/workflow
Scope workflows:write
Effect write — a successful call changes state.
Collection workflows
Query update_mask, allow_missing, validate_only

#Request

Field	Type	What it is
`workflow`	`Workflow`	The workflow to update; `name` identifies it. Required.
`update_mask`	`field_mask`	The fields to write; unset writes every populated field.
`allow_missing`	`bool`	Create the workflow when it does not exist (declarative upsert).
`validate_only`	`bool`	Validate and return the result without writing anything.

#Workflow

Field	Type	What it is
`name`	`string`	`orgs/{org}/projects/{project}/envs/{env}/workflows/{workflow}`.
`meta`	`ResourceMeta`	Resource metadata.
`spec`	`WorkflowSpec`	Desired state. Required.

#ResourceMeta

Field	Type	What it is
`labels`	`map<string, string>`	Caller-writable, indexed labels (AIP-122 label rules).
`annotations`	`map<string, string>`	Caller-writable, unindexed annotations.
`display_name`	`string`	Caller-writable human-readable name.

#WorkflowSpec

Field	Type	What it is
`handler_uri`	`string`	An HTTPS URI on port 443 whose host is a verified Network Domain of this project or a Hosting route the project owns. One of the `handler` group.
`service_handler`	`ServiceHandler`	A Hosting Service in the same environment, which may be scaled to zero. One of the `handler` group.
`retry_policy`	`RetryPolicy`	How a failed invocation is retried.
`timeouts`	`WorkflowTimeouts`	Invocation and Run deadlines.
`max_concurrent_runs`	`int32`	At most this many running Runs of this Workflow; 0 is unlimited within the plan.

#ServiceHandler

Field	Type	What it is
`service`	`string`	The Hosting Service in the same environment. Required.
`path`	`string`	The request path, for example `/api/sylphx/workflows`. Required.

#RetryPolicy

Field	Type	What it is
`max_attempts`	`int32`	Attempts per step, 1 to 100; default 10.
`initial_interval`	`duration`	The first backoff; default 1s.
`backoff_coefficient`	`double`	Backoff growth, 1.0 to 10.0; default 2.0.
`max_interval`	`duration`	The largest backoff; default 10m.

#WorkflowTimeouts

Field	Type	What it is
`invocation_timeout`	`duration`	One handler invocation, 1s to 900s; default 60s.
`run_timeout`	`duration`	The whole Run, at most 365d; default 30d.

#Response

Field	Type	What it is
`name`	`string`	`orgs/{org}/projects/{project}/envs/{env}/workflows/{workflow}`.
`uid`	`string`	`wf_<cell><ulid>`; never reused. Output only.
`meta`	`ResourceMeta`	Resource metadata.
`spec`	`WorkflowSpec`	Desired state. Required.
`status`	`WorkflowStatus`	Observed state. Output only.

#ResourceMeta

Field	Type	What it is
`generation`	`int64`	Increases by one on every change to `spec`. Output only.
`etag`	`string`	Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as `If-Match` or `etag` to make Update and Delete conditional; a mismatch fails with ABORTED / 409 `ETAG_MISMATCH`. Output only.
`create_time`	`timestamp`	When the Resource was created. Output only.
`update_time`	`timestamp`	When the Resource last changed. Output only.
`delete_time`	`timestamp`	Set while the Resource is being deleted. Output only.
`labels`	`map<string, string>`	Caller-writable, indexed labels (AIP-122 label rules).
`annotations`	`map<string, string>`	Caller-writable, unindexed annotations.
`display_name`	`string`	Caller-writable human-readable name.
`creator`	`string`	The principal that created the Resource. Output only.

#WorkflowSpec

Field	Type	What it is
`handler_uri`	`string`	An HTTPS URI on port 443 whose host is a verified Network Domain of this project or a Hosting route the project owns. One of the `handler` group.
`service_handler`	`ServiceHandler`	A Hosting Service in the same environment, which may be scaled to zero. One of the `handler` group.
`retry_policy`	`RetryPolicy`	How a failed invocation is retried.
`timeouts`	`WorkflowTimeouts`	Invocation and Run deadlines.
`max_concurrent_runs`	`int32`	At most this many running Runs of this Workflow; 0 is unlimited within the plan.

#WorkflowStatus

Field	Type	What it is
`observed_generation`	`int64`	The generation this status was computed from. Output only.
`conditions`	`Condition[]`	Ready, Reconciling, Stalled. Output only.
`resolved_handler_uri`	`string`	The handler URI the current generation resolved to. Output only.

#ServiceHandler

Field	Type	What it is
`service`	`string`	The Hosting Service in the same environment. Required.
`path`	`string`	The request path, for example `/api/sylphx/workflows`. Required.

#RetryPolicy

Field	Type	What it is
`max_attempts`	`int32`	Attempts per step, 1 to 100; default 10.
`initial_interval`	`duration`	The first backoff; default 1s.
`backoff_coefficient`	`double`	Backoff growth, 1.0 to 10.0; default 2.0.
`max_interval`	`duration`	The largest backoff; default 10m.

#WorkflowTimeouts

Field	Type	What it is
`invocation_timeout`	`duration`	One handler invocation, 1s to 900s; default 60s.
`run_timeout`	`duration`	The whole Run, at most 365d; default 30d.

#Condition

Field	Type	What it is
`type`	`string`	The condition type, for example `Ready`.
`status`	`ConditionStatus`	Whether the condition holds. One of `true`, `false`, `unknown`.
`observed_generation`	`int64`	The generation this observation was made against.
`reason`	`string`	A machine-readable UpperCamelCase reason.
`message`	`string`	A customer-safe human-readable message.
`severity`	`Severity`	How severe a FALSE condition is. One of `info`, `warning`, `error`.
`transition_time`	`timestamp`	When `status` last changed.

#Errors

UNAUTHENTICATED — No valid key or token was presented.
PERMISSION_DENIED — The key lacks the method's permission.
RESOURCE_NOT_FOUND — The named Resource does not exist or is not visible.
UNKNOWN_FIELD — The request has a field the schema does not know.
INVALID_FIELD — A field failed validation.
ETAG_MISMATCH — The etag sent does not match the Resource's current etag.
IDEMPOTENCY_KEY_REUSED — An Idempotency-Key was reused with another body.
IDEMPOTENCY_IN_PROGRESS — The first call with this Idempotency-Key is still running.

Every error arrives in the body Errors describes.

#Examples

curl -X PATCH "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/workflows/workflow" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"orgs/acme/projects/shop/envs/production/workflows/workflow","spec":{}}'

Was this page helpful?

Tell us what is missing, wrong, or unclear — this opens a real inbox.

Send feedback

Platform links