Update settings

PUT /settings

status: stable

Overwrite current settings.

application/json

Body Required

  • settings object

    Settings

    Hide settings attribute Show settings attribute object
    • pool_metadata_source string Required

      Select stake pool metadata fetching strategy:

      • none - metadata is not fetched at all,
      • direct - metadata is fetched directly URLs registered on chain,
      • uri - metadata is fetched from an external Stake-Pool Metadata Aggregation Server (SMASH)

      After update existing metadata will be dropped forcing it to re-sync automatically with the new setting.

      Format should match the following pattern: ^(none|direct|https?:\/\/[a-zA-Z0-9-_~.]+(:[0-9]+)?/?)$.

Responses

  • 415 application/json

    Unsupported Media Type

    Hide response attributes Show response attributes object
    • message string Required

      May occur when providing an invalid 'Content-Type' header.

    • code string Required

      Value is unsupported_media_type.

  • 400 application/json

    Bad Request

    Hide response attributes Show response attributes object
    • message string Required

      May occur when a request is not well-formed; that is, it fails to parse successfully. This could be the case when some required parameters are missing or, when malformed values are provided.

    • code string Required

      Value is bad_request.

  • No Content

PUT /settings
curl \
 --request PUT https://localhost:8090/v2/settings \
 --header "Content-Type: application/json" \
 --data '{"settings":{"pool_metadata_source":"https://smash.cardano-mainnet.iohk.io/"}}'
Request examples
{
  "settings": {
    "pool_metadata_source": "https://smash.cardano-mainnet.iohk.io/"
  }
}
Response examples (415)
{
  "message": "string",
  "code": "unsupported_media_type"
}
Response examples (400)
{
  "message": "string",
  "code": "bad_request"
}