Skip to content
sgp
API Reference
Secrets

Get Secret

Deprecated
secrets.retrieve(strsecret_id) -> CloudSecret
GET/v5/sgp/secrets/{secret_id}

Get a single secret’s metadata by ID. The value is never returned.

ParametersExpand Collapse
secret_id: str
ReturnsExpand 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.

Get Secret

import os
from scale_gp_beta import SGPClient

client = SGPClient(
    api_key=os.environ.get("SGP_API_KEY"),  # This is the default and can be omitted
)
cloud_secret = client.secrets.retrieve(
    "secret_id",
)
print(cloud_secret.id)
{
  "id": "id",
  "account_id": "account_id",
  "cloud_secret_path": "cloud_secret_path",
  "created_at": "2019-12-27T18:11:19.117Z",
  "created_by": {
    "id": "id",
    "type": "user",
    "object": "identity"
  },
  "key": "key",
  "description": "description",
  "object": "sgp_cloud_secret",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "updated_by": "updated_by"
}
Returns Examples
{
  "id": "id",
  "account_id": "account_id",
  "cloud_secret_path": "cloud_secret_path",
  "created_at": "2019-12-27T18:11:19.117Z",
  "created_by": {
    "id": "id",
    "type": "user",
    "object": "identity"
  },
  "key": "key",
  "description": "description",
  "object": "sgp_cloud_secret",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "updated_by": "updated_by"
}