> ## Documentation Index > Fetch the complete documentation index at: https://www.vitalog.dev/llms.txt > Use this file to discover all available pages before exploring further. # Archive goal > Archive a goal from today with an expected version. Preserve history and previous-day progress. Reactivate with health_set_goal. ## OpenAPI ````yaml /openapi.json post /v1/goals/{id}/archive openapi: 3.1.1 info: title: Vitalog version: 1.0.1 description: >- Single-user structured observations with equivalent REST and MCP domain services. Environment AUTH_KEY or revocable personal Bearer keys with required name, permissions and explicit expiry (including Never); Primary key management requires AUTH_KEY; the UI uses separate, root-verified 30-minute management sessions. MCP clients use OAuth authorization code with S256 PKCE, issued after root sign-in. Clients are resolved through HTTPS metadata, pre-registration or dynamic registration. OAuth tokens grant MCP access only. servers: - url: https://vitalog-api.example.com description: Production REST and MCP API - url: http://localhost:3000 description: Loopback development; production requires TLS ingress security: [] paths: /v1/goals/{id}/archive: post: tags: - Goals summary: Archive goal description: >- Archive a goal from today with an expected version. Preserve history and previous-day progress. Reactivate with health_set_goal. operationId: health_archive_goal parameters: - name: id in: path required: true schema: $schema: https://json-schema.org/draft/2020-12/schema type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ - name: Idempotency-Key in: header required: true schema: type: string minLength: 1 maxLength: 128 pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]*$ requestBody: required: true content: application/json: schema: $schema: https://json-schema.org/draft/2020-12/schema type: object properties: expected_version: type: integer exclusiveMinimum: 0 maximum: 2147483647 required: - expected_version additionalProperties: false responses: '200': description: Committed mutation or durable idempotent replay content: application/json: schema: $schema: https://json-schema.org/draft/2020-12/schema type: object properties: catalog_version: type: string const: 1.0.4 goal: type: object properties: id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ metric: type: string enum: - measurement:weight - nutrient:energy_kcal - nutrient:protein_g - nutrient:carbohydrate_g - nutrient:fat_g - nutrient:fiber_g - hydration:water_ml - activity:active_energy_kcal - activity:exercise_minutes version: $ref: '#/components/schemas/Schema_eaebb3e47dc2___schema0' period: type: string enum: - daily - ongoing direction: type: string enum: - maximum - minimum - target target: $ref: '#/components/schemas/Schema_eaebb3e47dc2___schema1' unit: type: string minLength: 1 maxLength: 20 baseline: anyOf: - $ref: '#/components/schemas/Schema_eaebb3e47dc2___schema1' - type: 'null' status: type: string enum: - active - archived effective_on: type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ created_at: $ref: '#/components/schemas/Schema_eaebb3e47dc2___schema2' updated_at: $ref: '#/components/schemas/Schema_eaebb3e47dc2___schema2' required: - id - metric - version - period - direction - target - unit - baseline - status - effective_on - created_at - updated_at additionalProperties: false committed_version: $ref: '#/components/schemas/Schema_eaebb3e47dc2___schema0' idempotent_replay: type: boolean required: - catalog_version - goal - committed_version - idempotent_replay additionalProperties: false '401': description: UNAUTHORIZED content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: FORBIDDEN content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: NOT_FOUND content: application/json: schema: $ref: '#/components/schemas/Error' '408': description: TIMEOUT content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: >- VERSION_CONFLICT, IDEMPOTENCY_CONFLICT, DAILY_TOTAL_EXISTS, CATALOG_VERSION_MISMATCH content: application/json: schema: $ref: '#/components/schemas/Error' '413': description: LIMIT_EXCEEDED content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: VALIDATION_ERROR content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: RATE_LIMITED content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: INTERNAL_ERROR content: application/json: schema: $ref: '#/components/schemas/Error' '503': description: UNAVAILABLE content: application/json: schema: $ref: '#/components/schemas/Error' security: - staticKey: [] - apiKey: [] components: schemas: Schema_eaebb3e47dc2___schema0: type: integer exclusiveMinimum: 0 maximum: 2147483647 Schema_eaebb3e47dc2___schema1: type: number exclusiveMinimum: 0 maximum: 1000000000000 Schema_eaebb3e47dc2___schema2: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ Error: type: object additionalProperties: false required: - code - message - catalog_version - issues properties: code: type: string enum: - VALIDATION_ERROR - NOT_FOUND - VERSION_CONFLICT - IDEMPOTENCY_CONFLICT - DAILY_TOTAL_EXISTS - CATALOG_VERSION_MISMATCH - LIMIT_EXCEEDED - UNAUTHORIZED - FORBIDDEN - RATE_LIMITED - UNAVAILABLE - TIMEOUT - INTERNAL_ERROR message: type: string catalog_version: type: string issues: type: array items: type: object properties: path: type: string reason: type: string message: type: string suggested_keys: type: array items: type: string discovery: type: object existing_id: type: string current_version: type: integer current_catalog_version: type: string securitySchemes: staticKey: type: http scheme: bearer description: >- Environment AUTH_KEY. Full ledger access and primary API-key administration. Not OAuth or JWT. apiKey: type: http scheme: bearer description: >- Generated opaque vlk_ key with a required name, explicit read/edit permissions, optional administrative inspection and chosen expiry (including Never). Enforces the same ceiling on REST and MCP; cannot administer credentials or account settings. Not OAuth or JWT. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.