## Update Secret

**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.

### Path Parameters

- `secret_id: string`

### Body Parameters

- `description: optional string`

  Updated human-readable description

- `value: optional string`

  Updated secret value to store in cloud provider

### Returns

- `CloudSecret object { 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.

  - `created_by: Identity`

    The identity that created the entity.

    - `id: string`

    - `type: "user" or "service_account"`

      - `"user"`

      - `"service_account"`

    - `object: optional "identity"`

      - `"identity"`

  - `key: string`

    Secret name, e.g. OPENAI_API_KEY.

  - `description: optional string`

    Optional human-readable description of the secret.

  - `object: optional "sgp_cloud_secret"`

    - `"sgp_cloud_secret"`

  - `updated_at: optional string`

    Timestamp of last update.

  - `updated_by: optional string`

    User who last updated the secret.

### Example

```http
curl https://api.egp.scale.com/v5/sgp/secrets/$SECRET_ID \
    -X PATCH \
    -H 'Content-Type: application/json' \
    -H "x-api-key: $SGP_API_KEY" \
    -d '{}'
```

#### Response

```json
{
  "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"
}
```