🚀Deploying your project
If you used the command alpio projects create, the CLI should ask you if you want to immediately deploy the project. You can say yes (the default is no). If you decided to deploy later, you can deploy whenever you're ready using the following command:
This will ask you which project you want to deploy, and then proceed to do so.
The deploy should take a few minutes, don't close your terminal window if you need to see output URL of your project (although closing the terminal window has no impact on the deploy process itself). If you accidentally closed your terminal, you can still see your project's URL using the following command:
You can now make an HTTP request to your project to test it, using a CLI tool like curl, or HTTP clients with a GUI, like Postman, or Insomnia.
Handling authentication
If you decided to make your project private (this is the default behaviour), you will need to add a method of authentication to your HTTP requests. Currently, only API keys are supported, although other methods will quickly be added.
Creating an API key
To add an API key to your, run the following command:
This will ask you to select to which project you want to add an API key, to define name for the key, and then proceed to create it.
Make sure to write down the API key's value somewhere safe, as you won't be able to see it again.
Listing API key
If you want to list your project's API keys, use the following command:
You will be able to see the name of your API keys, and a redacted preview.
Deleting an API key
If you lose one of your API keys, or think it might have been compromised, make sure to delete the API key and to re-create another one, using the following commands
Authenticating using an API key
To authenticate using the API key you have just created, simply pass it to the x-api-key header of your HTTP request.
This should allow you to access your API.
Last updated