Skip to main content
API docs by Redocly

Surfsky Cloud Browser (0.1.0)

Download OpenAPI specification:Download

profiles

Start Profile

path Parameters
profile_uuid
required
string (Profile Uuid)
header Parameters
x-cloud-api-token
required
string (X-Cloud-Api-Token) >= 6 characters
Request Body schema: application/json
proxy
string <uri> (Proxy) non-empty
object (OpenVPNConfig)
object (BrowserSettings)

Responses

Request samples

Content type
application/json
{
  • "proxy": "http://example.com",
  • "open_vpn": {
    },
  • "browser_settings": {
    }
}

Response samples

Content type
application/json
null

Profile Scrape

path Parameters
internal_uuid
required
string (Internal Uuid)
Request Body schema: application/json
url
required
string <uri> (Url) non-empty
screenshot
boolean (Screenshot)
Default: false
wait
number (Wait) [ 0 .. 60 ]
Default: 0
wait_until
string (Wait Until)
Default: "domcontentloaded"
Enum: "domcontentloaded" "load" "networkidle" "commit"
wait_for
string (Wait For)

Xpath or CSS selector to wait for on the page

Responses

Request samples

Content type
application/json
{
  • "url": "http://example.com",
  • "screenshot": false,
  • "wait": 0,
  • "wait_until": "domcontentloaded",
  • "wait_for": "string"
}

Response samples

Content type
application/json
null

Stop Profile

path Parameters
internal_uuid
required
string (Internal Uuid)

Responses

Response samples

Content type
application/json
null

Start One Time Profile

header Parameters
x-cloud-api-token
required
string (X-Cloud-Api-Token) >= 6 characters
Request Body schema: application/json
proxy
string <uri> (Proxy) non-empty
object (OpenVPNConfig)
object (BrowserSettings)
object (OneTimeProfileFingerprint)
Array of objects (Cookies) non-empty

Responses

Request samples

Content type
application/json
{
  • "proxy": "http://example.com",
  • "open_vpn": {
    },
  • "browser_settings": {
    },
  • "fingerprint": {
    },
  • "cookies": [
    ]
}

Response samples

Content type
application/json
null