Account Management API
Guide Reference
Search Press ESC to dismiss
  • Introduction
  • Changelog
  • Overview
    • API location
    • Authentication
    • Requests and responses
    • Status and error codes
  • Getting started
    • Setting up the Python environment
    • Starting the Python shell and configuring its session
    • Authenticating to the platform
    • Enabling the backup service for a user in a customer tenant
  • Tutorials
    • Provisioning a partner tenant
    • Provisioning a customer tenant
    • Switching tenant to production
    • Creating a billing report
    • Changing quotas
    • Changing storage quotas of partner sub-tenants
    • Suspension / Reactivation / Termination
  • Managing tenants
    • Creating a tenant
    • Fetching information about an individual tenant
    • Fetching information about tenants
    • Fetching information about child tenants
    • Fetching the production start date of a tenant
    • Switching a customer tenant to production mode
    • Modifying tenant properties
    • Moving a tenant to another tenant
    • Limiting access to a tenant for higher-level administrators
    • Disabling a tenant
    • Deleting a tenant
  • Managing services
    • Fetching information about all platform services
    • Fetching information about services enabled for a tenant
    • Fetching information about an individual service
    • Enabling a service for a sub-tenant
    • Disabling a service for a sub-tenant
  • Managing offering items and quotas
    • Fetching available offering items
    • Switching the edition of a service
    • Changing quotas
    • Enabling/disabling an offering item
  • Managing branding options
    • Enabling branding for a tenant
    • Disabling branding for a tenant
    • Fetching branding options of a tenant
    • Updating branding options for a tenant
    • Configuring the “Buy URL” option
    • Updating brand’s logo
  • Managing user accounts
    • Creating a user account
    • Activating a user account
      • Sending activation email
      • Activation by setting a password
      • Checking activation status
    • Managing user account roles
      • Checking current roles of a user account
      • Modifying the roles of a user account
    • Fetching a user account information
    • Changing a user account password
    • Changing a user account email
    • Changing a user account contact info
    • Disabling/enabling a user account
    • Deleting a user account
  • Managing locations and storages
    • Creating a location
    • Fetching locations
    • Updating a location
    • Deleting a location
    • Registering a storage
    • Fetching storages
    • Updating a storage
    • Moving a storage
    • Deleting a storage
  • Managing upsell
    • Enabling quota upsell for a user account
    • Enabling upsell of service editions for a sub-tenant
  • Managing billing settings
    • Setting the tier level and the licensing mode for a partner tenant
    • Switching the tier level of a partner tenant
    • Fetching the pricing information for a tenant
  • Searching for tenants and user accounts
    • Searching for a tenant by its name
    • Searching for a user account by its login
  • Usage and reporting
    • Fetching a service usage of a tenant
    • Managing reports
      • Creating a usage report
      • Fetching a usage report
      • Fetching a usage report from tenant reports
      • Updating a usage report
      • Disabling/enabling a usage report
      • Deleting a usage report
      • Fetching stored reports
      • Fetching a service usage using a stored report
      • Creating a billing report
  • Advanced operations
    • How to log in to service consoles on behalf of another user
      • Generating an external login URL
      • Logging in using a one-time token
    • Managing two-factor authentication
      • Checking status of two-factor authentication of a tenant
      • Toggling two-factor authentication for a tenant
      • Toggling two-factor authentication for a user account
  • Index
  • Legal
  • Privacy
Last updated on Jun 13, 2023. Copyright © Acronis International GmbH
2003-2023
  • Guide
  • Managing branding options
  • Updating brand’s logo

Updating brand’s logo

  1. Authenticate to the cloud platform via the Python shell.

    The following variables should be available now:

    >>> base_url  # the base URL of the API
    'https://eu2-cloud.acronis.com/api/2'
    >>> auth  # the 'Authorization' header value with the access token
    {'Authorization': 'Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6ImMwMD...'}
    >>> tenant_id  # the UUID of the tenant to which the token provides access
    'ede9f834-70b3-476c-83d9-736f9f8c7dae'
    
  2. Assign either of the following values to the tenant_id variable – the UUID of a sub-tenant created via the API or a sub-tenant found by its name:

    >>> tenant_id = created_tenant_id
    >>> tenant_id
    '0fcd4a69-8a40-4de8-b711-d9c83dc000f7'
    
  3. Obtain the number of the latest tenant revision. You will have to specify this number in a subsequent request to the tenant. This is required to manage concurrent tenant modifications.

    1. Fetch the tenant information as described in steps 3-5 of “Fetching information about an individual tenant”. As the result, you should have a tenant variable with the tenant object.

    2. Define a variable named tenant_version, and then assign the value of the version key from the tenant object to this variable:

      >>> tenant_version = tenant['version']
      >>> tenant_version
      3
      
  4. Define a variable named image_path, and then assign a path to the image to this variable:

    >>> image_path = '<path_to_image>'
    

    Important

    If the path contains backslashes, remember to escape them with an additional backslash.

  5. Define a variable named uploaded_file, and then assign an object with branding options to this variable:

    >>> uploaded_file = {
    ...     'file': open(image_path, 'rb')
    ... }
    
  6. Send a POST request to the /tenants/{tenant_id}/brand/logo endpoint:

    >>> response = requests.post(
    ...     f'{base_url}/tenants/{tenant_id}/brand/logo',
    ...     headers=auth,
    ...     files=uploaded_file,
    ... )
    
  7. Check the status code of the response:

    >>> response.status_code
    200
    

    Status code 200 means that the logo has been uploaded and changed. Version number of the tenant will be also increased by 1.

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

    Also, the response body contains the tenant information formatted as a JSON text. When converted to an object, it will look as follows:

    >>> pprint.pprint(response.json())
    {'ancestral_access': True,
     'brand_id': 3579,
     'brand_uuid": "14dc11ca-2b16-43bb-8ba4-2a3545c214a0',
     'contact': {'address1': '366 5th Ave',
                 'address2': None,
                 'city': None,
                 'country': None,
                 'email': 'foo.bar@example.com',
                 'firstname': '',
                 'lastname': '',
                 'phone': '1 123 4567890',
                 'state': None,
                 'zipcode': None},
     'customer_id': None,
     'customer_type': 'default',
     'default_idp_id': '11111111-1111-1111-1111-111111111111',
     'enabled': True,
     'has_children': False,
     'id': '0fcd4a69-8a40-4de8-b711-d9c83dc000f7',
     'internal_tag': 'some.unique.tag.value',
     'kind': 'customer',
     'language': 'en',
     'name': 'Foobar',
     'owner_id': None,
     'parent_id': 'ede9f834-70b3-476c-83d9-736f9f8c7dae',
     'update_lock': {'enabled': False, 'owner_id': None},
     'version': 1}
    
  8. [Optional] Increase the value of the the tenant_version variable by 1:

    >>> tenant_version = tenant_version + 1
    
Previous Next
  • Legal
  • Privacy
Last updated on Jun 13, 2023. Copyright © Acronis International GmbH
2003-2023
Back to top