Update Secret

Deprecated

client.Secrets.Update(ctx, secretID, body) (*CloudSecret, error)

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 param.Field[string]Optional

Updated human-readable description

Value param.Field[string]Optional

Updated secret value to store in cloud provider

minLength1

ReturnsExpand Collapse

type CloudSecret struct{…}

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

ID string

The unique identifier of the entity.

AccountID string

The ID of the account that owns the given entity.

CloudSecretPath string

Full path in the cloud secret store.

CreatedAt Time

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

formatdate-time

CreatedBy Identity

The identity that created the entity.

ID string

Type IdentityType

One of the following:

const IdentityTypeUser IdentityType = "user"

const IdentityTypeServiceAccount IdentityType = "service_account"

Object IdentityObjectOptional

Key string

Secret name, e.g. OPENAI_API_KEY.

Description stringOptional

Optional human-readable description of the secret.

Object CloudSecretObjectOptional

UpdatedAt TimeOptional

Timestamp of last update.

formatdate-time

UpdatedBy stringOptional

User who last updated the secret.

Update Secret

package main

import (
  "context"
  "fmt"

  "github.com/scaleapi/sgp-dev-go"
  "github.com/scaleapi/sgp-dev-go/option"
)

func main() {
  client := sgpdev.NewClient(
    option.WithAPIKey("My API Key"),
    option.WithAccountID("My Account ID"),
  )
  cloudSecret, err := client.Secrets.Update(
    context.TODO(),
    "secret_id",
    sgpdev.SecretUpdateParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", 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"
}