Update the specified replication credential.

  • Published on Jul 22, 2025
  • 1 minute(s) read
Prev Next
Patch
/sys/v1/accounts/{acct_id}/replication/credentials/{credential_id}

This can be used to associate an app ID with the credential, and/or upload cert chains for the credential.

Security
HTTP
Type bearer
API Key: apiKeyAuth
Header parameter nameAuthorization
Path parameters
acct_id
string (uuid) Required
credential_id
string (uuid) Required
Body parameters

A request to update a replication credential (e.g., associating it with an app ID).

Note that changing the credential from one type to another is disallowed; users should create a new credential instead.

OneOf
object
object
$type
string Required
Valid values[ "Certificate" ]
app_id
string (uuid) | null

The app ID to associate with the credential. This should be the ID of a source-side admin app.

certificate_chain
Array of string | null

The certificate chain to associate with the credential. This is a list of DER-encoded certificates, starting from the leaf certificate, and may consist of a single certificate if no intermediate certificates are necessary when authenticating with the source cluster.

string (byte)
Responses
2XX

Success result

Details about the admin app credential used to replicate objects from the source account.

OneOf
object
object
$type
string
Valid values[ "Certificate" ]
app_id
string (uuid) | null

The ID of the source-side admin app that uses this credential.

credential_id
string

The ID of a replication credential.

certificate_chain
Array of string | null

The certificate chain associated with the credential. This is a list of DER-encoded certificates, starting from the leaf certificate, and can consist of a single certificate if no intermediate certificates are necessary when authenticating with the source cluster.

string (byte)