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:

Long option Short option Mandatory? Description Environment variable
--api-key -a Yes (use either --api-key, or --user and --password) API key for the Fluid Topics portal. FTPUB_API_KEY
--user -u Yes (use either --api-key, or --user and --password) Username for the Fluid Topics portal. FTPUB_USER
--password -p Yes (use either --api-key, or --user and --password) Password for the Fluid Topics portal. FTPUB_PASSWD
--do-it No Confirms and performs the deletion. Without this flag, ftpub lists the documents that would be deleted without actually deleting them. FTPUB_DO_IT
--help -h No Shows the help tool.
--select No 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.com
Without this flag, ftpub targets all documents on the portal. Use with caution!

Global flags:

Long option Short option Mandatory? Description
--verbosity -v No Determines how much information ftpub shows as the command runs.

Options:

  • CRITICAL
  • ERROR
  • WARNING
  • INFO
  • DEBUG

By default: INFO.

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