Secrets

Update a secret

Changed on

Update an existing secret's value or metadata

patch/v1/deployments/secrets/{id}

Request

  • Base URL
    https://api.together.ai
  • URL
    https://api.together.ai/v1/deployments/secrets/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

Secret ID or name

Request body

descriptionstring

Description is an optional human-readable description of the secret's purpose (max 500 characters)

namestring

Name is the new unique identifier for the secret. Can contain alphanumeric characters, underscores, hyphens, forward slashes, and periods (1-100 characters)

project_idstring

ProjectID is ignored - the project is automatically determined from your authentication

ttl_secondsinteger

TTLSeconds sets a new lifetime and restarts the expiry from now, between 86400 (1 day) and 1209600 (14 days)

valuestring

Value is the new sensitive data to store securely. Updating this replaces the existing secret value.

Response

Secret updated successfully

created_atstring

CreatedAt is the ISO8601 timestamp when this secret was created

created_bystring

CreatedBy is the identifier of who created this secret.

descriptionstring

Description is a human-readable description of the secret's purpose

expires_atstring date-time

ExpiresAt is the ISO8601 timestamp when this secret expires and is deleted. Changing the value extends it. Omitted for secrets that never expire

idstring

ID is the unique identifier for this secret

last_updated_bystring

LastUpdatedBy is the identifier of who last updated this secret.

namestring

Name is the name/key of the secret

object'secret'

The object type, which is always secret.

ttl_secondsinteger

TTLSeconds is the secret's lifetime in seconds. Omitted when no TTL is set

updated_atstring

UpdatedAt is the ISO8601 timestamp when this secret was last updated

Changes

  • 93438ddac711Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • bb5257b3173aRevision changes
    • info

      endpoint added