TabGeckoDocs
Zur Website
Dokumentation / Cookies · API

Cookies · API

Aus dem OpenAPI-Stand erzeugt. Quellzusammenfassungen bleiben unverändert; die JSON-Schemas unten sind die exakten exportierten Definitionen.

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

Cookies eines Profils lesen (laufend über CDP, sonst über eine unsichtbare Wartungssitzung des Kerns)

Authentifizierung: Bearer-Token

Erforderliche Routen-Scopes: cookies:read

Alle aufgeführten Scopes sind erforderlich; admin erfüllt Scope-Prüfungen. Anfrageinhalt, Tresorzustand und Ressourcenrechte können zusätzliche Voraussetzungen setzen.

NameOrtPflichtBeschreibung
formatqueryNein
idpathJa
Vollständige Parameterschemas
OpenAPI JSON
[
  {
    "schema": {
      "anyOf": [
        {
          "type": "string",
          "enum": [
            "json"
          ]
        },
        {
          "type": "string",
          "enum": [
            "netscape"
          ]
        },
        {
          "type": "string",
          "enum": [
            "header"
          ]
        }
      ]
    },
    "in": "query",
    "name": "format",
    "required": false
  },
  {
    "schema": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "in": "path",
    "name": "id",
    "required": true
  }
]

Kein Anfragekörper deklariert.

