setInstanceSecret

form schema

Create or update a secret on an instance.

If a secret with the given name already exists, its value is replaced. Secret values are encrypted at rest and never returned in API responses. Secrets are injected into the deployment environment at deploy time.

setInstanceSecret(
  organizationId: ID!
  id: ID!
  input: SetInstanceSecretInput!
): InstanceSecretPayload

Form Schema

This mutation supports dynamic form generation using JSON Schema.

• JSON Schema
• UI Schema

Loading schema...

Arguments

setInstanceSecret.organizationId ● ID! non-null scalar {#organization-id}

Your organization's unique identifier.

setInstanceSecret.id ● ID! non-null scalar {#id}

The instance to attach the secret to.

setInstanceSecret.input ● SetInstanceSecretInput! non-null input {#input}

Create or update a secret on an instance. The secret value is encrypted at rest and never returned in API responses.

Type

InstanceSecretPayload object