PRpremai-io
Files Encrypted
dev-api

Delete index of encrypted files

Changed on

Remove encrypted files from the retrieval index. The files themselves are kept.

post/files/encrypted/delete-index

Request

  • Base URL
    https://gateway.prem.io
  • Auth
    HTTP bearer and API key in header Authorization

Request body

cipher_textstring required

Cipher text for encryption context

encrypted_rag_dekstring required

Encrypted RAG data encryption key

rag_dek_noncestring required

Nonce used for RAG DEK encryption

fileIdsstring[] required

Array of file IDs to delete from index

Example request

{
  "cipher_text": "cipher_text_data",
  "encrypted_rag_dek": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
  "rag_dek_nonce": "0123456789abcdef0123456789abcdef",
  "fileIds": [
    "file_0198042e-6dde-7b9c-bc91-452a7e0c833b"
  ]
}

Response

File indexes deleted successfully

status200 | 201 | 202 required

Status code of the response

errorstring nullable

Error message of the response, human readable

messagestring nullable required

Message of the response, human readable

env'development' | 'production' required

API environment

support_idstring uuid nullable

Support ID linked to the response, used to identify it when talking with our team.

Example response

{
  "data": {
    "results": [
      {
        "file_id": "file_0198042e-6dde-7b9c-bc91-452a7e0c833b",
        "success": true
      },
      {
        "file_id": "file_0198042e-6dde-7b9c-bc91-452a7e0c833c",
        "success": true
      }
    ],
    "async_task_id": "task_0198042e-6dde-7b9c-bc91-452a7e0c833d"
  }
}

Changes

  • d46bc3931b34Revision changes
    • warning

      added the new 405.00 enum value to the / response property for the response status

    • warning

      added the new 405.00 enum value to the / response property for the response status

    • warning

      added the new 405.00 enum value to the / response property for the response status

    • warning

      added the new 405.00 enum value to the response property for the response status

    • warning

      added the new 409.00 enum value to the / response property for the response status

    • warning

      added the new 409.00 enum value to the / response property for the response status

    • warning

      added the new 409.00 enum value to the / response property for the response status

    • warning

      added the new 409.00 enum value to the response property for the response status

    • warning

      added the new 500.00 enum value to the / response property for the response status

    • warning

      added the new 500.00 enum value to the / response property for the response status

    • warning

      added the new 500.00 enum value to the / response property for the response status

    • warning

      added the new 500.00 enum value to the response property for the response status

  • d5b1beb33be5Revision changes
    • info

      endpoint added