You are in REST API » v15.1 || Go to



Configuration

Details

  • URL: /configuration/
  • Method: GET
  • Parameters: NONE
  • Output: List of all minerva configuration details.
  • Example:
    curl -X GET https://minerva-dev.lcsb.uni.lu/minerva/api/configuration/
    

Configurable options

List options

  • URL: /configuration/options/
  • Method: GET
  • Parameters: NONE
  • Output: List of all minerva configurable options.
  • Example:
    curl -X GET https://minerva-dev.lcsb.uni.lu/minerva/api/configuration/options/
    

Modify option

  • URL: /configuration/options/{option}
  • Method: PATCH
  • Parameters: json object representing option to be updated
  • Output: Modified option.
  • Example:
    curl -X PATCH --data '{"option":{"value":"0.79"}}' \
    --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" \
    https://minerva-dev.lcsb.uni.lu/minerva/api/configuration/options/OVERLAY_OPACITY
    

DAPI configuration

Details

  • URL: /configuration/dapi/
  • Method: GET
  • Parameters: NONE
  • Output: information about DAPI connection.
  • Example:
    curl -X GET https://minerva-dev.lcsb.uni.lu/minerva/api/configuration/dapi/
    

Register new user

  • URL: /configuration/dapi:registerUser
  • Method: POST
  • Parameters: NONE
  • Output: information about DAPI connection.
  • Example:
    curl -X POST --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" https://minerva-dev.lcsb.uni.lu/minerva/api/configuration/dapi:registerUser --data-binary '{"login":"test_user","password":"pass1234","email":"user@uni.lu"}'
    

List available databases

  • URL: /configuration/dapi/database/
  • Method: GET
  • Parameters: NONE
  • Output: list of all available databases in DAPI
  • Example:
    curl -X GET https://minerva-dev.lcsb.uni.lu/minerva/api/configuration/dapi/database/
    

List available database releases

  • URL: /configuration/dapi/database/{databaseName}/
  • Method: GET
  • Parameters:
    • databaseName - name of database
  • Output: list of all available releases for a given database
  • Example:
    curl -X GET https://minerva-dev.lcsb.uni.lu/minerva/api/configuration/dapi/database/CTD/release/
    

Accept database release license

  • URL: /configuration/dapi/database/{databaseName}/release/{releaseName}:acceptLicense
  • Method: POST
  • Parameters:
    • databaseName - name of database
    • releaseName - release name
  • Output: NONE
  • Example:
    curl -X POST --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" https://minerva-dev.lcsb.uni.lu/minerva/api/configuration/dapi/database/CTD/release/2019.02:acceptLicense
    


Back to top