Documentation / Cookies / Endpoint
PUT

/api/v1/profiles/{id}/cookies

Import cookies (JSON, Netscape, Name=Value, Base64, storageState); apply through the browser, never by editing files

Request#

POSIX shell · curl
curl --fail-with-body --request PUT \
  "$ADBR_API_URL/api/v1/profiles/{id}/cookies" \
  -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: cookies: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
cookies—YesCookies as text (JSON, Netscape, Name=Value, Base64) or as a JSON array
formatunionNo
domainstringNo
modeunionNo
ignore_errorsbooleanNo
skip_expiredbooleanNo
Complete body schema
OpenAPI JSON
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "cookies"
        ],
        "properties": {
          "cookies": {
            "description": "Cookies als Text (JSON, Netscape, Name=Wert, Base64) oder als JSON-Array"
          },
          "format": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "auto"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "json"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "netscape"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "header"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "storage_state"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "base64"
                ]
              }
            ]
          },
          "domain": {
            "type": "string",
            "minLength": 1,
            "maxLength": 253
          },
          "mode": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "merge"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "replace"
                ]
              }
            ]
          },
          "ignore_errors": {
            "type": "boolean"
          },
          "skip_expired": {
            "type": "boolean"
          }
        },
        "additionalProperties": false
      }
    }
  }
}

Responses#

200 · Default response
OpenAPI JSON
{
  "description": "Default Response",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "format",
          "encoding",
          "received",
          "imported",
          "skipped_expired",
          "errors",
          "state",
          "access",
          "failed",
          "held_for_start",
          "pending_reason"
        ],
        "properties": {
          "format": {
            "type": "string"
          },
          "encoding": {
            "type": "string"
          },
          "received": {
            "type": "integer"
          },
          "imported": {
            "type": "integer"
          },
          "skipped_expired": {
            "type": "integer"
          },
          "errors": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "index",
                "name",
                "code",
                "message"
              ],
              "properties": {
                "index": {
                  "type": "integer"
                },
                "name": {
                  "type": [
                    "null",
                    "string"
                  ]
                },
                "code": {
                  "type": "string"
                },
                "message": {
                  "type": "string"
                }
              }
            }
          },
          "state": {
            "type": "string"
          },
          "access": {
            "type": [
              "null",
              "string"
            ]
          },
          "failed": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "name",
                "domain",
                "message"
              ],
              "properties": {
                "name": {
                  "type": "string"
                },
                "domain": {
                  "type": "string"
                },
                "message": {
                  "type": "string"
                }
              }
            }
          },
          "held_for_start": {
            "type": "integer"
          },
          "pending_reason": {
            "type": [
              "null",
              "string"
            ]
          }
        }
      }
    }
  }
}
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": "Cookies importieren (JSON, Netscape, Name=Wert, Base64, storageState); Einspielen über den Browser, nie per Datei",
  "tags": [
    "Cookies"
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "cookies"
          ],
          "properties": {
            "cookies": {
              "description": "Cookies als Text (JSON, Netscape, Name=Wert, Base64) oder als JSON-Array"
            },
            "format": {
              "anyOf": [
                {
                  "type": "string",
                  "enum": [
                    "auto"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "json"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "netscape"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "header"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "storage_state"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "base64"
                  ]
                }
              ]
            },
            "domain": {
              "type": "string",
              "minLength": 1,
              "maxLength": 253
            },
            "mode": {
              "anyOf": [
                {
                  "type": "string",
                  "enum": [
                    "merge"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "replace"
                  ]
                }
              ]
            },
            "ignore_errors": {
              "type": "boolean"
            },
            "skip_expired": {
              "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": [
    "cookies:write"
  ],
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "format",
              "encoding",
              "received",
              "imported",
              "skipped_expired",
              "errors",
              "state",
              "access",
              "failed",
              "held_for_start",
              "pending_reason"
            ],
            "properties": {
              "format": {
                "type": "string"
              },
              "encoding": {
                "type": "string"
              },
              "received": {
                "type": "integer"
              },
              "imported": {
                "type": "integer"
              },
              "skipped_expired": {
                "type": "integer"
              },
              "errors": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": [
                    "index",
                    "name",
                    "code",
                    "message"
                  ],
                  "properties": {
                    "index": {
                      "type": "integer"
                    },
                    "name": {
                      "type": [
                        "null",
                        "string"
                      ]
                    },
                    "code": {
                      "type": "string"
                    },
                    "message": {
                      "type": "string"
                    }
                  }
                }
              },
              "state": {
                "type": "string"
              },
              "access": {
                "type": [
                  "null",
                  "string"
                ]
              },
              "failed": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": [
                    "name",
                    "domain",
                    "message"
                  ],
                  "properties": {
                    "name": {
                      "type": "string"
                    },
                    "domain": {
                      "type": "string"
                    },
                    "message": {
                      "type": "string"
                    }
                  }
                }
              },
              "held_for_start": {
                "type": "integer"
              },
              "pending_reason": {
                "type": [
                  "null",
                  "string"
                ]
              }
            }
          }
        }
      }
    },
    "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