Skip to content
sgp
API Reference
Secrets

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}

Update an existing secret’s description and/or value.

If value is provided, the cloud provider secret is updated. The secret value is never returned by any API.

ParametersExpand Collapse
secretID: string
body: SecretUpdateParams { description, value }
description?: string

Updated human-readable description

value?: string

Updated secret value to store in cloud provider

minLength1
ReturnsExpand 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.

Update Secret

import SGPClient from 'scale-gp';

const client = new SGPClient({
  accountID: 'My Account ID',
  apiKey: process.env['SGP_API_KEY'], // This is the default and can be omitted
});

const cloudSecret = await client.secrets.update('secret_id');

console.log(cloudSecret.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"
}