---
agentTools:
  projectIndex: https://docs.archisnapper.com/llms.txt
---

# Archiving a project

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "API Settings",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://app3.archisnapper.com/api/public/v1"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/site/toggle_archived": {
      "put": {
        "summary": "Archiving a project",
        "description": "",
        "operationId": "archiving-a-project",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "auth_token",
                  "archive"
                ],
                "properties": {
                  "auth_token": {
                    "type": "string",
                    "description": "Your authentication token."
                  },
                  "id": {
                    "type": "string",
                    "description": "The project ID. Use this, or use unique_id, at leat one of both."
                  },
                  "unique_id": {
                    "type": "string",
                    "description": "Your internal unique ID. Use this, or use id, at leat one of both."
                  },
                  "client_internal_unique_id": {
                    "type": "string",
                    "description": "Your own id for the site. Use it instead of the ArchiSnapper id."
                  },
                  "archive": {
                    "type": "boolean",
                    "description": "true if you want to archive a project. false if you want to unarchive it."
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "63053e399807941f67a925c7:558a6e88dbe5b63700f8d201"
}
```