Documentation / Profiles / Endpoint
PATCH

/api/v1/profiles/{id}

Edit a profile; kernel and operating system are fixed after creation

Request#

POSIX shell · curl
curl --fail-with-body --request PATCH \
  "$ADBR_API_URL/api/v1/profiles/{id}" \
  -H "Authorization: Bearer $ADBR_API_TOKEN" \
  -H "Content-Type: application/json" \
  --data @request.json

Use the local address and token from API & MCP. Replace path placeholders such as {id} with actual IDs. Create request.json according to the body schema below before running this command.

Authentication and permissions#

Authentication: Bearer token

Scopes: profiles:write

All listed scopes are required; admin satisfies scope checks. Account permissions, request content, vault state and resource permissions can impose additional requirements.

Parameters#

ParameterLocationRequiredDescription
operation_idqueryNo
idpathYes
Complete parameter schemas
OpenAPI JSON
[
  {
    "schema": {
      "type": "string",
      "pattern": "^[a-zA-Z0-9-]{16,64}$"
    },
    "in": "query",
    "name": "operation_id",
    "required": false
  },
  {
    "schema": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "in": "path",
    "name": "id",
    "required": true
  }
]

Request body#

Required.

FieldTypeRequiredDescription
namestringNo
notesstring | nullNoChanged notes may contain up to 400 Unicode code points. Unchanged existing notes are preserved.
group_idstring | nullNo
group_namestringNo
tag_idsarrayNo
tagsarrayNo
status_idstring | nullNo
pinnedbooleanNo
colorstring | nullNo
custom_nostring | nullNo
engineunionNo
engine_versionstringNo
engine_auto_updatebooleanNo
osunionNo
os_versionstring | nullNo
user_agentstring | nullNo
fingerprint_overridesobjectNo
proxyobjectNo
ip_checkerstring | nullNo
browser_optionsobjectNo
netobjectNo
start_modeunionNo
start_urlsarrayNo
open_account_pagesbooleanNo
homepagestring | nullNo
launch_argsarrayNo
extension_set_idstring | nullNo
storage_optionsobjectNo
clear_on_closeobjectNo
cache_dir_overridestring | nullNo
accountsarrayNo
fingerprint_seedsobjectNo
row_versionintegerNo
regenerate_fingerprintbooleanNo
Complete body schema
OpenAPI JSON
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 100
          },
          "notes": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 5000,
            "description": "Changed notes may contain up to 400 Unicode code points. Unchanged existing notes are preserved."
          },
          "group_id": {
            "type": [
              "string",
              "null"
            ]
          },
          "group_name": {
            "type": "string",
            "maxLength": 100
          },
          "tag_ids": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "maxItems": 30
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1,
              "maxLength": 50
            },
            "maxItems": 30
          },
          "status_id": {
            "type": [
              "string",
              "null"
            ]
          },
          "pinned": {
            "type": "boolean"
          },
          "color": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 32
          },
          "custom_no": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "engine": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "chromium"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "firefox"
                ]
              }
            ]
          },
          "engine_version": {
            "type": "string",
            "minLength": 1,
            "maxLength": 16
          },
          "engine_auto_update": {
            "type": "boolean"
          },
          "os": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "windows"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "macos"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "linux"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "android"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "ios"
                ]
              }
            ]
          },
          "os_version": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 32
          },
          "user_agent": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 512
          },
          "fingerprint_overrides": {
            "type": "object",
            "additionalProperties": {}
          },
          "proxy": {
            "type": "object",
            "required": [
              "mode"
            ],
            "properties": {
              "ssh_private_key": {
                "type": [
                  "string",
                  "null"
                ],
                "maxLength": 65536
              },
              "ssh_key_passphrase": {
                "type": [
                  "string",
                  "null"
                ],
                "maxLength": 1024
              },
              "mode": {
                "anyOf": [
                  {
                    "type": "string",
                    "enum": [
                      "none"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "ref"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "inline"
                    ]
                  }
                ]
              },
              "proxy_id": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "proxy_group_id": {
                "type": [
                  "string",
                  "null"
                ],
                "maxLength": 64
              },
              "ssh_host_key": {
                "type": [
                  "string",
                  "null"
                ],
                "pattern": "^SHA256:[A-Za-z0-9+/]{43}$"
              },
              "protocol": {
                "anyOf": [
                  {
                    "type": "string",
                    "enum": [
                      "http"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "https"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "socks4"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "socks4a"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "socks5"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "socks5h"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "ssh"
                    ]
                  }
                ]
              },
              "host": {
                "type": "string",
                "minLength": 1,
                "maxLength": 255
              },
              "port": {
                "type": "integer",
                "minimum": 1,
                "maximum": 65535
              },
              "username": {
                "type": [
                  "string",
                  "null"
                ],
                "maxLength": 512
              },
              "password": {
                "type": [
                  "string",
                  "null"
                ],
                "maxLength": 1024
              }
            },
            "additionalProperties": false
          },
          "ip_checker": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 32
          },
          "browser_options": {
            "type": "object",
            "properties": {
              "block_images": {
                "type": "boolean"
              },
              "block_video": {
                "type": "boolean"
              },
              "block_audio": {
                "type": "boolean"
              },
              "block_notifications": {
                "type": "boolean"
              },
              "block_password_view": {
                "type": "boolean"
              },
              "block_password_save": {
                "type": "boolean"
              },
              "block_extension_pages": {
                "type": "boolean"
              },
              "block_translation": {
                "type": "boolean"
              },
              "block_devtools": {
                "type": "boolean"
              },
              "local_network": {
                "type": "object",
                "required": [
                  "blocked",
                  "allowed_ports"
                ],
                "properties": {
                  "blocked": {
                    "type": "boolean"
                  },
                  "allowed_ports": {
                    "type": "string",
                    "maxLength": 1536
                  }
                },
                "additionalProperties": false
              },
              "taskbar_icon": {
                "anyOf": [
                  {
                    "type": "string",
                    "minLength": 50,
                    "maxLength": 393216
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "ui_language": {
                "anyOf": [
                  {
                    "type": "string",
                    "minLength": 2,
                    "maxLength": 35
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "tls_cipher_blocklist": {
                "anyOf": [
                  {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 256
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "secure_dns": {
                "anyOf": [
                  {
                    "type": "object",
                    "required": [
                      "mode"
                    ],
                    "properties": {
                      "mode": {
                        "type": "string",
                        "enum": [
                          "off"
                        ]
                      }
                    },
                    "additionalProperties": false
                  },
                  {
                    "type": "object",
                    "required": [
                      "mode",
                      "server"
                    ],
                    "properties": {
                      "mode": {
                        "type": "string",
                        "enum": [
                          "secure"
                        ]
                      },
                      "server": {
                        "type": "string",
                        "minLength": 9,
                        "maxLength": 2048
                      }
                    },
                    "additionalProperties": false
                  }
                ]
              }
            },
            "additionalProperties": false
          },
          "net": {
            "type": "object",
            "additionalProperties": {}
          },
          "start_mode": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "new_tab"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "last_tabs"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "urls"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "last_and_urls"
                ]
              }
            ]
          },
          "start_urls": {
            "type": "array",
            "items": {
              "type": "string",
              "maxLength": 2048
            },
            "maxItems": 20
          },
          "open_account_pages": {
            "type": "boolean"
          },
          "homepage": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 512
          },
          "launch_args": {
            "type": "array",
            "items": {
              "type": "string",
              "maxLength": 1024
            },
            "maxItems": 100
          },
          "extension_set_id": {
            "type": [
              "string",
              "null"
            ]
          },
          "storage_options": {
            "type": "object",
            "additionalProperties": {
              "type": "boolean"
            }
          },
          "clear_on_close": {
            "type": "object",
            "additionalProperties": {
              "type": "boolean"
            }
          },
          "cache_dir_override": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 512
          },
          "accounts": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "platform_url"
              ],
              "properties": {
                "platform_url": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 256
                },
                "username": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "maxLength": 256
                },
                "password": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "maxLength": 1024
                },
                "totp_secret": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "maxLength": 1024
                },
                "notes": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "maxLength": 1024
                },
                "sort_order": {
                  "type": "integer",
                  "minimum": 0
                },
                "id": {
                  "type": "string",
                  "minLength": 1
                }
              },
              "additionalProperties": false
            },
            "maxItems": 50
          },
          "fingerprint_seeds": {
            "type": "object",
            "required": [
              "identity",
              "canvas",
              "webgl",
              "audio",
              "clientRects"
            ],
            "properties": {
              "identity": {
                "type": "integer",
                "minimum": 1,
                "maximum": 9007199254740991
              },
              "canvas": {
                "type": "integer",
                "minimum": 0,
                "maximum": 4294967295
              },
              "webgl": {
                "type": "integer",
                "minimum": 0,
                "maximum": 4294967295
              },
              "audio": {
                "type": "integer",
                "minimum": 0,
                "maximum": 4294967295
              },
              "clientRects": {
                "type": "integer",
                "minimum": 0,
                "maximum": 4294967295
              }
            },
            "additionalProperties": false
          },
          "row_version": {
            "type": "integer",
            "minimum": 1
          },
          "regenerate_fingerprint": {
            "type": "boolean"
          }
        },
        "additionalProperties": false
      }
    }
  }
}

