Archive a cycle

POST/api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}/archive/

Move a completed cycle to archived status for historical tracking. Only cycles that have ended can be archived.

Path Parameters

cycle_id:requiredstring

Cycle id.

project_id:requiredstring

Project ID

slug:requiredstring

Workspace slug

Scopes

projects.cycles:write

Archive a cycle

curl -X POST \
  "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/cycles/550e8400-e29b-41d4-a716-446655440001/archive/" \
  -H "X-API-Key: $PLANE_API_KEY" \
  # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \

import requests

response = requests.post(
    "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/cycles/550e8400-e29b-41d4-a716-446655440001/archive/",
    headers={"X-API-Key": "your-api-key"}
)
print(response.status_code)

const response = await fetch(
  "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/cycles/550e8400-e29b-41d4-a716-446655440001/archive/",
  {
    method: "POST",
    headers: {
      "X-API-Key": "your-api-key",
    },
  }
);
console.log(response.status);

Response204

No response body.