API calling via Swagger

API calling via Swagger

  1. Go To the "Account Settings".


  2. Click the "CREATE" button to generate API keys, which will be downloaded in JSON format.


  3. The downloaded JSON will contain information such as customerId, API key, API Secret, Domain, DomainSuffix, and other relevant details, as shown below.


  4. Now, go to the Uptycs Swagger Docs page and enter the Domain and CustomerId from your API keys JSON data. Then, click the "Authorize" button.



  5. This requests API credentials. Please fill the input box with your APIkey#APISecret, then click "Authorize".


  6. If you have entered a valid API key and Secret, you will see the pop-up below, which can then be closed.

  7. Now that you have completed the authentication process, you can try any API endpoint in Swagger. To call a Swagger API, first choose an endpoint (in this case, I have chosen /Users), and then click the "Try it out" button.
    Preview

  8. Then, click the "Execute" button to call the API.
    Preview

  9. Now you can view the response of API call in the server response section



    • Related Articles

    • Create Custom Event Exclusion Profile via API

      It may be a lengthy process to create an event exclusion profile with many entries using the GUI. This article shows how to create two custom event exclusion profiles via the API. The urestapi tool is used (https://pypi.org/project/urestapi/).  ...

    • Uptycs Alert Triggers API Call

      This python module can be run to trigger Uptycs API calls from Uptycs alerts.  Example: An alert is configured to fire when asset location is not in USA (possible GDPR issue). This python can then be run to automatically make an API call to disable ...

    • Generate JWT Token using PowerShell CMDLETS

      With just PowerShell Cmdlets, you can generate a Bearer Auth Token using the following steps. # please install JWT module in PowerShell Install-Module JWT # cmdlet to generate JWT Token New-Jwt -Header '{"alg": "HS256", "typ": "JWT"}' -PayloadJson ...

    • Python helper module for Uptycs API

      The attached helper module (uptapi.py) and demo program (uptdemo.py) show how to access Uptycs API from Python 3. 

    • Provisioning roles using API

      Overview Starting with Uptycs portal release 46025, Uptycs provides entity level granular user permissions through roles. This document outlines the process to create roles using API - with examples. Procedure -- Create a new role $ urestapi -k ...