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
Secret
ResourceMeta
SecretSpec
Response
ResourceMeta
SecretSpec
SecretStatus
Condition
Errors
Examples

Reference

Create a secret

Creates a secret, without a value; add one with CreateSecretVersion.

Checked 2026-09-28

This method is not served on the public API. api.sylphx.com does not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.

Creates a secret, without a value; add one with CreateSecretVersion.

Path POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/secrets
Scope secrets:write
Effect write — a successful call changes state.
Collection secrets
Query secret_id, validate_only

#Request

Field	Type	What it is
`parent`	`string`	The environment to create in. Required.
`secret`	`Secret`	The secret to create; only spec and caller-writable metadata are read. Required.
`secret_id`	`string`	The id of the new secret, `^[a-z]([a-z0-9_-]{0,61}[a-z0-9])?$`; the server assigns one when empty.
`validate_only`	`bool`	Validate and return the result without writing anything.

#Secret

Field	Type	What it is
`name`	`string`	`orgs/{org}/projects/{project}/envs/{env}/secrets/{secret}`.
`meta`	`ResourceMeta`	Resource metadata.
`spec`	`SecretSpec`	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.

#SecretSpec

Field	Type	What it is
`encryption_key`	`string`	The ENCRYPT Key the values are envelope-encrypted with; unset means the environment's default Key.
`rotation_period`	`duration`	How often the value should be rotated; the Secret reports Ready=FALSE with reason `RotationDue` once the latest version is older.
`deletion_protection`	`bool`	While true, Delete fails with DELETION_PROTECTED. Default true.

#Response

Field	Type	What it is
`name`	`string`	`orgs/{org}/projects/{project}/envs/{env}/secrets/{secret}`.
`uid`	`string`	`sec_<cell><ulid>`. Output only.
`meta`	`ResourceMeta`	Resource metadata.
`spec`	`SecretSpec`	Desired state. Required.
`status`	`SecretStatus`	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.

#SecretSpec

Field	Type	What it is
`encryption_key`	`string`	The ENCRYPT Key the values are envelope-encrypted with; unset means the environment's default Key.
`rotation_period`	`duration`	How often the value should be rotated; the Secret reports Ready=FALSE with reason `RotationDue` once the latest version is older.
`deletion_protection`	`bool`	While true, Delete fails with DELETION_PROTECTED. Default true.

#SecretStatus

Field	Type	What it is
`observed_generation`	`int64`	The generation this status was computed from. Output only.
`conditions`	`Condition[]`	Ready, Reconciling, Stalled. Output only.
`latest_version`	`string`	The newest enabled version; what a binding without a pinned version delivers. Output only.
`rotation_due_time`	`timestamp`	When the latest version should be rotated. Output only.

#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.
UNKNOWN_FIELD — The request has a field the schema does not know.
INVALID_FIELD — A field failed validation.
RESOURCE_ALREADY_EXISTS — A Resource with this name exists.
IDEMPOTENCY_KEY_REUSED — An Idempotency-Key was reused with another body.
IDEMPOTENCY_IN_PROGRESS — The first call with this Idempotency-Key is still running.
PLAN_LIMIT_REACHED — The plan's limit is reached.

Every error arrives in the body Errors describes.

#Examples

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

Was this page helpful?

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

Send feedback

Platform links