Deleting a file

  1. Start the Python shell and configure its session.

    The following variables should be available now:

    >>> base_url  # the base URL of the API
    'https://eu2-cloud.acronis.com/api/notary/v2'
    >>> auth  # the 'Authorization' header value with the access token
    {'Authorization': 'Bearer 8770b34b74f9e4d9424eff50c38182bb4ae7f5596582ae61900b1b6a23e3ec58'}
    
  2. Define a variable named file_id, and then assign the ID of the required file to this variable:

    >>> file_id = 'cc3ecc8d-de0e-4809-8bc2-3a6368110824'
    
  3. Fetch the file information, and then save the notarization certificate ID stored in the certificate_id key of the fetched object as described in “Fetching the information about a file”. You will always be able to fetch this certificate by sending the GET request to the /certificates/{certificate_id} endpoint or to access the certificate web page at: https://eu2-cloud.acronis.com/notary/certificate/{certificate_id}

  4. Delete the file by sending a DELETE request to the /stored-files/{file_id} endpoint:

    >>> response = requests.delete(f'{base_url}/stored-files/{file_id}', headers=auth)
    
  5. Check the status code of the response:

    >>> response.status_code
    204
    

    Status code 204 means that the notary service has deleted the file from the storage and decreased the usage of the Notary storage quota. If the file was signed or was being signed, its e-sign document and the PDF file of the certificate have been also deleted. If the status code is 404, there is no file with such an ID in the storage. You may have incorrectly specified the ID or the file has already been deleted.

    A different status code means that an error has occurred. For the details, refer to “Status and error codes”.

Full code example

 1#!/usr/bin/env python3
 2
 3import requests  # Will be used for sending requests to the API.
 4import hashlib   # Will be used for calculating hash values.
 5import os.path   # Will be used for path-related operations.
 6import pprint    # Will be used for formatting the output of JSON objects received in API responses.
 7import json      # Will be used for converting dictionaries into JSON text
 8
 9# Define variables named "LOGIN" and "PASSWORD" and then assign them with your account credentials
10LOGIN = '<your login>'        # Change login here
11PASSWORD = '<your password>'  # Change password here
12
13# Define a variable named "cloud_url" and then assign it with the URL of the cloud platform
14cloud_url = 'https://cloud.acronis.com'
15
16# Fetch the URL of the data center where your account is located by sending a GET request to the "/api/1/accounts" endpoint
17response = requests.get(
18    f'{cloud_url}/api/1/accounts',
19    params={'login': LOGIN}
20)
21response.raise_for_status()
22
23# Convert the JSON text that the response body contains to a dictionary and store the data center URL
24# in a variable that will be used in further requests
25server_url = response.json()['server_url']
26
27# Define a variable named "account_creds", and then assign the username and password to this variable
28account_creds = {
29    'username': LOGIN,
30    'password': PASSWORD
31}
32
33# Generate a token by sending a POST request to the "/api/2/idp/token" with your account credentials to the cloud platform
34response = requests.post(
35    f'{server_url}/api/2/idp/token',
36    headers={'Content-Type': 'application/x-www-form-urlencoded'},
37    data={'grant_type': 'password', **account_creds}
38)
39response.raise_for_status()
40
41# Convert the JSON text that the response body contains to a dictionary and then assign it to a variable named "token_info"
42token_info = response.json()
43
44# Define a variable named "auth" and then assign it with a dictionary with "Authorization" key containing
45# token string formatted as "Bearer <access_token>"
46auth = {
47    'Authorization': 'Bearer ' + token_info['access_token']
48}
49
50# Define a variable named "base_url", and then assign the API base URL using the data center URL
51# to this variable
52base_url = f'{server_url}/api/notary/v2'
53
54# Define a variable named "file_id" and then assign it with the ID of the file
55file_id = 'cc3ecc8d-de0e-4809-8bc2-3a6368110824'
56
57# Delete the file by sending a DELETE request to the "/stored-files/{file_id}" endpoint
58response = requests.delete(f'{base_url}/stored-files/{file_id}', headers=auth)
59response.raise_for_status()