This page will explain you how to generate an API Token and how you can use it to authenticate against our API. To get more information about our API please visit the Developers Genesis Cloud page.


What is an API Token?


API tokens are unique identifiers associated with your Genesis Cloud account and consist of an ID and a Secret Token. The Secret Token is required to authenticate against our API and will only be displayed when you create the token.


Please Note: For security reasons, the secret token is only shown once. Please copy it and store it securely.


Before you can start using our API, you need to generate a Security Token and ID pair. Consider the token as a combination of user credentials and a password. The ID is an unique identifier as user given token names or descriptions might be changed. 


The ID:

  • An ID can uniquely identify a token
  • It’s not a sensitive piece of information.
  • It allows you to identify a specific token if you need to revoke it.

The Token

  • The Secret Token is the value that can be used to authenticate against the API (the value used in X-Auth-Token HTTP-header).
  • The Secret Token must stay secret and not given to anyone or publish online.


Please Note: The API Token has the same power as your username and password. If someone else sees your Token they can gain full access over your resources. Treat the Token like your password. Immediately revoke a token if someone else might have seen it. 


Please Note: Resources created via the API are subject to the same pricing and costs as a resource created via the web dashboard. You can always find all your billed resources in the Billing Dashboard.


How to generate an API Token?


1- Open the menu on your account dashboard and click on Key and Tokens.



2- To generate a new token, click on Generate new API Token in the API Tokens section of the page. 




Important: Only the ID  and Description will show on your screen. Take a note of the Secret Token as it will not be shown again.



Use the API Token?



Execute a command through our API (e.g. List your images/snapshots) with your API Token:


curl -H 'X-Auth-Token: 2KSBYP1FyVrrfSwXrSd1n4lwBpMruDrd' https://api.genesiscloud.com/compute/v1/images
{
    "images": [
        {
            "id": "7b1644e2-d97d-4725-a927-0028bc60bc28",
            "name": "Ubuntu 16.04",
            "type": "distribution",
            "created_at": "2020-03-16T14:22:00.755Z"
        },
        {
            "id": "e987a351-dc06-43f0-8712-f60ced372ee4",
            "name": "Ubuntu 18.04",
            "type": "distribution",
            "created_at": "2020-03-16T14:21:59.652Z"
        },
        {
            "id": "13614a2e-eabe-444a-aada-150f24a8c216",
            "name": "dddddd_snapshot_2020-03-11",
            "type": "snapshot",
            "created_at": "2020-03-11T11:52:39.566Z"
        }
    ],
    "total_count": 3,
    "page": 1,
    "per_page": 50
}



Delete the API Token?


1- To delete an API Token click on the “Trash icon”.




2- Click on the “Delete” button to confirm your action.