Template-Zugangsdaten bearbeiten
Aktualisiert Template-Zugangsdaten anhand ihrer stabilen ID.
https://api2.transloadit.com/ template_credentials/ {templateCredentialId}Aktualisiert die durch TEMPLATE_CREDENTIAL_ID (ihre stabile ID) bezeichneten Template-Zugangsdaten
mit einem neuen Namen und optional aktualisiertem Inhalt. Senden Sie ihren vorhandenen type unverändert erneut;
ein Wechsel des Dienstes erfordert das Erstellen neuer Template-Zugangsdaten.
Dieses Beispiel benennt vorhandene S3-Zugangsdaten um, ohne ihren Inhalt zu ändern. Setzen Sie
TEMPLATE_CREDENTIAL_ID auf die ID dieser Zugangsdaten. Verwenden Sie für einen anderen Dienst dessen vorhandenen
type anstelle von s3.
Bestehende namensbasierte URLs werden aus Kompatibilitätsgründen weiterhin unterstützt. Verwenden Sie für neue Integrationen die stabile ID, damit Umbenennungen oder mehrdeutige Namen nicht ändern, welche Zugangsdaten angesprochen werden.
Beim Aktualisieren von content:
- Lassen Sie
contentweg oder senden Sienull, um den gesamten vorhandenen Inhalt beizubehalten. Eine leere Zeichenfolge ist kein gültiges JSON und keine Anweisung, den Inhalt zu löschen. - Ein übergebenes Objekt wird validiert, bevor es mit dem gespeicherten Inhalt zusammengeführt wird. Geben Sie jedes
Feld an, das im Zugangsdaten-Typ mit
requiredOnUpdategekennzeichnet ist. Andere weggelassene Felder behalten ihre gespeicherten Werte. - Bei einem konfigurierten Feld namens
secretbleibt der gespeicherte geheime Wert erhalten, wenn Sie das Feld weglassen, eine leere Zeichenfolge odernullsenden; ein nicht leerer Wert ersetzt ihn. Diese Ausnahme gilt nicht für andere Felder wiepasswordoderkey_file_contents, deren übergebene Werte die gespeicherten Werte nach der Validierung ersetzen.
Anfragebeispiel
Setzen Sie TEMPLATE_CREDENTIAL_ID auf Ihren Ressourcenwert, ohne ihn zu prozentkodieren.
Führen Sie diese Anfrage in einer serverseitigen Shell mit curl und einem geeigneten Bearer-Token in TRANSLOADIT_TOKEN aus. Wenn Sie ein Token benötigen, klappen Sie die folgende Einrichtungsanleitung auf.
Benötigen Sie ein Bearer-Token?
Setzen Sie in einer vertrauenswürdigen serverseitigen Shell mit curl und jq die Variablen TRANSLOADIT_KEY und TRANSLOADIT_SECRET auf Ihren Auth Key bzw. Ihr Auth Secret. Halten Sie beide Zugangsdaten und das resultierende Token geheim; führen Sie diese Einrichtung niemals in Browser-Code aus.
Erstellen Sie zunächst ein Token mit den für diesen Endpunkt erforderlichen Scopes. Ihr Auth Key muss diese Scopes bereits gewähren.
if ! TOKEN_RESPONSE="$(curl --fail-with-body -sS \
--request POST \
--url 'https://api2.transloadit.com/token' \
--user "${TRANSLOADIT_KEY:?Set TRANSLOADIT_KEY}:${TRANSLOADIT_SECRET:?Set TRANSLOADIT_SECRET}" \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'aud=api2' \
--data-urlencode 'scope=template_credentials:write')"; then
printf '%s\n' "$TOKEN_RESPONSE" >&2
exit 1
fi
TRANSLOADIT_TOKEN="$(printf '%s' "$TOKEN_RESPONSE" |
jq -er '.access_token | strings | select(length > 0)')" || exit 1
Lassen Sie diese Shell geöffnet und führen Sie die folgende Anfrage aus. Verwenden Sie das Token erneut, solange es gültig bleibt.
curl --fail-with-body -sS --request PUT \
--url "https://api2.transloadit.com/template_credentials/${TEMPLATE_CREDENTIAL_ID:?Set TEMPLATE_CREDENTIAL_ID}" \
--header "Authorization: Bearer ${TRANSLOADIT_TOKEN:?Set TRANSLOADIT_TOKEN}" \
--data-urlencode 'params={"name":"s3-renamed","type":"s3"}'
Authentifizierung
Dieser Endpunkt akzeptiert signierte params oder ein Bearer-Token. Anweisungen zur Einrichtung finden Sie unter Authentifizierung.
Erforderlicher Berechtigungsumfang für Auth Key oder Bearer-Token: template_credentials:write.
Signierte Anfragen erfordern sowohl eine signature als auch einen in der Zukunft liegenden Zeitstempel für params.auth.expires. Bearer-Tokens erfordern keines von beiden.
Pfadparameter
templateCredentialId(Pfadsegment), erforderlich. Muster:^[0-9a-f]{32}$, minimale Länge: 32, maximale Länge: 32
Formularfelder
Content-Type: application/x-www-form-urlencoded
params(JSON-Zeichenfolge), erforderlich. Ein JSON-codiertes Objekt, dessen unterstützte Schlüssel unten aufgeführt sind.signature(Zeichenfolge). Für signierte Anfragen erforderlich. Lassen Sie dieses Feld weg, wenn Sie ein Bearer-Token verwenden.
Unterstützte Schlüssel im Feld params
Die Authentifizierungsfelder in dieser Liste gelten für signierte Anfragen. Mit einem Bearer-Token können Sie params.auth und das separate Feld signature weglassen. Vergleichen Sie unten die Anfrageparameter der einzelnen Authentifizierungsmethoden.
Vollständiges JSON Schema
params: Es werden nur die für dieses Objekt aufgeführten Felder akzeptiert.
| Feld | Typ und Beschreibung |
|---|---|
params.für signierte Anfragen erforderlich; mit einem Bearer-Token optional | Enthält den Transloadit-API-Schlüssel und Metadaten für die Signature Authentication einer Anfrage zu Template-Zugangsdaten.
|
params.erforderlich | stringISO-8601-Ablaufzeitstempel in der Zukunft. Erforderlich, wenn eine Anfrage signiert ist oder Signaturauthentifizierung erfordert; mit Bearer authentifizierte Anfragen können ihn weglassen. |
params.erforderlich | stringTransloadit API-Schlüssel zur Authentifizierung von Anfragen |
params. | object | string | nullLassen Sie dieses Feld weg oder senden Sie Eines der folgenden Schemas kann gelten: objectobjectSchema für zusätzliche Eigenschaftenbeliebiger Wertstringnull |
params.erforderlich | stringName der Template-Zugangsdaten. Er muss zwischen 3 und 255 Zeichen lang sein und darf nur Buchstaben, Ziffern, Bindestriche, Unterstriche und Punkte enthalten. Validierungsmuster (regulärer Ausdruck)^[A-Za-z\u212a0-9._-]{3,255}$ |
params. | string | integerEindeutiger Zufallswert, der in die Parameter signierter Anfragen aufgenommen wird, damit jede Signatur eindeutig ist und nicht versehentlich wiederverwendet werden kann. |
params.erforderlich | stringDer Dienst, zu dem diese Zugangsdaten gehören. Senden Sie beim Aktualisieren den vorhandenen Typ unverändert erneut. Um einen anderen Dienst zu verwenden, erstellen Sie neue Template-Zugangsdaten. Zulässige Werte (22)
|
Anfrageparameter nach Authentifizierungsmethode
Mit signierten Parametern
Geben Sie Ihren Auth Key als params.auth.key an. Wenn Sie die Anfrage signieren, geben Sie einen in der Zukunft liegenden Zeitstempel für params.auth.expires an und senden Sie die Signature im separaten Feld signature. Die folgenden Felddefinitionen verwenden Pfade innerhalb von params.
Vollständiges JSON Schema
params: Es werden nur die für dieses Objekt aufgeführten Felder akzeptiert.
Verwendet die oben angegebenen Felddefinitionen: params.auth, params.content, params.name, params.nonce, params.type
Mit einem Bearer-Token
Senden Sie das Bearer-Token im Authorization-Header. Sie können params.auth und das separate Feld signature weglassen. Die übrigen erforderlichen Parameter müssen weiterhin angegeben werden. Die folgenden Felddefinitionen verwenden Pfade innerhalb von params.
Vollständiges JSON Schema
params: Es werden nur die für dieses Objekt aufgeführten Felder akzeptiert.
Verwendet die oben angegebenen Felddefinitionen: params.content, params.name, params.nonce, params.type
| Feld | Typ und Beschreibung |
|---|---|
params. | Enthält den Transloadit-API-Schlüssel und Metadaten für die Signature Authentication einer Anfrage zu Template-Zugangsdaten.
|
params. | stringISO-8601-Ablaufzeitstempel in der Zukunft. Erforderlich, wenn eine Anfrage signiert ist oder Signaturauthentifizierung erfordert; mit Bearer authentifizierte Anfragen können ihn weglassen. |
params. | stringTransloadit API-Schlüssel zur Authentifizierung von Anfragen |
Antwort
Hier sehen Sie ein Beispiel für einen Antworttext:
{
"credential": {
"account_id": "72a70fba93ce41cba617cfd7c2a44b1a",
"content": {
"bucket": "your-bucket",
"bucket_region": "us-east-1",
"key": "YOUR_S3_KEY",
"secret": "YOUR_S3_SECRET"
},
"created": "2026-09-12T10:00:00.000Z",
"deleted": null,
"id": "ca7644b763c848e6af4f4ccf3eaea622",
"modified": "2026-09-12T10:05:00.000Z",
"name": "s3-renamed",
"stringified": "{\"key\":\"YOUR_S3_KEY\",\"secret\":\"YOUR_S3_SECRET\",\"bucket\":\"your-bucket\",\"bucket_region\":\"us-east-1\"}",
"type": "s3"
},
"message": "Your Template Credentials were successfully updated.",
"ok": "TEMPLATE_CREDENTIALS_UPDATED"
}2xx-Erfolg
JSON-Response-Body. application/json text/plain; charset=utf-8
Schema des Response-Bodys
Vollständiges JSON Schema
Die Antwort kann zusätzliche Felder enthalten.
| Feld | Typ und Beschreibung |
|---|---|
credentialerforderlich |
|
credential.erforderlich | string |
credential.erforderlich | object | Array<beliebiger Wert> | string | number | boolean | nullWeitere Schemadetails finden Sie im vollständigen JSON Schema. |
credential.erforderlich | number | string | nullEines der folgenden Schemas kann gelten: number | stringnumber | stringnull |
credential.erforderlich | number | string | nullEines der folgenden Schemas kann gelten: number | stringnumber | stringnull |
credential.erforderlich | string |
credential.erforderlich | number | string | nullEines der folgenden Schemas kann gelten: number | stringnumber | stringnull |
credential.erforderlich | string |
credential.erforderlich | string |
credential.erforderlich | string |
messageerforderlich | string (minimale Länge: 1) |
okerforderlich | string (immer: "TEMPLATE_CREDENTIALS_UPDATED") |
Fehlerantwort
JSON-Response-Body. application/json text/plain; charset=utf-8
Schema des Response-Bodys
Vollständiges JSON Schema
Die Antwort kann zusätzliche Felder enthalten.
| Feld | Typ und Beschreibung |
|---|---|
assembly_id | string |
error | string (minimale Länge: 1) |
http_code | number | string
|
message | stringMenschenlesbare Erklärung des Fehlers. Die Formulierung kann variieren; verwenden Sie den Code |
reason | null | string | number | boolean | Array<beliebiger Wert> | objectEines der folgenden Schemas kann gelten: nullstringnumberbooleanArray<beliebiger Wert>Array<beliebiger Wert>Schema eines Array-Elementsbeliebiger WertobjectobjectSchema für zusätzliche Eigenschaftenbeliebiger Wert |
HTTP 400
JSON-Response-Body. application/json text/plain; charset=utf-8
Schema des Response-Bodys
Vollständiges JSON Schema
Benannte Fehler und das allgemeine Fehlerformat
error: "TEMPLATE_CREDENTIALS_NOT_UPDATED"
Ihre Template-Zugangsdaten konnten nicht aktualisiert werden.
Die Antwort kann zusätzliche Felder enthalten.