Published Retrievers

Unpublish Retriever

Changed on

Unpublish a retriever.

Removes the public API endpoint and deletes the short URL redirect. The public API key will immediately stop working. This action cannot be undone (you'll need to republish to get a new API key).

delete/v1/retrievers/{retriever_id}/publish

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/retrievers/{retriever_id}/publish
  • Auth: HTTP bearer and API key in header X-Namespace

Path parameters

retriever_idstring required

ID of the retriever to unpublish

Response

Successful Response

messagestring
successboolean

Changes

    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      the endpoint scheme security BearerAuth AND NamespaceHeader was added to the API