Dokumentierte Antworten
OpenAPI JSON
{
  "200": {
    "description": "Default Response",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "format",
            "count",
            "cookies",
            "content"
          ],
          "properties": {
            "format": {
              "type": "string"
            },
            "count": {
              "type": "integer"
            },
            "cookies": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "name",
                  "value",
                  "domain",
                  "host_only",
                  "path",
                  "expires",
                  "http_only",
                  "secure",
                  "same_site",
                  "session",
                  "partition_key",
                  "priority",
                  "source_scheme",
                  "source_port",
                  "creation",
                  "last_access"
                ],
                "properties": {
                  "firefox": {
                    "type": "object",
                    "required": [
                      "partition_key",
                      "partitioned",
                      "user_context_id"
                    ],
                    "properties": {
                      "partition_key": {
                        "type": "string"
                      },
                      "partitioned": {
                        "type": "boolean"
                      },
                      "user_context_id": {
                        "type": "integer"
                      }
                    }
                  },
                  "name": {
                    "type": "string"
                  },
                  "value": {
                    "type": "string"
                  },
                  "domain": {
                    "type": "string"
                  },
                  "host_only": {
                    "type": "boolean"
                  },
                  "path": {
                    "type": "string"
                  },
                  "expires": {
                    "type": [
                      "null",
                      "number"
                    ]
                  },
                  "http_only": {
                    "type": "boolean"
                  },
                  "secure": {
                    "type": "boolean"
                  },
                  "same_site": {
                    "type": "string"
                  },
                  "session": {
                    "type": "boolean"
                  },
                  "partition_key": {
                    "anyOf": [
                      {
                        "type": "object",
                        "required": [
                          "top_level_site",
                          "has_cross_site_ancestor"
                        ],
                        "properties": {
                          "top_level_site": {
                            "type": "string"
                          },
                          "has_cross_site_ancestor": {
                            "type": "boolean"
                          }
                        }
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "priority": {
                    "type": [
                      "null",
                      "string"
                    ]
                  },
                  "source_scheme": {
                    "type": [
                      "null",
                      "string"
                    ]
                  },
                  "source_port": {
                    "type": [
                      "null",
                      "integer"
                    ]
                  },
                  "creation": {
                    "type": [
                      "null",
                      "number"
                    ]
                  },
                  "last_access": {
                    "type": [
                      "null",
                      "number"
                    ]
                  }
                }
              }
            },
            "content": {
              "type": "string"
            }
          }
        }
      }
    }
  },
  "default": {
    "description": "HTTP error envelope. The status and error.code identify the failure.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}
Vollständige Operationsdefinition
OpenAPI JSON
{
  "summary": "Cookies eines Profils lesen (laufend über CDP, sonst über eine unsichtbare Wartungssitzung des Kerns)",
  "tags": [
    "Cookies"
  ],
  "parameters": [
    {
      "schema": {
        "anyOf": [
          {
            "type": "string",
            "enum": [
              "json"
            ]
          },
          {
            "type": "string",
            "enum": [
              "netscape"
            ]
          },
          {
            "type": "string",
            "enum": [
              "header"
            ]
          }
        ]
      },
      "in": "query",
      "name": "format",
      "required": false
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 64
      },
      "in": "path",
      "name": "id",
      "required": true
    }
  ],
  "x-required-scopes": [
    "cookies:read"
  ],
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "format",
              "count",
              "cookies",
              "content"
            ],
            "properties": {
              "format": {
                "type": "string"
              },
              "count": {
                "type": "integer"
              },
              "cookies": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": [
                    "name",
                    "value",
                    "domain",
                    "host_only",
                    "path",
                    "expires",
                    "http_only",
                    "secure",
                    "same_site",
                    "session",
                    "partition_key",
                    "priority",
                    "source_scheme",
                    "source_port",
                    "creation",
                    "last_access"
                  ],
                  "properties": {
                    "firefox": {
                      "type": "object",
                      "required": [
                        "partition_key",
                        "partitioned",
                        "user_context_id"
                      ],
                      "properties": {
                        "partition_key": {
                          "type": "string"
                        },
                        "partitioned": {
                          "type": "boolean"
                        },
                        "user_context_id": {
                          "type": "integer"
                        }
                      }
                    },
                    "name": {
                      "type": "string"
                    },
                    "value": {
                      "type": "string"
                    },
                    "domain": {
                      "type": "string"
                    },
                    "host_only": {
                      "type": "boolean"
                    },
                    "path": {
                      "type": "string"
                    },
                    "expires": {
                      "type": [
                        "null",
                        "number"
                      ]
                    },
                    "http_only": {
                      "type": "boolean"
                    },
                    "secure": {
                      "type": "boolean"
                    },
                    "same_site": {
                      "type": "string"
                    },
                    "session": {
                      "type": "boolean"
                    },
                    "partition_key": {
                      "anyOf": [
                        {
                          "type": "object",
                          "required": [
                            "top_level_site",
                            "has_cross_site_ancestor"
                          ],
                          "properties": {
                            "top_level_site": {
                              "type": "string"
                            },
                            "has_cross_site_ancestor": {
                              "type": "boolean"
                            }
                          }
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "priority": {
                      "type": [
                        "null",
                        "string"
                      ]
                    },
                    "source_scheme": {
                      "type": [
                        "null",
                        "string"
                      ]
                    },
                    "source_port": {
                      "type": [
                        "null",
                        "integer"
                      ]
                    },
                    "creation": {
                      "type": [
                        "null",
                        "number"
                      ]
                    },
                    "last_access": {
                      "type": [
                        "null",
                        "number"
                      ]
                    }
                  }
                }
              },
              "content": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}

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

Cookies importieren (JSON, Netscape, Name=Wert, Base64, storageState); Einspielen über den Browser, nie per Datei

Authentifizierung: Bearer-Token

Erforderliche Routen-Scopes: cookies:write

Alle aufgeführten Scopes sind erforderlich; admin erfüllt Scope-Prüfungen. Anfrageinhalt, Tresorzustand und Ressourcenrechte können zusätzliche Voraussetzungen setzen.

NameOrtPflichtBeschreibung
idpathJa
Vollständige Parameterschemas
OpenAPI JSON
[
  {
    "schema": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "in": "path",
    "name": "id",
    "required": true
  }
]
Anfragekörper · erforderlich
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
      }
    }
  }
}
Dokumentierte Antworten
OpenAPI JSON
{
  "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"
        }
      }
    }
  }
}
Vollständige Operationsdefinition
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",
        "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"
          }
        }
      }
    }
  }
}

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

