Skip to content
sgp
API Reference

Secrets

Create Secret
Deprecated
client.secrets.create(SecretCreateParams { key, value, description } body, RequestOptionsoptions?): CloudSecret { id, account_id, cloud_secret_path, 7 more }
POST/v5/sgp/secrets
List Secrets
Deprecated
client.secrets.list(SecretListParams { ending_before, limit, sort_by, 2 more } query?, RequestOptionsoptions?): CursorPage<CloudSecret { id, account_id, cloud_secret_path, 7 more } >
GET/v5/sgp/secrets
Get Secret
Deprecated
client.secrets.retrieve(stringsecretID, RequestOptionsoptions?): CloudSecret { id, account_id, cloud_secret_path, 7 more }
GET/v5/sgp/secrets/{secret_id}
Update Secret
Deprecated
client.secrets.update(stringsecretID, SecretUpdateParams { description, value } body, RequestOptionsoptions?): CloudSecret { id, account_id, cloud_secret_path, 7 more }
PATCH/v5/sgp/secrets/{secret_id}
Delete Secret
Deprecated
client.secrets.delete(stringsecretID, RequestOptionsoptions?): void
DELETE/v5/sgp/secrets/{secret_id}
ModelsExpand Collapse
CloudSecret { id, account_id, cloud_secret_path, 7 more }

API response model for a secret. Never includes the secret value.

id: string

The unique identifier of the entity.

account_id: string

The ID of the account that owns the given entity.

cloud_secret_path: string

Full path in the cloud secret store.

created_at: string

The date and time when the entity was created in ISO format.

formatdate-time
created_by: Identity { id, type, object }

The identity that created the entity.

id: string
type: "user" | "service_account"
One of the following:
"user"
"service_account"
object?: "identity"
key: string

Secret name, e.g. OPENAI_API_KEY.

description?: string

Optional human-readable description of the secret.

object?: "sgp_cloud_secret"
updated_at?: string

Timestamp of last update.

formatdate-time
updated_by?: string

User who last updated the secret.