Write config changes to disk

POST

/api/v1/service-config/persist

curl --request POST \
  --url https://osctrl.net/api/v1/service-config/persist \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "service": "example" }'

Persists DB-edited config sections back to the service’s YAML file.

Authorizations

• ApiKeyAuth

Request Body

Request body

Media typeapplication/json

object

service

string

Example^generated

{
  "service": "example"
}

Responses

200

Written

Media typeapplication/json

object

command

object

action

string

command_id

string

consumed_at

string

consumed_by

string

created_at

string

expires_at

string

recovered_at

string

recovered_by

string

requested_by

string

requested_from

string

status

string

target_service

string

message

string

service

string

Example^generated

{
  "command": {
    "action": "example",
    "command_id": "example",
    "consumed_at": "example",
    "consumed_by": "example",
    "created_at": "example",
    "expires_at": "example",
    "recovered_at": "example",
    "recovered_by": "example",
    "requested_by": "example",
    "requested_from": "example",
    "status": "example",
    "target_service": "example"
  },
  "message": "example",
  "service": "example"
}

202

Write queued

Media typeapplication/json

object

command

object

action

string

command_id

string

consumed_at

string

consumed_by

string

created_at

string

expires_at

string

recovered_at

string

recovered_by

string

requested_by

string

requested_from

string

status

string

target_service

string

message

string

service

string

Example^generated

{
  "command": {
    "action": "example",
    "command_id": "example",
    "consumed_at": "example",
    "consumed_by": "example",
    "created_at": "example",
    "expires_at": "example",
    "recovered_at": "example",
    "recovered_by": "example",
    "requested_by": "example",
    "requested_from": "example",
    "status": "example",
    "target_service": "example"
  },
  "message": "example",
  "service": "example"
}

400

Bad request

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

401

Unauthorized

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

403

Forbidden

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

409

Config file not writable

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

500

Internal server error

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

503

Service unavailable

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}