Arguments - Fluid Topics - Latest

Fluid Topics Publisher (ftpub)

Category
Technical Notes
Audience
public
Version
Latest
ftpub remove [ft_portal_URL] [flags]

Aliases:

  • remove
  • unpublish
  • rm
  • delete

Flags:

  • -a, --api-key

    API key for the Fluid Topics portal (environment variable: FTPUB_API_KEY).

  • -u, --user

    Username for the Fluid Topics portal (environment variable: FTPUB_USER).

  • -p, --password

    Password for the Fluid Topics portal (environment variable: FTPUB_PASSWD).

  • --do-it

    Displays a message to confirm the removal of the targeted documents (environment variable: FTPUB_DO_IT).

  • -h, --help

    Shows the help tool.

  • --select

    Deletes selected documents based on their metadata. This flag can be repeated.

    For example, the following command removes all documents with the metadata product=FluidTopics and version=3.1:

    ftpub --select product=FluidTopics --select version=3.1 https://my-ft-portal
    

Global flags:

  • -v, --verbosity

    Determines how much information ftpub shows as the command runs. Either CRITICAL, ERROR, WARNING, INFO or DEBUG (by default: INFO).

    ftpub cannot show the possible information, errors, and warnings which appear in the job report.