Replace jail lifecycle hooks

PUT

/jail/{ctid}/options/lifecycle-hooks

curl --request PUT \
  --url https://sylve.lan:8181/api/jail/1/options/lifecycle-hooks \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "hooks": { "poststart": { "enabled": true, "script": "example" }, "poststop": { "enabled": true, "script": "example" }, "prestart": { "enabled": true, "script": "example" }, "prestop": { "enabled": true, "script": "example" }, "start": { "enabled": true, "script": "example" }, "stop": { "enabled": true, "script": "example" } } }'

Replace all six jail exec.* lifecycle-hook phases; every phase, enabled flag, and script must be supplied, and disabled empty scripts explicitly clear a phase

Authorizations

• BearerAuth

Parameters

Path Parameters

ctid

required

integer

>= 1

Jail CTID

Request Body

Lifecycle hooks

Media typeapplication/json

object

hooks

required

object

poststart

required

object

enabled

required

boolean

script

required

string

poststop

required

object

enabled

required

boolean

script

required

string

prestart

required

object

enabled

required

boolean

script

required

string

prestop

required

object

enabled

required

boolean

script

required

string

start

required

object

enabled

required

boolean

script

required

string

stop

required

object

enabled

required

boolean

script

required

string

Example^generated

{
  "hooks": {
    "poststart": {
      "enabled": true,
      "script": "example"
    },
    "poststop": {
      "enabled": true,
      "script": "example"
    },
    "prestart": {
      "enabled": true,
      "script": "example"
    },
    "prestop": {
      "enabled": true,
      "script": "example"
    },
    "start": {
      "enabled": true,
      "script": "example"
    },
    "stop": {
      "enabled": true,
      "script": "example"
    }
  }
}

Responses

200

Success

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

400

Bad Request

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

401

Unauthorized

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

403

Forbidden

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

404

Not Found

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

409

Conflict

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

413

Request Entity Too Large

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

500

Internal Server Error

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}