---
title: "Initialize jira sandbox with data"
method: POST
path: "/sandbox/jira/{sandbox_id}/initialize"
tags: ["sandbox"]
---

# Initialize jira sandbox with data

`POST /sandbox/jira/{sandbox_id}/initialize`

Initialize the sandbox with jira-specific data following the defined schema.

## Path parameters

- `sandbox_id` string, required — The unique sandbox identifier

## Query parameters

- `init_default_data` boolean — If true, use default test data for initialization

## Request body

- JiraDataInput — Complete Jira sandbox data structure. Relational structure for initialization: - Projects contain Issues - Boards refer to Projects (via key) - Sprints refer to Boards (via name) - Issues can refer to Sprints (via name)
  - `projects` JiraProjectInput[] — List of projects with their issues
    - `key` string, required — Project key (e.g., PROJ)
    - `name` string, required — Project name
    - `description` string, nullable — Project description
    - `project_type` string — Project type (software, business, etc.)
    - `issues` JiraIssueInput[], nullable — Issues in this project
      - `summary` string, required — Issue summary/title
      - `description` string, nullable — Issue description
      - `issue_type` string — Issue type (Task, Bug, Story, etc.)
      - `priority` string, nullable — Issue priority (Highest, High, Medium, Low, Lowest)
      - `sprint_name` string, nullable — Name of the sprint this issue belongs to (for initialization)
      - `comments` JiraComment[], nullable — Comments on this issue
        - `body` string, required — Comment text content
  - `boards` JiraBoardInput[] — List of boards
    - `name` string, required — Board name
    - `type` string — Board type (scrum or kanban)
    - `project_key` string, nullable — Key of the project this board belongs to (for initialization)
    - `filter_jql` string, nullable — JQL for the board filter
  - `sprints` JiraSprintInput[] — List of sprints
    - `name` string, required — Sprint name
    - `start_date` string, nullable — Sprint start date (ISO 8601 format)
    - `end_date` string, nullable — Sprint end date (ISO 8601 format)
    - `origin_board_name` string, nullable — Name of the board this sprint belongs to (for initialization)
    - `goal` string, nullable — Sprint goal
    - `state` string, nullable — Sprint state (future, active, closed)

## Response `200`

Successful Response

- InitializeSandboxResponse — Response model for sandbox initialization
  - `sandbox_id` string, required — Sandbox identifier
  - `status` 'idle' | 'occupied' | 'error', required — Status of a sandbox instance - matches database enum
  - `message` string, required — Initialization result message

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/klavis-ai/apis/klavis-ai-https-www-klavis-ai.md) · [All operations](https://skmtc.net/klavis-ai/apis/klavis-ai-https-www-klavis-ai/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/klavis-ai/klavis-ai-https-www-klavis-ai/revisions/1f05ced7280f/schema)