settings

Get settings

Fetches the complete application settings.

Request

get
/settings

Response

{
  "example": {
    "default_source_types": [
      "isolate",
      "strain"
    ],
    "enable_api": true,
    "enable_sentry": true,
    "hmm_slug": "virtool/virtool-hmm",
    "minimum_passsword_length": 8,
    "sample_all_read": false,
    "sample_all_write": true,
    "sample_group": "force_choice",
    "sample_group_read": true,
    "sample_group_write": true,
    "sample_unique_names": true
  },
  "status": "200"
}

Update settings

Updates the application settings.

Parameters

Name Type Required Description
default_source_types array false
enable_api boolean false
enable_sentry boolean false
hmm_slug string false
minimum_password_length integer false
sample_all_read boolean false
sample_all_write boolean false
sample_group string false
sample_group_read boolean false
sample_group_write boolean false

Errors

StatusDescription
403 Not permitted

Request

patch
/settings

Response

{
  "example": {
    "default_source_types": [
      "isolate",
      "strain"
    ],
    "enable_api": true,
    "enable_sentry": true,
    "hmm_slug": "virtool/virtool-hmm",
    "minimum_passsword_length": 8,
    "sample_all_read": false,
    "sample_all_write": true,
    "sample_group": "force_choice",
    "sample_group_read": true,
    "sample_group_write": true,
    "sample_unique_names": true
  },
  "status": "200"
}