Refresh the board catalog

POST

/api/sources/update

curl --request POST \
  --url http://127.0.0.1:8765/api/sources/update \
  --header 'Content-Type: application/json' \
  --data '{}'

Refresh the board catalog and index (“Update sources”). Reads public boards; incremental by default; returns immediately; poll GET /api/sources/update.

Request Body

Media typeapplication/json

object

force

Start even if another update looks live.

boolean

full_refresh

Check every board; by default boards checked recently are skipped.

boolean

Example

{}

Responses

200

Success.

Media typeapplication/json

object

key

additional properties

any

Example

{
  "state": "running"
}

403

Forbidden / forbidden_origin: loopback peer and Host 127.0.0.1:<port> or localhost:<port> only (Origin too on writes).

Media typeapplication/json

object

error

required

object

allowed_keys

Array<string>

code

required

string

message

required

string

key

additional properties

any

Example^generated

{
  "error": {
    "allowed_keys": [
      "example"
    ],
    "code": "example",
    "message": "example"
  }
}

415

Unsupported_media_type: writes need Content-Type: application/json.

Media typeapplication/json

object

error

required

object

allowed_keys

Array<string>

code

required

string

message

required

string

key

additional properties

any

Example^generated

{
  "error": {
    "allowed_keys": [
      "example"
    ],
    "code": "example",
    "message": "example"
  }
}

422

Unknown_key, wrong_type

Media typeapplication/json

object

error

required

object

allowed_keys

Array<string>

code

required

string

message

required

string

key

additional properties

any

Example

{
  "error": {
    "code": "unknown_key",
    "message": "..."
  }
}