Secrets

Update a secret’s description or usage permissions

Takes effect for the next session start that resolves it. Names are immutable (delete and recreate).

patch/v1/secrets/{secret_id}

Request

  • Base URL: https://api.shardflux.dev
  • URL: https://api.shardflux.dev/v1/secrets/{secret_id}
  • Auth: HTTP bearer

Path parameters

secret_idstring uuid required

UUIDv7, lowercase canonical form.

Request body

descriptionstring
allowed_project_idsstring[] nullable
allowed_workspace_idsstring[] nullable
allowed_toolsstring[]

Response

Secret metadata. Values are write-only: no API returns them except the cell resolution endpoint.

idstring uuid required

UUIDv7, lowercase canonical form.

organization_idstring uuid required

UUIDv7, lowercase canonical form.

project_idstring uuid nullable required

UUIDv7, lowercase canonical form.

namestring required

Environment variable name the value is injected as.

descriptionstring required
current_versioninteger required
created_atstring date-time required

RFC 3339 UTC timestamp with Z.

updated_atstring date-time required

RFC 3339 UTC timestamp with Z.

rotated_atstring date-time nullable required

RFC 3339 UTC timestamp with Z.

deleted_atstring date-time nullable required

RFC 3339 UTC timestamp with Z.

Changes

No recorded changes to this operation across all 1 revision of this API.