Skip to main content
PATCH
/
v5
/
sgp
/
secrets
/
{secret_id}
Update Secret
curl --request PATCH \
  --url https://api.egp.scale.com/v5/sgp/secrets/{secret_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "description": "<string>",
  "value": "<string>"
}
'
{
  "id": "<string>",
  "key": "<string>",
  "cloud_secret_path": "<string>",
  "account_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": {
    "id": "<string>",
    "object": "identity"
  },
  "object": "sgp_cloud_secret",
  "description": "<string>",
  "updated_by": "<string>",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
x-api-key
string
header
required

Headers

​
x-selected-account-id
string | null

Path Parameters

​
secret_id
string
required

Body

application/json

Request body for updating an existing secret's description and/or value.

​
description
string

Updated human-readable description

​
value
string

Updated secret value to store in cloud provider

Minimum string length: 1

Response

Successful Response

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

​
id
string
required
​
key
string
required
​
cloud_secret_path
string
required
​
account_id
string
required
​
created_at
string<date-time>
required
​
created_by
Identity · object
required

The identity that created the entity.

​
object
string
default:sgp_cloud_secret
Allowed value: "sgp_cloud_secret"
​
description
string
​
updated_by
string

User who last updated the secret.

​
updated_at
string<date-time>

Timestamp of last update.