CreateProfile

POST/profile

Last modified: 4 months ago

create profile

Request

Authorization: API Key

Add parameter in header

x-api-key

Example

x-api-key: 2f68dbbf-519d-4f01-9636-e2421b68f379

args

object

optional

custom args with kernel command line switches

Additional properties

string

optional

fingerprint

object

optional

custom fingerprint

deviceMemory

enum<integer>

optional

deviceMemory

Allowed values:

248

Example:

disableImageLoading

boolean

optional

disableImageLoading

doNotTrack

boolean

optional

DoNotTrack

flags

object

optional

fingerprint flags

fonts

array[string]

optional

fonts list,works on flags.fonts == 'Custom'

geolocation

object

optional

geolocation,works on flags.localization == 'Custom'

hardwareConcurrency

enum<integer>

optional

hardwareConcurrency

Allowed values:

24810121416

Example:

localization

object

optional

languages,works on flags.localization == 'Custom'; localization.timezone works on flags.localization == 'Custom'

restoreLastSession

boolean

optional

indicates the last session should be restored on startup

screen

object

optional

screen,works on flags.screen == 'Custom'

userAgent

string

optional

navigator.userAgent

webrtc

object

optional

webrtc ips,works on flags.webrtc == 'Custom'

groupId

string

optional

profile group id, invalid for once profile

Example:

1e455935-3e3e-4e3e-8e3e-3e3e3e3e3e3e

groupName

string

optional

an existing group name,prioritize using groupId if set, invalid for once profile

Example:

Default

kernel

enum<string>

required

kernel type

Allowed value:

chromium

Example:

chromium

kernelMilestone

enum<string>

required

kernelMilestone

Allowed values:

124120113

Example:

124

name

string

required

profile name

Example:

Profile

note

string

optional

profile note, invalid for once profile

platform

enum<string>

required

fingerprint os platform

Allowed values:

windowsmaclinux

Example:

windows

proxy

string

optional

profile proxy, higher priority than proxyGroupName

Example:

http://username:password@ip:port

proxyGroupName

string

optional

an existing proxy group name, invalid for once profile

remoteDebuggingPort

integer

optional

browser port

startupUrls

array[string]

optional

startup urls

{
  "name": "testProfile",
  "platform": "windows",
  "kernel": "chromium",
  "kernelMilestone": "128"
}

Request samples

Responses

OK(200)

HTTP Code: 200

Content Type : JSONapplication/json

code

integer

optional

data

object (business.CreateProfileResp)

optional

_id

string

optional

createdAt

string

optional

fingerprintId

string

optional

groupId

string

optional

kernel

integer

optional

kernelMilestone

string

optional

kernelVersion

string

optional

name

string

optional

note

string

optional

platform

integer

optional

platformVersion

string

optional

profileId

string

optional

saveLocal

boolean

optional

status

integer

optional

tags

array[string]

optional

teamId

string

optional

uaFullVersion

string

optional

updatedAt

string

optional

userId

string

optional

err

boolean

optional

msg

string

optional

{
  "code": 0,
  "data": {
    "_id": "string",
    "createdAt": "string",
    "fingerprintId": "string",
    "groupId": "string",
    "kernel": 0,
    "kernelMilestone": "string",
    "kernelVersion": "string",
    "name": "string",
    "note": "string",
    "platform": 0,
    "platformVersion": "string",
    "profileId": "string",
    "saveLocal": true,
    "status": 0,
    "tags": [
      "string"
    ],
    "teamId": "string",
    "uaFullVersion": "string",
    "updatedAt": "string",
    "userId": "string"
  },
  "err": true,
  "msg": "string"
}

Last modified: 4 months ago