Skip to content
SYLVE

Create bootstrap

POST
/jail/bootstraps
curl --request POST \
  --url https://sylve.lan:8181/api/jail/bootstraps \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "major": 1, "minor": 1, "pool": "example", "type": "example" }'

Queue a pkgbase bootstrap for a pool, version, and type, or return the existing completed member without starting duplicate work

Authorizations

Section titled “Authorizations”

Request Body

Section titled “Request Body”

Bootstrap Request

Media typeapplication/json
object
major
required
integer
minor
integer
pool
required
string
type
required
string
Examplegenerated
{
  "major": 1,
  "minor": 1,
  "pool": "example",
  "type": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Already Completed

Media typeapplication/json
object
data
object
name
string
outcome
string
pool
string
status
string
error
string
message
string
status
string
Examplegenerated
{
  "data": {
    "name": "example",
    "outcome": "example",
    "pool": "example",
    "status": "example"
  },
  "error": "example",
  "message": "example",
  "status": "example"
}

Headers

Section titled “Headers”
Location
string

/api/jail/bootstraps/{name}?pool={pool}

202

Section titled “202”

Accepted

Media typeapplication/json
object
data
object
name
string
outcome
string
pool
string
status
string
error
string
message
string
status
string
Examplegenerated
{
  "data": {
    "name": "example",
    "outcome": "example",
    "pool": "example",
    "status": "example"
  },
  "error": "example",
  "message": "example",
  "status": "example"
}

Headers

Section titled “Headers”
Location
string

/api/jail/bootstraps/{name}?pool={pool}

400

Section titled “400”

Bad Request

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

404

Section titled “404”

Not Found

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

409

Section titled “409”

Conflict

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

413

Section titled “413”

Request Entity Too Large

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

500

Section titled “500”

Internal Server Error

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

503

Section titled “503”

Service Unavailable

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}