Skip to main content

UpdateCredential

Replace the key for an existing remote origin.

Requires objects.update permission. No input or output blobs are used.

Parameters​

  • origin (string, required): the existing origin, using the same normalization as CreateCredential.

  • key (object, required): the complete replacement credential; omitted members are not preserved.

Behavior​

The origin must exist. Registration validates key fields without contacting the provider. The update commits or rolls back with the query. Wait for success before submitting queries that should use the new key. Updating a credential in the same query as a media read does not change the key used for that read. Requests already underway may finish with the previous key. See Remote credentials for timing in a cluster and key for provider fields.

Response​

Success returns status: 0. Failures return a negative status and an info message; see Responses for error envelopes and retry guidance.

Examples​

[{
    "UpdateCredential": {
        "origin": "s3://training-images",
        "key": {
            "access_key": "<replacement-access-key-id>",
            "secret_access_key": "<replacement-secret-access-key>",
            "region": "us-west-2"
        }
    }
}]

Response:

[{
    "UpdateCredential": {
        "status": 0
    }
}]