Update setting

PATCH

/api/v1/settings/{service}/{name}

curl --request PATCH \
  --url https://osctrl.net/api/v1/settings/example/example \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "boolean": true, "integer": 1, "string": "example", "type": "example" }'

Updates a mutable setting value.

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

service

required

string

Service name

name

required

string

Setting name

Request Body^required

Request body

Media typeapplication/json

object

boolean

boolean

integer

integer

string

string

type

string

Example^generated

{
  "boolean": true,
  "integer": 1,
  "string": "example",
  "type": "example"
}

Responses

200

OK

Media typeapplication/json

object

boolean

boolean

createdAt

string

deletedAt

object

time

string

valid

Valid is true if Time is not NULL

boolean

environmentID

integer

id

integer

info

string

integer

integer format: int64

name

string

service

string

string

string

type

string

updatedAt

string

Example^generated

{
  "boolean": true,
  "createdAt": "example",
  "deletedAt": {
    "time": "example",
    "valid": true
  },
  "environmentID": 1,
  "id": 1,
  "info": "example",
  "integer": 1,
  "name": "example",
  "service": "example",
  "string": "example",
  "type": "example",
  "updatedAt": "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"
}

404

Not found

Media typeapplication/json

object

code

string

error

string

Example^generated

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

409

Conflict

Media typeapplication/json

object

code

string

error

string

Example^generated

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

429

Too many requests

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"
}