Alle Cookies eines Profils löschen, auch noch nicht eingespielte Importe

Authentifizierung: Bearer-Token

Erforderliche Routen-Scopes: cookies:write

Alle aufgeführten Scopes sind erforderlich; admin erfüllt Scope-Prüfungen. Anfrageinhalt, Tresorzustand und Ressourcenrechte können zusätzliche Voraussetzungen setzen.

NameOrtPflichtBeschreibung
idpathJa
Vollständige Parameterschemas
OpenAPI JSON
[
  {
    "schema": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "in": "path",
    "name": "id",
    "required": true
  }
]

Kein Anfragekörper deklariert.

Dokumentierte Antworten
OpenAPI JSON
{
  "200": {
    "description": "Default Response",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "cleared",
            "access"
          ],
          "properties": {
            "cleared": {
              "type": "boolean"
            },
            "access": {
              "type": "string"
            }
          }
        }
      }
    }
  },
  "default": {
    "description": "HTTP error envelope. The status and error.code identify the failure.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}
Vollständige Operationsdefinition
OpenAPI JSON
{
  "summary": "Alle Cookies eines Profils löschen, auch noch nicht eingespielte Importe",
  "tags": [
    "Cookies"
  ],
  "parameters": [
    {
      "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": [
              "cleared",
              "access"
            ],
            "properties": {
              "cleared": {
                "type": "boolean"
              },
              "access": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}

POST /api/v1/profiles/batch/cookies

Dieselben Cookies in mehrere Profile importieren: je Profil vorgemerkt und im Hintergrund über den Browser eingespielt (laufende Profile sofort)

Authentifizierung: Bearer-Token

Erforderliche Routen-Scopes: cookies:write

Alle aufgeführten Scopes sind erforderlich; admin erfüllt Scope-Prüfungen. Anfrageinhalt, Tresorzustand und Ressourcenrechte können zusätzliche Voraussetzungen setzen.

Keine Pfad- oder Query-Parameter deklariert.

Anfragekörper · erforderlich
OpenAPI JSON
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "ids",
          "cookies"
        ],
        "properties": {
          "ids": {
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1,
              "maxLength": 64
            },
            "minItems": 1,
            "maxItems": 1000
          },
          "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
      }
    }
  }
}
Dokumentierte Antworten
OpenAPI JSON
{
  "200": {
    "description": "Default Response",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "format",
            "received",
            "results"
          ],
          "properties": {
            "format": {
              "type": "string"
            },
            "received": {
              "type": "integer"
            },
            "results": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "id",
                  "no",
                  "ok",
                  "queued",
                  "error"
                ],
                "properties": {
                  "id": {
                    "type": "string"
                  },
                  "no": {
                    "type": [
                      "null",
                      "integer"
                    ]
                  },
                  "ok": {
                    "type": "boolean"
                  },
                  "queued": {
                    "type": "integer"
                  },
                  "error": {
                    "type": [
                      "null",
                      "string"
                    ]
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "default": {
    "description": "HTTP error envelope. The status and error.code identify the failure.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}
Vollständige Operationsdefinition
OpenAPI JSON
{
  "summary": "Dieselben Cookies in mehrere Profile importieren: je Profil vorgemerkt und im Hintergrund über den Browser eingespielt (laufende Profile sofort)",
  "tags": [
    "Cookies"
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "ids",
            "cookies"
          ],
          "properties": {
            "ids": {
              "type": "array",
              "items": {
                "type": "string",
                "minLength": 1,
                "maxLength": 64
              },
              "minItems": 1,
              "maxItems": 1000
            },
            "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
        }
      }
    }
  },
  "x-required-scopes": [
    "cookies:write"
  ],
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "format",
              "received",
              "results"
            ],
            "properties": {
              "format": {
                "type": "string"
              },
              "received": {
                "type": "integer"
              },
              "results": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": [
                    "id",
                    "no",
                    "ok",
                    "queued",
                    "error"
                  ],
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "no": {
                      "type": [
                        "null",
                        "integer"
                      ]
                    },
                    "ok": {
                      "type": "boolean"
                    },
                    "queued": {
                      "type": "integer"
                    },
                    "error": {
                      "type": [
                        "null",
                        "string"
                      ]
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}

POST /api/v1/profiles/batch/cookies/export

Cookies mehrerer Profile lesen (höchstens 100) und als ZIP mit einer Datei je Profil zurückgeben

Authentifizierung: Bearer-Token

Erforderliche Routen-Scopes: cookies:read

Alle aufgeführten Scopes sind erforderlich; admin erfüllt Scope-Prüfungen. Anfrageinhalt, Tresorzustand und Ressourcenrechte können zusätzliche Voraussetzungen setzen.

Keine Pfad- oder Query-Parameter deklariert.

Anfragekörper · erforderlich
OpenAPI JSON
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "ids"
        ],
        "properties": {
          "ids": {
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1,
              "maxLength": 64
            },
            "minItems": 1,
            "maxItems": 100
          },
          "format": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "json"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "netscape"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "header"
                ]
              }
            ]
          }
        },
        "additionalProperties": false
      }
    }
  }
}
Dokumentierte Antworten
OpenAPI JSON
{
  "200": {
    "description": "Default Response",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "file_name",
            "content_base64",
            "results"
          ],
          "properties": {
            "file_name": {
              "type": "string"
            },
            "content_base64": {
              "type": "string"
            },
            "results": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "id",
                  "no",
                  "count",
                  "error"
                ],
                "properties": {
                  "id": {
                    "type": "string"
                  },
                  "no": {
                    "type": [
                      "null",
                      "integer"
                    ]
                  },
                  "count": {
                    "type": [
                      "null",
                      "integer"
                    ]
                  },
                  "error": {
                    "type": [
                      "null",
                      "string"
                    ]
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "default": {
    "description": "HTTP error envelope. The status and error.code identify the failure.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}
Vollständige Operationsdefinition
OpenAPI JSON
{
  "summary": "Cookies mehrerer Profile lesen (höchstens 100) und als ZIP mit einer Datei je Profil zurückgeben",
  "tags": [
    "Cookies"
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "ids"
          ],
          "properties": {
            "ids": {
              "type": "array",
              "items": {
                "type": "string",
                "minLength": 1,
                "maxLength": 64
              },
              "minItems": 1,
              "maxItems": 100
            },
            "format": {
              "anyOf": [
                {
                  "type": "string",
                  "enum": [
                    "json"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "netscape"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "header"
                  ]
                }
              ]
            }
          },
          "additionalProperties": false
        }
      }
    }
  },
  "x-required-scopes": [
    "cookies:read"
  ],
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "file_name",
              "content_base64",
              "results"
            ],
            "properties": {
              "file_name": {
                "type": "string"
              },
              "content_base64": {
                "type": "string"
              },
              "results": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": [
                    "id",
                    "no",
                    "count",
                    "error"
                  ],
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "no": {
                      "type": [
                        "null",
                        "integer"
                      ]
                    },
                    "count": {
                      "type": [
                        "null",
                        "integer"
                      ]
                    },
                    "error": {
                      "type": [
                        "null",
                        "string"
                      ]
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}

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

