Credentials

Update credential

Overwrites the stored credential data (e.g. username/password) while keeping the same credential_id.

post/v1/credentials/{credential_id}/update

Path parameters

credential_idstring required

The unique identifier of the credential to update

Example:cred_1234567890

The unique identifier of the credential to update

Headers

x-api-keystring nullable

Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.

Request body

namestring required

Name of the credential

credential_type'password' | 'credit_card' | 'secret' required

Type of credential stored in the system.

vault_type'skyvern' | 'bitwarden' | 'azure_vault' | 'gcp' | 'custom'

proxy_session_idstring nullable

Optional advanced reuse key for this credential's pinned proxy identity.

rotate_proxy_session_idboolean

Rotate the Skyvern-managed proxy sticky-session id when updating this credential.

Example request

{
  "name": "Amazon Login",
  "credential": {
    "password": "securepassword123",
    "username": "user@example.com",
    "totp": "JBSWY3DPEHPK3PXP",
    "totp_identifier": "user@example.com"
  },
  "proxy_location": {
    "country": "US",
    "subdivision": "CA",
    "city": "New York"
  }
}

Response

Successful Response

credential_idstring required

Unique identifier for the credential

credential_type'password' | 'credit_card' | 'secret' required

Type of credential stored in the system.

namestring required

Name of the credential

vault_type'skyvern' | 'bitwarden' | 'azure_vault' | 'gcp' | 'custom'

browser_profile_idstring nullable

Browser profile ID linked to this credential

tested_urlstring nullable

user_contextstring nullable

User-provided context describing the login sequence (e.g., 'click SSO button first')

save_browser_session_intentboolean nullable

Whether the user intends to save a browser session, regardless of test outcome

folder_idstring nullable

ID of the credential folder this credential belongs to, if any

proxy_session_idstring nullable

Opaque Skyvern-managed proxy sticky-session id.

Example response

{
  "credential_id": "cred_1234567890",
  "credential": {
    "username": "user@example.com",
    "totp_identifier": "user@example.com"
  },
  "name": "Amazon Login",
  "folder_id": "cfld_1234567890",
  "proxy_location": {
    "country": "US",
    "subdivision": "CA",
    "city": "New York"
  }
}

Changes

Changed in 14 of the 63 revisions of this API.1327

Jul 30, 202619ebfe14460411See the full diff
- ●
  added the new passkey enum value to the credential/anyOf[subschema #1: PasswordCredentialResponse]/totp_type response property for the response status 200
  response-property-enum-value-added
- ○
  added the new passkey enum value to the request property credential/anyOf[subschema #1: NonEmptyPasswordCredential]/totp_type
  request-property-enum-value-added
Jul 14, 20261b9c7c96c0106See the full diff
- ○
  added the new optional request property credential/anyOf[subschema #2: NonEmptyCreditCardCredential]/billing_address
  new-optional-request-property
- ○
  added the new optional request property credential/anyOf[subschema #2: NonEmptyCreditCardCredential]/billing_email
  new-optional-request-property
- ○
  added the new optional request property credential/anyOf[subschema #2: NonEmptyCreditCardCredential]/billing_phone
  new-optional-request-property
- ○
  added the new optional request property credential/anyOf[subschema #2: NonEmptyCreditCardCredential]/metadata
  new-optional-request-property
- ○
  added the optional property proxy_location to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property proxy_session_id to the response with the 200 status
  response-optional-property-added
Jul 14, 202666da0fa97dc56See the full diff
- ●
  removed the request property credential/anyOf[subschema #2: NonEmptyCreditCardCredential]/billing_address
  request-property-removed
- ●
  removed the request property credential/anyOf[subschema #2: NonEmptyCreditCardCredential]/billing_email
  request-property-removed
- ●
  removed the request property credential/anyOf[subschema #2: NonEmptyCreditCardCredential]/billing_phone
  request-property-removed
- ●
  removed the request property credential/anyOf[subschema #2: NonEmptyCreditCardCredential]/metadata
  request-property-removed
- ●
  removed the optional property proxy_location from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property proxy_session_id from the response with the 200 status
  response-optional-property-removed
This revision also has 28 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 14, 20261b9c7c96c0106See the full diff
- ○
  added the new optional request property credential/anyOf[subschema #2: NonEmptyCreditCardCredential]/billing_address
  new-optional-request-property
- ○
  added the new optional request property credential/anyOf[subschema #2: NonEmptyCreditCardCredential]/billing_email
  new-optional-request-property
- ○
  added the new optional request property credential/anyOf[subschema #2: NonEmptyCreditCardCredential]/billing_phone
  new-optional-request-property
- ○
  added the new optional request property credential/anyOf[subschema #2: NonEmptyCreditCardCredential]/metadata
  new-optional-request-property
- ○
  added the optional property proxy_location to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property proxy_session_id to the response with the 200 status
  response-optional-property-added
Jul 7, 202653b0ab74f1673See the full diff
- ○
  added the new optional request property proxy_location
  new-optional-request-property
- ○
  added the new optional request property proxy_session_id
  new-optional-request-property
- ○
  added the new optional request property rotate_proxy_session_id
  new-optional-request-property
Jul 2, 2026fb9f144b21fa11See the full diff
- ●
  added the new skyvern enum value to the vault_type/anyOf[subschema #1: CredentialVaultType]/ response property for the response status 200
  response-property-enum-value-added
- ○
  added the new skyvern enum value to the request property vault_type/anyOf[subschema #1: CredentialVaultType]/
  request-property-enum-value-added
Jun 13, 2026e7044f43e57e11See the full diff
- ●
  added the new gcp enum value to the vault_type/anyOf[subschema #1: CredentialVaultType]/ response property for the response status 200
  response-property-enum-value-added
- ○
  added the new gcp enum value to the request property vault_type/anyOf[subschema #1: CredentialVaultType]/
  request-property-enum-value-added
Jun 7, 2026e37d309fc58f1See the full diff
- ○
  added the optional property folder_id to the response with the 200 status
  response-optional-property-added
Mar 26, 2026d70a0640ef293See the full diff
- ○
  added the new optional request property vault_type
  new-optional-request-property
- ○
  added the optional property save_browser_session_intent to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property vault_type to the response with the 200 status
  response-optional-property-added
This revision also has 28 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 26, 2026458f1f2bbd453See the full diff
- ●
  removed the request property vault_type
  request-property-removed
- ●
  removed the optional property save_browser_session_intent from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property vault_type from the response with the 200 status
  response-optional-property-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history (14 revisions)