SKskyvern-ai
Browser Profiles

Update browser profile

Changed on

Update a browser profile's name and/or description

patch/v1/browser_profiles/{profile_id}

Request

  • Base URL
    https://api.skyvern.com
  • URL
    https://api.skyvern.com/v1/browser_profiles/{profile_id}
  • Auth
    API key in header x-api-key

Path parameters

profile_idstring required

The ID of the browser profile to update. browser_profile_id starts with bp_

Example:bp_123456

Request body

namestring nullable

New name for the browser profile

descriptionstring nullable

New description for the browser profile

proxy_session_idstring nullable

Opaque Skyvern-managed proxy sticky-session id.

rotate_proxy_session_idboolean

Rotate the Skyvern-managed proxy sticky-session id for this profile.

Example request

{
  "proxy_location": {
    "country": "US",
    "subdivision": "CA",
    "city": "New York"
  }
}

Response

Successfully updated browser profile

browser_profile_idstring required
organization_idstring required
namestring required
descriptionstring nullable
source_browser_typestring nullable
proxy_session_idstring nullable
is_managedboolean
workflow_permanent_idstring nullable
browser_profile_key_digeststring nullable
created_atstring date-time required
modified_atstring date-time required
deleted_atstring date-time nullable
last_verified_login_atstring date-time nullable
linked_credential_idstring nullable
linked_credential_namestring nullable

Example response

{
  "proxy_location": {
    "country": "US",
    "subdivision": "CA",
    "city": "New York"
  }
}

Changes

  • 539f04093540Revision changes
    • warning

      deleted the header request parameter x-api-key

    • info

      the endpoint scheme security ApiKeyAuth was added to the API

  • decbcbcd64b0Revision changes
    • info

      added the optional property to the response with the status