Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Portrait allows you to configure a source with sourceType: 'api'. These sources can be manually managed through the API.

...

Info

The source name must be in lowercase (wrong: EM2008, correct; em2008)

Example:

Code Block
languageyaml
    - id: em2008
      sourceType: 'api'
      excludeKeysFromSuggestions: [ ]

Manage Entries

Info

The most up-to-date API Specification can always be found on your own instance, either via the openAPI specification or the UI! See API Documentation

...

Remove all entries from an API source

Status
colourRedPurple
titleDELETEPATCH
/api/sources/:sourceName

Code Block
languagebash
curl -X 'DELETEPATCH' \
  'http://localhost:8080/api/sources/em2008' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer yourToken' \
Note
Watch out

Attention! There will be no

there will be no

confirmation for the request.
All data from that source will be gone and can’t be

reindex

reindexed!