Skip to main content
PATCH
/
deployments
/
secrets
/
{id}
cURL
curl -X PATCH \
      -H "Authorization: Bearer $TOGETHER_API_KEY" \
      --data '{ "value": "my-new-value" }' \
      https://api.together.ai/v1/deployments/secrets/my-secret
{
  "created_at": "<string>",
  "created_by": "<string>",
  "description": "<string>",
  "id": "<string>",
  "last_updated_by": "<string>",
  "name": "<string>",
  "object": "<string>",
  "updated_at": "<string>"
}

Authorizations

​
Authorization
string
header
default:default
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Secret ID or name

Body

application/json

Updated secret configuration

​
description
string

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

Maximum string length: 500
​
name
string

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

Required string length: 1 - 100
​
project_id
string

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

​
value
string

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

Minimum string length: 1

Response

Secret updated successfully

​
created_at
string

CreatedAt is the ISO8601 timestamp when this secret was created

​
created_by
string

CreatedBy is the identifier of the user who created this secret

​
description
string

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

​
id
string

ID is the unique identifier for this secret

​
last_updated_by
string

LastUpdatedBy is the identifier of the user who last updated this secret

​
name
string

Name is the name/key of the secret

​
object
string

Object is the type identifier for this response (always "secret")

​
updated_at
string

UpdatedAt is the ISO8601 timestamp when this secret was last updated