Responses#

200 · Default response
OpenAPI JSON
{
  "description": "Default Response",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "id",
          "no",
          "compat_user_id",
          "display_no",
          "custom_no",
          "folder_key",
          "name",
          "notes",
          "group",
          "tags",
          "status",
          "pinned",
          "color",
          "engine",
          "engine_version",
          "engine_auto_update",
          "engine_build_last_used",
          "os",
          "os_version",
          "user_agent",
          "fingerprint",
          "proxy",
          "ip_checker",
          "browser_options",
          "net",
          "start_mode",
          "start_urls",
          "homepage",
          "launch_args",
          "extension_set_id",
          "storage_options",
          "clear_on_close",
          "cache_dir_override",
          "source",
          "imported_from",
          "runtime_state",
          "accounts_count",
          "created_at",
          "created_by",
          "updated_at",
          "updated_by",
          "last_opened_at",
          "last_closed_at",
          "last_exit_ip",
          "last_exit_country",
          "last_proxy_check",
          "row_version"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "no": {
            "type": "integer"
          },
          "compat_user_id": {
            "type": "string"
          },
          "display_no": {
            "type": "integer",
            "minimum": 1
          },
          "custom_no": {
            "type": [
              "null",
              "string"
            ]
          },
          "folder_key": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "notes": {
            "type": [
              "null",
              "string"
            ]
          },
          "group": {
            "anyOf": [
              {
                "type": "object",
                "required": [
                  "id",
                  "name"
                ],
                "properties": {
                  "id": {
                    "type": "string"
                  },
                  "name": {
                    "type": "string"
                  }
                }
              },
              {
                "type": "null"
              }
            ]
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "name",
                "color"
              ],
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "color": {
                  "type": "string"
                }
              }
            }
          },
          "status": {
            "anyOf": [
              {
                "type": "object",
                "required": [
                  "id",
                  "name",
                  "color"
                ],
                "properties": {
                  "id": {
                    "type": "string"
                  },
                  "name": {
                    "type": "string"
                  },
                  "color": {
                    "type": "string"
                  }
                }
              },
              {
                "type": "null"
              }
            ]
          },
          "pinned": {
            "type": "boolean"
          },
          "color": {
            "type": [
              "null",
              "string"
            ]
          },
          "engine": {
            "type": "string"
          },
          "engine_version": {
            "type": "string"
          },
          "engine_auto_update": {
            "type": "boolean"
          },
          "engine_build_last_used": {
            "type": [
              "null",
              "string"
            ]
          },
          "os": {
            "type": "string"
          },
          "os_version": {
            "type": [
              "null",
              "string"
            ]
          },
          "user_agent": {
            "type": [
              "null",
              "string"
            ]
          },
          "fingerprint": {
            "type": "object",
            "required": [
              "id",
              "schema",
              "overrides",
              "seeds"
            ],
            "properties": {
              "id": {
                "type": "string"
              },
              "schema": {
                "type": "integer"
              },
              "overrides": {
                "type": "object",
                "additionalProperties": {}
              },
              "seeds": {
                "type": "object",
                "required": [
                  "identity",
                  "canvas",
                  "webgl",
                  "audio",
                  "clientRects"
                ],
                "properties": {
                  "identity": {
                    "type": "integer"
                  },
                  "canvas": {
                    "type": "integer"
                  },
                  "webgl": {
                    "type": "integer"
                  },
                  "audio": {
                    "type": "integer"
                  },
                  "clientRects": {
                    "type": "integer"
                  }
                }
              }
            }
          },
          "proxy": {
            "type": "object",
            "required": [
              "mode",
              "proxy_id",
              "inline"
            ],
            "properties": {
              "mode": {
                "type": "string"
              },
              "proxy_id": {
                "type": [
                  "null",
                  "string"
                ]
              },
              "group_id": {
                "type": [
                  "null",
                  "string"
                ]
              },
              "group_name": {
                "type": [
                  "null",
                  "string"
                ]
              },
              "inline": {
                "anyOf": [
                  {
                    "type": "object",
                    "required": [
                      "protocol",
                      "host",
                      "port",
                      "username",
                      "password_set",
                      "ssh_key_set"
                    ],
                    "properties": {
                      "protocol": {
                        "type": "string"
                      },
                      "host": {
                        "type": "string"
                      },
                      "port": {
                        "type": "integer"
                      },
                      "username": {
                        "type": [
                          "string",
                          "null"
                        ]
                      },
                      "password_set": {
                        "type": "boolean"
                      },
                      "ssh_key_set": {
                        "type": "boolean"
                      },
                      "ssh_host_key": {
                        "type": [
                          "string",
                          "null"
                        ]
                      }
                    }
                  },
                  {
                    "type": "null"
                  }
                ]
              }
            }
          },
          "ip_checker": {
            "type": [
              "null",
              "string"
            ]
          },
          "browser_options": {
            "type": "object",
            "properties": {
              "block_images": {
                "type": "boolean"
              },
              "block_video": {
                "type": "boolean"
              },
              "block_audio": {
                "type": "boolean"
              },
              "block_notifications": {
                "type": "boolean"
              },
              "block_password_view": {
                "type": "boolean"
              },
              "block_password_save": {
                "type": "boolean"
              },
              "block_extension_pages": {
                "type": "boolean"
              },
              "block_translation": {
                "type": "boolean"
              },
              "block_devtools": {
                "type": "boolean"
              },
              "local_network": {
                "type": "object",
                "required": [
                  "blocked",
                  "allowed_ports"
                ],
                "properties": {
                  "blocked": {
                    "type": "boolean"
                  },
                  "allowed_ports": {
                    "type": "string",
                    "maxLength": 1536
                  }
                },
                "additionalProperties": false
              },
              "taskbar_icon": {
                "anyOf": [
                  {
                    "type": "string",
                    "minLength": 50,
                    "maxLength": 393216
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "ui_language": {
                "anyOf": [
                  {
                    "type": "string",
                    "minLength": 2,
                    "maxLength": 35
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "tls_cipher_blocklist": {
                "anyOf": [
                  {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 256
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "secure_dns": {
                "anyOf": [
                  {
                    "type": "object",
                    "required": [
                      "mode"
                    ],
                    "properties": {
                      "mode": {
                        "type": "string",
                        "enum": [
                          "off"
                        ]
                      }
                    },
                    "additionalProperties": false
                  },
                  {
                    "type": "object",
                    "required": [
                      "mode",
                      "server"
                    ],
                    "properties": {
                      "mode": {
                        "type": "string",
                        "enum": [
                          "secure"
                        ]
                      },
                      "server": {
                        "type": "string",
                        "minLength": 9,
                        "maxLength": 2048
                      }
                    },
                    "additionalProperties": false
                  }
                ]
              }
            },
            "additionalProperties": false
          },
          "net": {
            "type": "object",
            "additionalProperties": {}
          },
          "start_mode": {
            "type": "string"
          },
          "start_urls": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "homepage": {
            "type": [
              "null",
              "string"
            ]
          },
          "launch_args": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "extension_set_id": {
            "type": [
              "null",
              "string"
            ]
          },
          "storage_options": {
            "type": "object",
            "additionalProperties": {
              "type": "boolean"
            }
          },
          "clear_on_close": {
            "type": "object",
            "additionalProperties": {
              "type": "boolean"
            }
          },
          "cache_dir_override": {
            "type": [
              "null",
              "string"
            ]
          },
          "source": {
            "type": [
              "null",
              "string"
            ]
          },
          "imported_from": {
            "type": [
              "null",
              "string"
            ]
          },
          "runtime_state": {
            "type": "string"
          },
          "accounts_count": {
            "type": "integer"
          },
          "created_at": {
            "type": "integer"
          },
          "created_by": {
            "type": "string"
          },
          "updated_at": {
            "type": "integer"
          },
          "updated_by": {
            "type": "string"
          },
          "last_opened_at": {
            "type": [
              "null",
              "integer"
            ]
          },
          "last_closed_at": {
            "type": [
              "null",
              "integer"
            ]
          },
          "last_exit_ip": {
            "type": [
              "null",
              "string"
            ]
          },
          "last_exit_country": {
            "type": [
              "null",
              "string"
            ]
          },
          "last_proxy_check": {
            "anyOf": [
              {
                "type": "object",
                "required": [
                  "ok",
                  "checked_at",
                  "error_class",
                  "error_code",
                  "protocol_detected",
                  "ipv4",
                  "ipv6",
                  "country",
                  "region",
                  "city",
                  "postal_code",
                  "latitude",
                  "longitude",
                  "accuracy_km",
                  "timezone",
                  "utc_offset",
                  "languages",
                  "asn",
                  "as_org",
                  "latency_ms",
                  "geo_source",
                  "duplicate_profiles"
                ],
                "properties": {
                  "ok": {
                    "type": "boolean"
                  },
                  "checked_at": {
                    "type": "integer"
                  },
                  "error_class": {
                    "type": [
                      "null",
                      "string"
                    ]
                  },
                  "error_code": {
                    "type": [
                      "null",
                      "string"
                    ]
                  },
                  "protocol_detected": {
                    "type": [
                      "null",
                      "string"
                    ]
                  },
                  "ipv4": {
                    "type": [
                      "null",
                      "string"
                    ]
                  },
                  "ipv6": {
                    "type": [
                      "null",
                      "string"
                    ]
                  },
                  "country": {
                    "type": [
                      "null",
                      "string"
                    ]
                  },
                  "region": {
                    "type": [
                      "null",
                      "string"
                    ]
                  },
                  "city": {
                    "type": [
                      "null",
                      "string"
                    ]
                  },
                  "postal_code": {
                    "type": [
                      "null",
                      "string"
                    ]
                  },
                  "latitude": {
                    "type": [
                      "null",
                      "number"
                    ]
                  },
                  "longitude": {
                    "type": [
                      "null",
                      "number"
                    ]
                  },
                  "accuracy_km": {
                    "type": [
                      "null",
                      "number"
                    ]
                  },
                  "timezone": {
                    "type": [
                      "null",
                      "string"
                    ]
                  },
                  "utc_offset": {
                    "type": [
                      "null",
                      "string"
                    ]
                  },
                  "languages": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "asn": {
                    "type": [
                      "null",
                      "integer"
                    ]
                  },
                  "as_org": {
                    "type": [
                      "null",
                      "string"
                    ]
                  },
                  "latency_ms": {
                    "type": "object",
                    "required": [
                      "tcp",
                      "handshake",
                      "first_byte"
                    ],
                    "properties": {
                      "tcp": {
                        "type": [
                          "null",
                          "number"
                        ]
                      },
                      "handshake": {
                        "type": [
                          "null",
                          "number"
                        ]
                      },
                      "first_byte": {
                        "type": [
                          "null",
                          "number"
                        ]
                      }
                    }
                  },
                  "geo_source": {
                    "type": [
                      "null",
                      "string"
                    ]
                  },
                  "duplicate_profiles": {
                    "type": "integer"
                  }
                }
              },
              {
                "type": "null"
              }
            ]
          },
          "row_version": {
            "type": "integer"
          }
        }
      }
    }
  }
}
default · HTTP error envelope. The status and error.code identify the failure.
OpenAPI JSON
{
  "description": "HTTP error envelope. The status and error.code identify the failure.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}

General authentication and transport errors may occur in addition to the documented responses.

OpenAPI definition#

Complete operation definition
OpenAPI JSON
{
  "summary": "Profil bearbeiten; Kern und Betriebssystem sind nach der Anlage fest",
  "tags": [
    "Profile"
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "maxLength": 100
            },
            "notes": {
              "type": [
                "string",
                "null"
              ],
              "maxLength": 5000,
              "description": "Changed notes may contain up to 400 Unicode code points. Unchanged existing notes are preserved."
            },
            "group_id": {
              "type": [
                "string",
                "null"
              ]
            },
            "group_name": {
              "type": "string",
              "maxLength": 100
            },
            "tag_ids": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "maxItems": 30
            },
            "tags": {
              "type": "array",
              "items": {
                "type": "string",
                "minLength": 1,
                "maxLength": 50
              },
              "maxItems": 30
            },
            "status_id": {
              "type": [
                "string",
                "null"
              ]
            },
            "pinned": {
              "type": "boolean"
            },
            "color": {
              "type": [
                "string",
                "null"
              ],
              "maxLength": 32
            },
            "custom_no": {
              "type": [
                "string",
                "null"
              ],
              "maxLength": 64
            },
            "engine": {
              "anyOf": [
                {
                  "type": "string",
                  "enum": [
                    "chromium"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "firefox"
                  ]
                }
              ]
            },
            "engine_version": {
              "type": "string",
              "minLength": 1,
              "maxLength": 16
            },
            "engine_auto_update": {
              "type": "boolean"
            },
            "os": {
              "anyOf": [
                {
                  "type": "string",
                  "enum": [
                    "windows"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "macos"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "linux"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "android"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "ios"
                  ]
                }
              ]
            },
            "os_version": {
              "type": [
                "string",
                "null"
              ],
              "maxLength": 32
            },
            "user_agent": {
              "type": [
                "string",
                "null"
              ],
              "maxLength": 512
            },
            "fingerprint_overrides": {
              "type": "object",
              "additionalProperties": {}
            },
            "proxy": {
              "type": "object",
              "required": [
                "mode"
              ],
              "properties": {
                "ssh_private_key": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "maxLength": 65536
                },
                "ssh_key_passphrase": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "maxLength": 1024
                },
                "mode": {
                  "anyOf": [
                    {
                      "type": "string",
                      "enum": [
                        "none"
                      ]
                    },
                    {
                      "type": "string",
                      "enum": [
                        "ref"
                      ]
                    },
                    {
                      "type": "string",
                      "enum": [
                        "inline"
                      ]
                    }
                  ]
                },
                "proxy_id": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "proxy_group_id": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "maxLength": 64
                },
                "ssh_host_key": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "pattern": "^SHA256:[A-Za-z0-9+/]{43}$"
                },
                "protocol": {
                  "anyOf": [
                    {
                      "type": "string",
                      "enum": [
                        "http"
                      ]
                    },
                    {
                      "type": "string",
                      "enum": [
                        "https"
                      ]
                    },
                    {
                      "type": "string",
                      "enum": [
                        "socks4"
                      ]
                    },
                    {
                      "type": "string",
                      "enum": [
                        "socks4a"
                      ]
                    },
                    {
                      "type": "string",
                      "enum": [
                        "socks5"
                      ]
                    },
                    {
                      "type": "string",
                      "enum": [
                        "socks5h"
                      ]
                    },
                    {
                      "type": "string",
                      "enum": [
                        "ssh"
                      ]
                    }
                  ]
                },
                "host": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 255
                },
                "port": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 65535
                },
                "username": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "maxLength": 512
                },
                "password": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "maxLength": 1024
                }
              },
              "additionalProperties": false
            },
            "ip_checker": {
              "type": [
                "string",
                "null"
              ],
              "maxLength": 32
            },
            "browser_options": {
              "type": "object",
              "properties": {
                "block_images": {
                  "type": "boolean"
                },
                "block_video": {
                  "type": "boolean"
                },
                "block_audio": {
                  "type": "boolean"
                },
                "block_notifications": {
                  "type": "boolean"
                },
                "block_password_view": {
                  "type": "boolean"
                },
                "block_password_save": {
                  "type": "boolean"
                },
                "block_extension_pages": {
                  "type": "boolean"
                },
                "block_translation": {
                  "type": "boolean"
                },
                "block_devtools": {
                  "type": "boolean"
                },
                "local_network": {
                  "type": "object",
                  "required": [
                    "blocked",
                    "allowed_ports"
                  ],
                  "properties": {
                    "blocked": {
                      "type": "boolean"
                    },
                    "allowed_ports": {
                      "type": "string",
                      "maxLength": 1536
                    }
                  },
                  "additionalProperties": false
                },
                "taskbar_icon": {
                  "anyOf": [
                    {
                      "type": "string",
                      "minLength": 50,
                      "maxLength": 393216
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "ui_language": {
                  "anyOf": [
                    {
                      "type": "string",
                      "minLength": 2,
                      "maxLength": 35
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "tls_cipher_blocklist": {
                  "anyOf": [
                    {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 256
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "secure_dns": {
                  "anyOf": [
                    {
                      "type": "object",
                      "required": [
                        "mode"
                      ],
                      "properties": {
                        "mode": {
                          "type": "string",
                          "enum": [
                            "off"
                          ]
                        }
                      },
                      "additionalProperties": false
                    },
                    {
                      "type": "object",
                      "required": [
                        "mode",
                        "server"
                      ],
                      "properties": {
                        "mode": {
                          "type": "string",
                          "enum": [
                            "secure"
                          ]
                        },
                        "server": {
                          "type": "string",
                          "minLength": 9,
                          "maxLength": 2048
                        }
                      },
                      "additionalProperties": false
                    }
                  ]
                }
              },
              "additionalProperties": false
            },
            "net": {
              "type": "object",
              "additionalProperties": {}
            },
            "start_mode": {
              "anyOf": [
                {
                  "type": "string",
                  "enum": [
                    "new_tab"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "last_tabs"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "urls"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "last_and_urls"
                  ]
                }
              ]
            },
            "start_urls": {
              "type": "array",
              "items": {
                "type": "string",
                "maxLength": 2048
              },
              "maxItems": 20
            },
            "open_account_pages": {
              "type": "boolean"
            },
            "homepage": {
              "type": [
                "string",
                "null"
              ],
              "maxLength": 512
            },
            "launch_args": {
              "type": "array",
              "items": {
                "type": "string",
                "maxLength": 1024
              },
              "maxItems": 100
            },
            "extension_set_id": {
              "type": [
                "string",
                "null"
              ]
            },
            "storage_options": {
              "type": "object",
              "additionalProperties": {
                "type": "boolean"
              }
            },
            "clear_on_close": {
              "type": "object",
              "additionalProperties": {
                "type": "boolean"
              }
            },
            "cache_dir_override": {
              "type": [
                "string",
                "null"
              ],
              "maxLength": 512
            },
            "accounts": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "platform_url"
                ],
                "properties": {
                  "platform_url": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 256
                  },
                  "username": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "maxLength": 256
                  },
                  "password": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "maxLength": 1024
                  },
                  "totp_secret": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "maxLength": 1024
                  },
                  "notes": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "maxLength": 1024
                  },
                  "sort_order": {
                    "type": "integer",
                    "minimum": 0
                  },
                  "id": {
                    "type": "string",
                    "minLength": 1
                  }
                },
                "additionalProperties": false
              },
              "maxItems": 50
            },
            "fingerprint_seeds": {
              "type": "object",
              "required": [
                "identity",
                "canvas",
                "webgl",
                "audio",
                "clientRects"
              ],
              "properties": {
                "identity": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 9007199254740991
                },
                "canvas": {
                  "type": "integer",
                  "minimum": 0,
                  "maximum": 4294967295
                },
                "webgl": {
                  "type": "integer",
                  "minimum": 0,
                  "maximum": 4294967295
                },
                "audio": {
                  "type": "integer",
                  "minimum": 0,
                  "maximum": 4294967295
                },
                "clientRects": {
                  "type": "integer",
                  "minimum": 0,
                  "maximum": 4294967295
                }
              },
              "additionalProperties": false
            },
            "row_version": {
              "type": "integer",
              "minimum": 1
            },
            "regenerate_fingerprint": {
              "type": "boolean"
            }
          },
          "additionalProperties": false
        }
      }
    }
  },
  "parameters": [
    {
      "schema": {
        "type": "string",
        "pattern": "^[a-zA-Z0-9-]{16,64}$"
      },
      "in": "query",
      "name": "operation_id",
      "required": false
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 64
      },
      "in": "path",
      "name": "id",
      "required": true
    }
  ],
  "x-required-scopes": [
    "profiles:write"
  ],
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "id",
              "no",
              "compat_user_id",
              "display_no",
              "custom_no",
              "folder_key",
              "name",
              "notes",
              "group",
              "tags",
              "status",
              "pinned",
              "color",
              "engine",
              "engine_version",
              "engine_auto_update",
              "engine_build_last_used",
              "os",
              "os_version",
              "user_agent",
              "fingerprint",
              "proxy",
              "ip_checker",
              "browser_options",
              "net",
              "start_mode",
              "start_urls",
              "homepage",
              "launch_args",
              "extension_set_id",
              "storage_options",
              "clear_on_close",
              "cache_dir_override",
              "source",
              "imported_from",
              "runtime_state",
              "accounts_count",
              "created_at",
              "created_by",
              "updated_at",
              "updated_by",
              "last_opened_at",
              "last_closed_at",
              "last_exit_ip",
              "last_exit_country",
              "last_proxy_check",
              "row_version"
            ],
            "properties": {
              "id": {
                "type": "string"
              },
              "no": {
                "type": "integer"
              },
              "compat_user_id": {
                "type": "string"
              },
              "display_no": {
                "type": "integer",
                "minimum": 1
              },
              "custom_no": {
                "type": [
                  "null",
                  "string"
                ]
              },
              "folder_key": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "notes": {
                "type": [
                  "null",
                  "string"
                ]
              },
              "group": {
                "anyOf": [
                  {
                    "type": "object",
                    "required": [
                      "id",
                      "name"
                    ],
                    "properties": {
                      "id": {
                        "type": "string"
                      },
                      "name": {
                        "type": "string"
                      }
                    }
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "tags": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": [
                    "id",
                    "name",
                    "color"
                  ],
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    },
                    "color": {
                      "type": "string"
                    }
                  }
                }
              },
              "status": {
                "anyOf": [
                  {
                    "type": "object",
                    "required": [
                      "id",
                      "name",
                      "color"
                    ],
                    "properties": {
                      "id": {
                        "type": "string"
                      },
                      "name": {
                        "type": "string"
                      },
                      "color": {
                        "type": "string"
                      }
                    }
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "pinned": {
                "type": "boolean"
              },
              "color": {
                "type": [
                  "null",
                  "string"
                ]
              },
              "engine": {
                "type": "string"
              },
              "engine_version": {
                "type": "string"
              },
              "engine_auto_update": {
                "type": "boolean"
              },
              "engine_build_last_used": {
                "type": [
                  "null",
                  "string"
                ]
              },
              "os": {
                "type": "string"
              },
              "os_version": {
                "type": [
                  "null",
                  "string"
                ]
              },
              "user_agent": {
                "type": [
                  "null",
                  "string"
                ]
              },
              "fingerprint": {
                "type": "object",
                "required": [
                  "id",
                  "schema",
                  "overrides",
                  "seeds"
                ],
                "properties": {
                  "id": {
                    "type": "string"
                  },
                  "schema": {
                    "type": "integer"
                  },
                  "overrides": {
                    "type": "object",
                    "additionalProperties": {}
                  },
                  "seeds": {
                    "type": "object",
                    "required": [
                      "identity",
                      "canvas",
                      "webgl",
                      "audio",
                      "clientRects"
                    ],
                    "properties": {
                      "identity": {
                        "type": "integer"
                      },
                      "canvas": {
                        "type": "integer"
                      },
                      "webgl": {
                        "type": "integer"
                      },
                      "audio": {
                        "type": "integer"
                      },
                      "clientRects": {
                        "type": "integer"
                      }
                    }
                  }
                }
              },
              "proxy": {
                "type": "object",
                "required": [
                  "mode",
                  "proxy_id",
                  "inline"
                ],
                "properties": {
                  "mode": {
                    "type": "string"
                  },
                  "proxy_id": {
                    "type": [
                      "null",
                      "string"
                    ]
                  },
                  "group_id": {
                    "type": [
                      "null",
                      "string"
                    ]
                  },
                  "group_name": {
                    "type": [
                      "null",
                      "string"
                    ]
                  },
                  "inline": {
                    "anyOf": [
                      {
                        "type": "object",
                        "required": [
                          "protocol",
                          "host",
                          "port",
                          "username",
                          "password_set",
                          "ssh_key_set"
                        ],
                        "properties": {
                          "protocol": {
                            "type": "string"
                          },
                          "host": {
                            "type": "string"
                          },
                          "port": {
                            "type": "integer"
                          },
                          "username": {
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "password_set": {
                            "type": "boolean"
                          },
                          "ssh_key_set": {
                            "type": "boolean"
                          },
                          "ssh_host_key": {
                            "type": [
                              "string",
                              "null"
                            ]
                          }
                        }
                      },
                      {
                        "type": "null"
                      }
                    ]
                  }
                }
              },
              "ip_checker": {
                "type": [
                  "null",
                  "string"
                ]
              },
              "browser_options": {
                "type": "object",
                "properties": {
                  "block_images": {
                    "type": "boolean"
                  },
                  "block_video": {
                    "type": "boolean"
                  },
                  "block_audio": {
                    "type": "boolean"
                  },
                  "block_notifications": {
                    "type": "boolean"
                  },
                  "block_password_view": {
                    "type": "boolean"
                  },
                  "block_password_save": {
                    "type": "boolean"
                  },
                  "block_extension_pages": {
                    "type": "boolean"
                  },
                  "block_translation": {
                    "type": "boolean"
                  },
                  "block_devtools": {
                    "type": "boolean"
                  },
                  "local_network": {
                    "type": "object",
                    "required": [
                      "blocked",
                      "allowed_ports"
                    ],
                    "properties": {
                      "blocked": {
                        "type": "boolean"
                      },
                      "allowed_ports": {
                        "type": "string",
                        "maxLength": 1536
                      }
                    },
                    "additionalProperties": false
                  },
                  "taskbar_icon": {
                    "anyOf": [
                      {
                        "type": "string",
                        "minLength": 50,
                        "maxLength": 393216
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "ui_language": {
                    "anyOf": [
                      {
                        "type": "string",
                        "minLength": 2,
                        "maxLength": 35
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "tls_cipher_blocklist": {
                    "anyOf": [
                      {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 256
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "secure_dns": {
                    "anyOf": [
                      {
                        "type": "object",
                        "required": [
                          "mode"
                        ],
                        "properties": {
                          "mode": {
                            "type": "string",
                            "enum": [
                              "off"
                            ]
                          }
                        },
                        "additionalProperties": false
                      },
                      {
                        "type": "object",
                        "required": [
                          "mode",
                          "server"
                        ],
                        "properties": {
                          "mode": {
                            "type": "string",
                            "enum": [
                              "secure"
                            ]
                          },
                          "server": {
                            "type": "string",
                            "minLength": 9,
                            "maxLength": 2048
                          }
                        },
                        "additionalProperties": false
                      }
                    ]
                  }
                },
                "additionalProperties": false
              },
              "net": {
                "type": "object",
                "additionalProperties": {}
              },
              "start_mode": {
                "type": "string"
              },
              "start_urls": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "homepage": {
                "type": [
                  "null",
                  "string"
                ]
              },
              "launch_args": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "extension_set_id": {
                "type": [
                  "null",
                  "string"
                ]
              },
              "storage_options": {
                "type": "object",
                "additionalProperties": {
                  "type": "boolean"
                }
              },
              "clear_on_close": {
                "type": "object",
                "additionalProperties": {
                  "type": "boolean"
                }
              },
              "cache_dir_override": {
                "type": [
                  "null",
                  "string"
                ]
              },
              "source": {
                "type": [
                  "null",
                  "string"
                ]
              },
              "imported_from": {
                "type": [
                  "null",
                  "string"
                ]
              },
              "runtime_state": {
                "type": "string"
              },
              "accounts_count": {
                "type": "integer"
              },
              "created_at": {
                "type": "integer"
              },
              "created_by": {
                "type": "string"
              },
              "updated_at": {
                "type": "integer"
              },
              "updated_by": {
                "type": "string"
              },
              "last_opened_at": {
                "type": [
                  "null",
                  "integer"
                ]
              },
              "last_closed_at": {
                "type": [
                  "null",
                  "integer"
                ]
              },
              "last_exit_ip": {
                "type": [
                  "null",
                  "string"
                ]
              },
              "last_exit_country": {
                "type": [
                  "null",
                  "string"
                ]
              },
              "last_proxy_check": {
                "anyOf": [
                  {
                    "type": "object",
                    "required": [
                      "ok",
                      "checked_at",
                      "error_class",
                      "error_code",
                      "protocol_detected",
                      "ipv4",
                      "ipv6",
                      "country",
                      "region",
                      "city",
                      "postal_code",
                      "latitude",
                      "longitude",
                      "accuracy_km",
                      "timezone",
                      "utc_offset",
                      "languages",
                      "asn",
                      "as_org",
                      "latency_ms",
                      "geo_source",
                      "duplicate_profiles"
                    ],
                    "properties": {
                      "ok": {
                        "type": "boolean"
                      },
                      "checked_at": {
                        "type": "integer"
                      },
                      "error_class": {
                        "type": [
                          "null",
                          "string"
                        ]
                      },
                      "error_code": {
                        "type": [
                          "null",
                          "string"
                        ]
                      },
                      "protocol_detected": {
                        "type": [
                          "null",
                          "string"
                        ]
                      },
                      "ipv4": {
                        "type": [
                          "null",
                          "string"
                        ]
                      },
                      "ipv6": {
                        "type": [
                          "null",
                          "string"
                        ]
                      },
                      "country": {
                        "type": [
                          "null",
                          "string"
                        ]
                      },
                      "region": {
                        "type": [
                          "null",
                          "string"
                        ]
                      },
                      "city": {
                        "type": [
                          "null",
                          "string"
                        ]
                      },
                      "postal_code": {
                        "type": [
                          "null",
                          "string"
                        ]
                      },
                      "latitude": {
                        "type": [
                          "null",
                          "number"
                        ]
                      },
                      "longitude": {
                        "type": [
                          "null",
                          "number"
                        ]
                      },
                      "accuracy_km": {
                        "type": [
                          "null",
                          "number"
                        ]
                      },
                      "timezone": {
                        "type": [
                          "null",
                          "string"
                        ]
                      },
                      "utc_offset": {
                        "type": [
                          "null",
                          "string"
                        ]
                      },
                      "languages": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        }
                      },
                      "asn": {
                        "type": [
                          "null",
                          "integer"
                        ]
                      },
                      "as_org": {
                        "type": [
                          "null",
                          "string"
                        ]
                      },
                      "latency_ms": {
                        "type": "object",
                        "required": [
                          "tcp",
                          "handshake",
                          "first_byte"
                        ],
                        "properties": {
                          "tcp": {
                            "type": [
                              "null",
                              "number"
                            ]
                          },
                          "handshake": {
                            "type": [
                              "null",
                              "number"
                            ]
                          },
                          "first_byte": {
                            "type": [
                              "null",
                              "number"
                            ]
                          }
                        }
                      },
                      "geo_source": {
                        "type": [
                          "null",
                          "string"
                        ]
                      },
                      "duplicate_profiles": {
                        "type": "integer"
                      }
                    }
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "row_version": {
                "type": "integer"
              }
            }
          }
        }
      }
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}

Search for headless, MCP, cookies or an API endpoint.

↑ ↓ NavigateEnter OpenEsc Close