Skip to main content
POST
/
v1
/
profiles
Create Profile
curl --request POST \
  --url https://api.anchorbrowser.io/v1/profiles \
  --header 'Content-Type: application/json' \
  --header 'anchor-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "source": "session",
  "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "dedicated_sticky_ip": true
}
'
{
  "data": {
    "status": "<string>"
  }
}

Authorizations

​
anchor-api-key
string
header
required

API key passed in the header

Body

application/json
​
name
string
required

The name of the profile.

​
description
string

A description of the profile.

​
source
enum<string>

The source of the profile data. currently only session is supported.

Available options:
session
​
session_id
string<uuid>

The browser session ID is required if the source is set to session. The browser session must be running, and the profile will be stored once the browser session terminates.

​
dedicated_sticky_ip
boolean

Whether to use a dedicated sticky IP for this profile. Defaults to false.

Response

Profile created successfully.

​
data
object