Skip to content
sgp
API Reference

Secrets

Create Secret
Deprecated
secrets.create(SecretCreateParams**kwargs) -> CloudSecret
POST/v5/sgp/secrets
List Secrets
Deprecated
secrets.list(SecretListParams**kwargs) -> SyncCursorPage[CloudSecret]
GET/v5/sgp/secrets
Get Secret
Deprecated
secrets.retrieve(strsecret_id) -> CloudSecret
GET/v5/sgp/secrets/{secret_id}
Update Secret
Deprecated
secrets.update(strsecret_id, SecretUpdateParams**kwargs) -> CloudSecret
PATCH/v5/sgp/secrets/{secret_id}
Delete Secret
Deprecated
secrets.delete(strsecret_id)
DELETE/v5/sgp/secrets/{secret_id}
ModelsExpand Collapse
class CloudSecret: …

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

id: str

The unique identifier of the entity.

account_id: str

The ID of the account that owns the given entity.

cloud_secret_path: str

Full path in the cloud secret store.

created_at: datetime

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

formatdate-time
created_by: Identity

The identity that created the entity.

id: str
type: Literal["user", "service_account"]
One of the following:
"user"
"service_account"
object: Optional[Literal["identity"]]
key: str

Secret name, e.g. OPENAI_API_KEY.

description: Optional[str]

Optional human-readable description of the secret.

object: Optional[Literal["sgp_cloud_secret"]]
updated_at: Optional[datetime]

Timestamp of last update.

formatdate-time
updated_by: Optional[str]

User who last updated the secret.