TRtryhamsa

Update a Secret

Updates an existing secret. You can update the name, value, description, or tags.

patch/v1/projects/secrets/{id}

Request

  • Base URL
    https://api.tryhamsa.com
  • URL
    https://api.tryhamsa.com/v1/projects/secrets/{id}
  • Auth
    API key in header Authorization

Path parameters

idstring required
Example:ed9b5601-f731-441a-8500-d9fc7610ef8f

The ID of the secret to update.

Request body

namestring

The new name for the secret.

valuestring

The new secret value.

descriptionstring

The new description for the secret.

tagsstring[]

The new tags for the secret.

Example request

{
  "name": "API_KEY_UPDATED",
  "value": "new-super-secret-value",
  "description": "Updated production API key",
  "tags": [
    "production",
    "api",
    "updated"
  ]
}

Response

Secret updated successfully

successboolean
messagestring

Example response

{
  "success": true,
  "message": "success",
  "data": {
    "id": "ed9b5601-f731-441a-8500-d9fc7610ef8f",
    "name": "API_KEY_UPDATED",
    "description": "Updated production API key",
    "tags": [
      "production",
      "api",
      "updated"
    ],
    "createdAt": "2024-12-15T00:00:00.000Z",
    "updatedAt": "2024-12-15T00:00:00.000Z"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.