Profiles

Update a profile

Changed on

Update an existing profile

patch/v1/profiles/{id}

Request

  • Base URL
    https://api.steel.dev
  • URL
    https://api.steel.dev/v1/profiles/{id}
  • Auth
    • API key in header steel-api-key
    • or none

Path parameters

idstring uuid required

Query parameters

projectIdstring uuid

Project to query profiles from

Request body multipart/form-data

projectIdstring uuid

Project to create the profile in

proxyUrlstring uri

The proxy associated with the profile

useProxystring

JSON-encoded proxy configuration associated with the profile. For fixed IPs, send {"type":"fixed","id":"fixed:<id>"}.

userAgentstring

The user agent associated with the profile

userDataDirstring binary required

The user data directory associated with the profile

Response

Default Response

createdAtstring date-time required

The date and time when the profile was created

credentialsConfigunknown required
extensionIdsstring[] nullable required

The extension IDs associated with the profile

idstring uuid required

The unique identifier for the profile

projectIdstring uuid nullable required

The project ID associated with the profile

sourceSessionIdstring uuid nullable required

The last session ID associated with the profile

status'UPLOADING' | 'READY' | 'FAILED' required

The status of the profile

updatedAtstring date-time required

The date and time when the profile was last updated

useProxyConfigunknown required
userAgentstring nullable required

The user agent associated with the profile

Changes