Ausgewählte Cookies einschließlich vorgemerkter Kopien löschen

Authentifizierung: Bearer-Token

Erforderliche Routen-Scopes: cookies:write

Alle aufgeführten Scopes sind erforderlich; admin erfüllt Scope-Prüfungen. Anfrageinhalt, Tresorzustand und Ressourcenrechte können zusätzliche Voraussetzungen setzen.

NameOrtPflichtBeschreibung
idpathJa
Vollständige Parameterschemas
OpenAPI JSON
[
  {
    "schema": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "in": "path",
    "name": "id",
    "required": true
  }
]
Anfragekörper · erforderlich
OpenAPI JSON
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "cookies"
        ],
        "properties": {
          "cookies": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "name",
                "value",
                "domain",
                "host_only",
                "path",
                "expires",
                "http_only",
                "secure",
                "same_site",
                "session",
                "partition_key",
                "priority",
                "source_scheme",
                "source_port",
                "creation",
                "last_access"
              ],
              "properties": {
                "firefox": {
                  "type": "object",
                  "required": [
                    "partition_key",
                    "partitioned",
                    "user_context_id"
                  ],
                  "properties": {
                    "partition_key": {
                      "type": "string"
                    },
                    "partitioned": {
                      "type": "boolean"
                    },
                    "user_context_id": {
                      "type": "integer"
                    }
                  }
                },
                "name": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                },
                "domain": {
                  "type": "string"
                },
                "host_only": {
                  "type": "boolean"
                },
                "path": {
                  "type": "string"
                },
                "expires": {
                  "type": [
                    "null",
                    "number"
                  ]
                },
                "http_only": {
                  "type": "boolean"
                },
                "secure": {
                  "type": "boolean"
                },
                "same_site": {
                  "type": "string"
                },
                "session": {
                  "type": "boolean"
                },
                "partition_key": {
                  "anyOf": [
                    {
                      "type": "object",
                      "required": [
                        "top_level_site",
                        "has_cross_site_ancestor"
                      ],
                      "properties": {
                        "top_level_site": {
                          "type": "string"
                        },
                        "has_cross_site_ancestor": {
                          "type": "boolean"
                        }
                      }
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "priority": {
                  "type": [
                    "null",
                    "string"
                  ]
                },
                "source_scheme": {
                  "type": [
                    "null",
                    "string"
                  ]
                },
                "source_port": {
                  "type": [
                    "null",
                    "integer"
                  ]
                },
                "creation": {
                  "type": [
                    "null",
                    "number"
                  ]
                },
                "last_access": {
                  "type": [
                    "null",
                    "number"
                  ]
                }
              }
            },
            "minItems": 1,
            "maxItems": 20000
          }
        },
        "additionalProperties": false
      }
    }
  }
}
Dokumentierte Antworten
OpenAPI JSON
{
  "200": {
    "description": "Default Response",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "removed"
          ],
          "properties": {
            "removed": {
              "type": "integer"
            }
          }
        }
      }
    }
  },
  "default": {
    "description": "HTTP error envelope. The status and error.code identify the failure.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}
Vollständige Operationsdefinition
OpenAPI JSON
{
  "summary": "Ausgewählte Cookies einschließlich vorgemerkter Kopien löschen",
  "tags": [
    "Cookies"
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "cookies"
          ],
          "properties": {
            "cookies": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "name",
                  "value",
                  "domain",
                  "host_only",
                  "path",
                  "expires",
                  "http_only",
                  "secure",
                  "same_site",
                  "session",
                  "partition_key",
                  "priority",
                  "source_scheme",
                  "source_port",
                  "creation",
                  "last_access"
                ],
                "properties": {
                  "firefox": {
                    "type": "object",
                    "required": [
                      "partition_key",
                      "partitioned",
                      "user_context_id"
                    ],
                    "properties": {
                      "partition_key": {
                        "type": "string"
                      },
                      "partitioned": {
                        "type": "boolean"
                      },
                      "user_context_id": {
                        "type": "integer"
                      }
                    }
                  },
                  "name": {
                    "type": "string"
                  },
                  "value": {
                    "type": "string"
                  },
                  "domain": {
                    "type": "string"
                  },
                  "host_only": {
                    "type": "boolean"
                  },
                  "path": {
                    "type": "string"
                  },
                  "expires": {
                    "type": [
                      "null",
                      "number"
                    ]
                  },
                  "http_only": {
                    "type": "boolean"
                  },
                  "secure": {
                    "type": "boolean"
                  },
                  "same_site": {
                    "type": "string"
                  },
                  "session": {
                    "type": "boolean"
                  },
                  "partition_key": {
                    "anyOf": [
                      {
                        "type": "object",
                        "required": [
                          "top_level_site",
                          "has_cross_site_ancestor"
                        ],
                        "properties": {
                          "top_level_site": {
                            "type": "string"
                          },
                          "has_cross_site_ancestor": {
                            "type": "boolean"
                          }
                        }
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "priority": {
                    "type": [
                      "null",
                      "string"
                    ]
                  },
                  "source_scheme": {
                    "type": [
                      "null",
                      "string"
                    ]
                  },
                  "source_port": {
                    "type": [
                      "null",
                      "integer"
                    ]
                  },
                  "creation": {
                    "type": [
                      "null",
                      "number"
                    ]
                  },
                  "last_access": {
                    "type": [
                      "null",
                      "number"
                    ]
                  }
                }
              },
              "minItems": 1,
              "maxItems": 20000
            }
          },
          "additionalProperties": false
        }
      }
    }
  },
  "parameters": [
    {
      "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": [
              "removed"
            ],
            "properties": {
              "removed": {
                "type": "integer"
              }
            }
          }
        }
      }
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}

