Skip to main content
POST
Initialize jira sandbox with data

Authorizations

Authorization
string
header
required

Your Klavis AI API key.

Path Parameters

sandbox_id
string
required

The unique sandbox identifier

Query Parameters

init_default_data
boolean
default:false

If true, use default test data for initialization

Body

application/json

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
JiraProject · object[]

List of projects with their issues

boards
JiraBoard · object[]

List of boards

sprints
JiraSprint · object[]

List of sprints

Response

Successful Response

Response model for sandbox initialization

sandbox_id
string
required

Sandbox identifier

status
enum<string>
required

Current status

Available options:
idle,
occupied,
error
message
string
required

Initialization result message