Quickstart for AVH REST API

This quickstart explains how to start using Arm Virtual Hardware REST API. It guides through the initial steps: logging in, setting the API Token, finding your project ID, and finally creating a device.

1. Log in to AVH https://app.avh.corellium.com.

2. If you don't have an API token, generate it as explained in the API Authentication Token article.

3. Next, go to the AVH API Docs https://app.avh.corellium.com/api/docs

4. Click on Log In on the menu.

   

5. Paste the API Token you generated into the example request replacing <token>, then click TRY.

   

6. You can now see your auth token in the response. Copy just the value of the token. We are going to use this in the HTTP Bearer.

   

7. Click Authentication in the menu.

   

8. Paste your auth token in the input and click SET

   

9. Click Get Projects

   

10. Click TRY to get your project's information. Copy the id from the JSON, you will need this to create the device.

    

11. In the menu click Create Instance

    

12. We are going to create a STM32U5 IoT Discovery Kit device and name it "STM32U5 created via API". Paste the object into the example replacing the sample object with your project id.

    {
       "project": "<your_project_id>",
       "name": "stm32u5 Created via API",
       "flavor": "stm32u5-b-u585i-iot02a",
       "description": "STM32U5 IoT Discovery Kit",
       "model": "stm32u5-b-u585i-iot02a",
       "os": "1.1.0"
    }

    Once you have added this click Try

    

    note

    You can find information about the models and the software for the models in the API Doc

13. The response will show that the device status is being created.

    

14. When you go back to your AVH devices list, your shall see the device we have just created in this quickstart guide.