POST /api/v1/cookies/convert

Cookie-Formate umwandeln und prüfen, ohne ein Profil zu ändern

Authentifizierung: Bearer-Token

Erforderliche Routen-Scopes: cookies:read

Alle aufgeführten Scopes sind erforderlich; admin erfüllt Scope-Prüfungen. Anfrageinhalt, Tresorzustand und Ressourcenrechte können zusätzliche Voraussetzungen setzen.

Keine Pfad- oder Query-Parameter deklariert.

Anfragekörper · erforderlich
OpenAPI JSON
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "cookies",
          "to"
        ],
        "properties": {
          "cookies": {
            "description": "Cookies als Text (JSON, Netscape, Name=Wert, Base64) oder als JSON-Array"
          },
          "from": {
            "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"
                ]
              }
            ]
          },
          "to": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "json"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "netscape"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "header"
                ]
              }
            ]
          },
          "domain": {
            "type": "string",
            "minLength": 1,
            "maxLength": 253
          },
          "skip_expired": {
            "type": "boolean"
          }
        },
        "additionalProperties": false
      }
    }
  }
}
Dokumentierte Antworten
OpenAPI JSON
{
  "200": {
    "description": "Default Response",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "detected",
            "encoding",
            "count",
            "expired",
            "errors",
            "output"
          ],
          "properties": {
            "detected": {
              "type": "string"
            },
            "encoding": {
              "type": "string"
            },
            "count": {
              "type": "integer"
            },
            "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"
                  }
                }
              }
            },
            "output": {
              "type": "string"
            }
          }
        }
      }
    }
  },
  "default": {
    "description": "HTTP error envelope. The status and error.code identify the failure.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}
Vollständige Operationsdefinition
OpenAPI JSON
{
  "summary": "Cookie-Formate umwandeln und prüfen, ohne ein Profil zu ändern",
  "tags": [
    "Cookies"
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "cookies",
            "to"
          ],
          "properties": {
            "cookies": {
              "description": "Cookies als Text (JSON, Netscape, Name=Wert, Base64) oder als JSON-Array"
            },
            "from": {
              "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"
                  ]
                }
              ]
            },
            "to": {
              "anyOf": [
                {
                  "type": "string",
                  "enum": [
                    "json"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "netscape"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "header"
                  ]
                }
              ]
            },
            "domain": {
              "type": "string",
              "minLength": 1,
              "maxLength": 253
            },
            "skip_expired": {
              "type": "boolean"
            }
          },
          "additionalProperties": false
        }
      }
    }
  },
  "x-required-scopes": [
    "cookies:read"
  ],
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "detected",
              "encoding",
              "count",
              "expired",
              "errors",
              "output"
            ],
            "properties": {
              "detected": {
                "type": "string"
              },
              "encoding": {
                "type": "string"
              },
              "count": {
                "type": "integer"
              },
              "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"
                    }
                  }
                }
              },
              "output": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}

Native API-Referenz