.`
Once you finished the steps above you are ready to build! Simply trigger the Workflow you just updated to run on CI-Engine and check the state of your runners on the detail page of your subscription.
#### Personal Access Token Configuration
For the runners to authenticate themselves, a [fine-grained Personal Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) needs to be provided. Create a new fine-grained PAT in your GitHub Developer settings and make sure to configure the token as follows:
1. Set the “Expiration” to **No expiration**
2. Under “Repository Access” select **Only selected repositories** and add the Repository which you’re creating the integration for.
3. Under “Permissions" add the repository permissions **Administration** and **Actions** and change "Access" to **Read and Write**. Note: This access will also enforce **Read** access for **Metadata**.
#### Webhook Configuration
To spawn the runners on demand you need to setup Webhooks in your GitHub pipeline:
1. In your GitHub repository, go to **Settings > Webhooks** and click on the **Add Webhook**-Button
2. Configure the **Payload URL** and the **Secret** that are provided in the Wizard-Step. Alternatively you can find this information on the details page of your integration by clicking on **(**•••**) More** button and **View Webhook Config**.
3. Under **Which events would you like to trigger this webhook?** select **Let me select individual events** and enable **Workflow jobs**. This event webhook is **required** for the runners to spawn correctly.
#### Workflow Configuration
In order for GitHub to know which runner can pick up a job you need to specify [runs-on](https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on) label in your GitHub Actions Workflow. This string needs to be set to the **Runner Label** provided in the Wizard-Step. Alternatively you can find this information on the details page of your integration. Make sure that all jobs have only this Runner Label configured on the [runs-on](https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on) label or else it cannot be guaranteed that the job gets correctly picked up by the runner.
# Setup Buildkite Integration
To integrate Buildkite with your CI-Engine subscription, follow the steps below:
1. Navigate to CI-Engine > [Integrations](https://my.flow.swiss/#/ci-engine/integrations).
2. Click on the **(+) Plus** sign.
3. Choose the **subscription** for which you create the integration.
4. Choose **Buildkite** as the CI-provider of the integration.
5. Choose a global or custom image for your runners to use.
1. You can always [change the image of the integration](/products/ci-engine/how-to/change-image-of-integration) later.
6. Configure the runners to connect to your repository.
1. Setup an [**Agent Token** at Buildkite](#agent-token-configuration)
2. Define a runner timeout, after which a runner without an active build job will be terminated.
7. Give your integration a name.
8. Configure a [**webhook** at Buildkite](#webhook-configuration)
9. Add the displayed public [SSH key to your repository](#ssh-configuration).
Once you finished the steps above you are ready to build! Simply trigger the Workflow you just updated to run on CI-Engine and check the state of your runners on the detail page of your subscription.
#### Agent Token Configuration
The [agent token](https://buildkite.com/docs/agent/v3/tokens#create-a-token-using-the-buildkite-interface) is used to authenticate and connect the agent on each new runner to your pipeline. We support both clustered and unclustered tokens. However we strongly suggest the usage of a clustered agent token as this is the new default for Buildkite agent tokens. You can find out more about unclustered Buildkite agent tokens [here](https://buildkite.com/docs/agent/v3/unclustered-tokens).
#### Webhook Configuration
To spawn the runners on demand you need to setup Webhooks in your Buildkite pipeline:
1. In your Buildkite dashboard, go to **Settings > Notification Services** and click on the **Add**-Button for webhooks.
2. Configure the **Webhook URL** and the **Token** that are provided in the Wizard-Step. Alternatively you can find this information on the details page of your integration by clicking on **(**•••**) More** button and **View Webhook Config**.
3. Configure the **Webhook Notifications** by selecting the Events **job.scheduled** and **job.finished**. These Events are **required** for the runners to spawn correctly.
#### SSH Configuration
To give the runner access to clone your repository during the jobs you need to add the SSH public key that is provided on this step to your git provider. Most providers support a **deploy key** that can be used for this purpose. For more instructions you can follow the official documentation of your provider:
* [GitLab](https://docs.gitlab.com/ee/user/project/deploy_keys/#create-a-project-deploy-key)
* [GitHub](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/managing-deploy-keys#set-up-deploy-keys)
* [BitBucket](https://confluence.atlassian.com/bitbucketserver/ssh-access-keys-for-system-use-776639781.html#SSHaccesskeysforsystemuse-AddanSSHaccesskeytoeitheraprojectorrepository)
# Customise Image
If our global images don’t meet your requirements, you can customise them, creating a custom image specific to your needs.
Note: This feature is only available to Professional subscriptions. If you are currently on an Essential subscription please upgrade to Professional first. To do this, navigate to the details page of your subscription, click on the dot-menu and on “Upgrade Subscription”.
To customise a global image follow the instructions below:
1. Navigate to the details page of your Professional subscription.
2. Open the tab **Custom Images**.
3. Click on the **(+) Plus** sign on the right side, which will open the wizard.
4. Choose the global image you wish to customise.
5. Enter a **name** and a **description** for the custom image.
6. Click on **Create**.
1. We will get the image ready, this will take a few minutes. You can see it’s status in the **Custom Images** tab. Once it is in the status **Customising** it is ready for you to make your changes.
7. [Connect to the runner](/products/ci-engine/how-to/enable-debug-mode#connect-to-runner) of your custom image.
8. Make your changes to the image. Please have a look at [important information](/products/ci-engine/resources/custom-images#important-information) on custom images.
9. Disconnect from the runner.
10. Navigate to the details page of your Professional subscription.
11. Open the tab **Custom Images**.
12. On the image you just finished customising, click on the **(**•••**) More** button.
13. Click **Finalize**, which will save the changes made to the image and make it ready for use.
Once the custom image is **Available** it can be chosen while creating a new integration or you can change the image of an existing integration.
# Enable Debug Mode
### Debug Mode
Runners can be started in debug mode, in which case we will keep them running for 12 hours. During this time you can connect to the runner via SSH or VNC.
#### Integration Debug Mode
Debug mode can be enabled for a whole integration. Then every runner of that integration will be started in debug mode. To enable debug mode for the whole integration:
1. Navigate to the details page of your integration.
2. Click on **(**•••**)** **More** and **Change Settings**.
3. Toggle the **Debug mode** setting.
To disable debug mode simply follow the steps above again and toggle the **Debug mode** setting off.
#### Runner Debug Mode
Debug mode can be enabled for a single runner. To enable debug mode for a runner:
1. Navigate to the details page of your subscription.
2. Select the tab of **Active Runners**.
3. Click on the **(**•••**)** **More** of the runner you would like to debug and then on **Enable Debug Mode**.
To disable debug mode simply click on **(**•••**)** **More** of the runner currently in debug mode and then **Disable Debug Mode**.
### Connect to Runner
To connect to the runner via VNC or SSH follow these steps in the wizard:
1. Navigate to the details page of your subscription.
2. Open the **Active Runners** tab.
3. On the runner you wish to connect to, click on **(**•••**)** **More**.
4. Click either on **Connect with VNC** or **Connect with SSH**.
5. Open Cloudflare Tunnel
1. Either run the cloudflare daemon in docker or locally by copying the command displayed in the wizard.
6. Connecting via VNC
1. Connect to your runner with your preferred VNC application using the address and credentials provided in the wizard.
7. Alternatively to step 6: Connecting via SSH
1. Download the SSH private key to authenticate yourself with the runner. Copy the SSH command from the wizard and adjust the path to your private key file that you saved before.
# Change Image of Integration
In order to change the image runners use within your Integration follow the steps below:
1. Navigate to the details page of your integration.
2. Click on the **(**•••**)** **More** button on the right.
3. Click on **Change Image**.
4. Select the new image for the integration.
5. Click on **Save**.
Note: It may take a few minutes for the changes to take effect. Runners your pipeline requests will remain scheduled while we get the new image ready.
# Resources
# Runners & Concurrency
### Runners
Once you have setup an integration with your CI-provider, your build-jobs will be processed by our runners as soon as the configured pipeline is triggered.
#### Active Runners
Runners which are currently scheduled to start, starting or running can be seen in the tab “Active Runners” on the subscription- or integration details.
#### Runner History
Past runners can be found in the “Runner History” tab on the details page of your integration.
#### Debug mode
You have the option to connect to your runner while it has the status “Starting” or “Running” for debugging purposes. For detailed instructions see [How-to: Enable Debug Mode](/products/ci-engine/how-to/enable-debug-mode).
#### Automatic Timeout
* Runners in debug mode will be timed out after 12 hours.
* Runners customizing an Image will be timed out after 12 hours.
### Concurrency
The concurrency limit is the amount of runners which can run in parallel. A subscription has a concurrency limit of one by default.
Be advised that the minimum commitment time for reducing the concurrency limit is 730 hours (\~1 month). You can only reduce your concurrency limit once the commitment time has passed.
#### Changing Concurrency Limit
1. Navigate to the details page of your subscription.
2. Click on the dot-menu of the subscription.
3. Click on “Change limits” in the action menu.
4. Set your “New Concurrency Limit”.
# Vanilla Images
# macOS 15.2 - Vanilla
A plain macOS Sequoia Image with no pre-installed software for you to customise.
# Golden Images
# macOS 15.2 - Golden
A macOS Sequoia Image with pre-installed build-tools, ready for you to use.
## macOS Version
* OS Version: macOS 15.2 (24C101)
* Kernel Version: Darwin 24.2.0
## Language and Runtime
* .NET Core SDK: 8.0.101, 8.0.204, 8.0.303, 8.0.405, 9.0.102
* Bash 3.2.57(1)-release
* Clang/LLVM 15.0.0
* Clang/LLVM (Homebrew) 18.1.8 - available on `$(brew --prefix llvm@18)/bin/clang`
* GCC 12 (Homebrew GCC 12.4.0) - available by `gcc-12` alias
* GCC 13 (Homebrew GCC 13.3.0) - available by `gcc-13` alias
* GCC 14 (Homebrew GCC 14.2.0\_1) - available by `gcc-14` alias
* GNU Fortran 12 (Homebrew GCC 12.4.0) - available by `gfortran-12` alias
* GNU Fortran 13 (Homebrew GCC 13.3.0) - available by `gfortran-13` alias
* GNU Fortran 14 (Homebrew GCC 14.2.0\_1) - available by `gfortran-14` alias
* Kotlin 2.1.0-release-394
* Node.js 22.13.0
* Perl 5.40.1
* Python3 3.13.1
* Ruby 3.3.7
## Package Management
* Bundler 2.6.3
* Carthage 0.40.0
* CocoaPods 1.16.2
* Homebrew 4.4.16
* NPM 10.9.2
* Pip3 24.3.1 (python 3.13)
* Pipx 1.7.1
* RubyGems 3.6.3
* Yarn 1.22.22
## Project Management
* Apache Ant 1.10.15
* Apache Maven 3.9.9
* Gradle 8.12
## Utilities
* 7-Zip 17.05
* aria2 1.37.0
* azcopy 10.27.1
* bazel 8.0.1
* bazelisk 1.25.0
* bsdtar 3.5.3 - available by 'tar' alias
* Curl 8.7.1
* Git 2.48.1
* Git LFS 3.6.1
* GitHub CLI 2.65.0
* GNU Tar 1.35 - available by 'gtar' alias
* GNU Wget 1.25.0
* gpg (GnuPG) 2.4.7
* jq 1.7.1
* OpenSSL 1.1.1w 11 Sep 2023
* Packer 1.11.2
* pkgconf 2.3.0
* Unxip 3.1
* yq 4.45.1
* zstd 1.5.6
## Tools
* AWS CLI 2.23.2
* AWS SAM CLI 1.132.0
* AWS Session Manager CLI 1.2.694.0
* Azure CLI 2.68.0
* Azure CLI (azure-devops) 1.0.1
* Bicep CLI 0.32.4
* Cmake 3.31.4
* CodeQL Action Bundle 2.20.1
* Fastlane 2.226.0
* SwiftFormat 0.55.4
* Xcbeautify 2.17.0
* Xcode Command Line Tools 16.2.0.0.1.1733547573
* Xcodes 1.6.0
## Linters
* SwiftLint 0.58.2
## Browsers
* Safari 18.2 (20620.1.16.11.8)
* SafariDriver 18.2 (20620.1.16.11.8)
* Google Chrome 132.0.6834.84
* Google Chrome for Testing 132.0.6834.83
* ChromeDriver 132.0.6834.83
* Selenium server 4.27.0
### **Environment variables**
| Name | Value |
| --------------- | --------------------------------------- |
| CHROMEWEBDRIVER | /usr/local/share/chromedriver-mac-arm64 |
| EDGEWEBDRIVER | |
| GECKOWEBDRIVER | |
## Java
| Version | Environment Variable |
| --------------------- | --------------------- |
| 11.0.25+9 | JAVA\_HOME\_11\_arm64 |
| 17.0.13+11 | JAVA\_HOME\_17\_arm64 |
| 21.0.5+11.0 (default) | JAVA\_HOME\_21\_arm64 |
## Cached Tools
### **Ruby**
* 3.1.6
* 3.2.6
* 3.3.7
* 3.4.1
### **Python**
* 3.11.9
* 3.12.8
* 3.13.1
### **Node.js**
* 18.20.5
* 20.18.1
* 22.13.0
### **Go**
* 1.21.13
* 1.22.10
* 1.23.4
## Rust Tools
* Cargo 1.84.0
* Rust 1.84.0
* Rustdoc 1.84.0
* Rustup 1.27.1
### **Packages**
* Clippy 0.1.84
* Rustfmt 1.8.0-stable
## PowerShell Tools
* PowerShell 7.4.6
### **PowerShell Modules**
* Az: 12.4.0
* Pester: 5.7.1
* PSScriptAnalyzer: 1.23.0
## Xcode
| Version | Build | Path | Symlinks |
| -------------- | -------- | ----------------------------- | -------------------------------------------------------------------------------------------------- |
| 16.2 | 16C5032a | /Applications/Xcode\_16.2.app | /Applications/Xcode\_16.2.0.app |
| 16.1 | 16B40 | /Applications/Xcode\_16.1.app | /Applications/Xcode\_16.1.0.app |
| 16.0 (default) | 16A242d | /Applications/Xcode\_16.app | /Applications/Xcode\_16.0.0.app
/Applications/Xcode\_16.0.app
/Applications/Xcode.app
|
| 15.4 | 15F31d | /Applications/Xcode\_15.4.app | /Applications/Xcode\_15.4.0.app |
### **Installed SDKs**
| SDK | SDK Name | Xcode Version |
| ------------------------ | -------------------- | ------------- |
| macOS 14.5 | macosx14.5 | 15.4 |
| macOS 15.0 | macosx15.0 | 16.0 |
| macOS 15.1 | macosx15.1 | 16.1 |
| macOS 15.2 | macosx15.2 | 16.2 |
| iOS 17.5 | iphoneos17.5 | 15.4 |
| iOS 18.0 | iphoneos18.0 | 16.0 |
| iOS 18.1 | iphoneos18.1 | 16.1 |
| iOS 18.2 | iphoneos18.2 | 16.2 |
| Simulator - iOS 17.5 | iphonesimulator17.5 | 15.4 |
| Simulator - iOS 18.0 | iphonesimulator18.0 | 16.0 |
| Simulator - iOS 18.1 | iphonesimulator18.1 | 16.1 |
| Simulator - iOS 18.2 | iphonesimulator18.2 | 16.2 |
| tvOS 17.5 | appletvos17.5 | 15.4 |
| tvOS 18.0 | appletvos18.0 | 16.0 |
| tvOS 18.1 | appletvos18.1 | 16.1 |
| tvOS 18.2 | appletvos18.2 | 16.2 |
| Simulator - tvOS 17.5 | appletvsimulator17.5 | 15.4 |
| Simulator - tvOS 18.0 | appletvsimulator18.0 | 16.0 |
| Simulator - tvOS 18.1 | appletvsimulator18.1 | 16.1 |
| Simulator - tvOS 18.2 | appletvsimulator18.2 | 16.2 |
| watchOS 10.5 | watchos10.5 | 15.4 |
| watchOS 11.0 | watchos11.0 | 16.0 |
| watchOS 11.1 | watchos11.1 | 16.1 |
| watchOS 11.2 | watchos11.2 | 16.2 |
| Simulator - watchOS 10.5 | watchsimulator10.5 | 15.4 |
| Simulator - watchOS 11.0 | watchsimulator11.0 | 16.0 |
| Simulator - watchOS 11.1 | watchsimulator11.1 | 16.1 |
| Simulator - watchOS 11.2 | watchsimulator11.2 | 16.2 |
| Simulator - visionOS 1.2 | xrsimulator1.2 | 15.4 |
| visionOS 1.2 | xros1.2 | 15.4 |
| visionOS 2.0 | xros2.0 | 16.0 |
| Simulator - visionOS 2.0 | xrsimulator2.0 | 16.0 |
| visionOS 2.1 | xros2.1 | 16.1 |
| Simulator - visionOS 2.1 | xrsimulator2.1 | 16.1 |
| Simulator - visionOS 2.2 | xrsimulator2.2 | 16.2 |
| visionOS 2.2 | xros2.2 | 16.2 |
| Simulator - visionOS 2.2 | xrsimulator2.2 | 16.2 |
| DriverKit 23.5 | driverkit23.5 | 15.4 |
| DriverKit 24.0 | driverkit24.0 | 16.0 |
| DriverKit 24.1 | driverkit24.1 | 16.1 |
| DriverKit 24.2 | driverkit24.2 | 16.2 |
### **Installed Simulators**
| OS | Simulators |
| ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| iOS 17.5 | iPhone 15
iPhone 15 Plus
iPhone 15 Pro
iPhone 15 Pro Max
iPhone SE (3rd generation)
iPad (10th generation)
iPad Air 11-inch (M2)
iPad Air 13-inch (M2)
iPad mini (6th generation)
iPad Pro 11-inch (M4)
iPad Pro 13-inch (M4)
|
| iOS 18.0 | iPhone 16
iPhone 16 Plus
iPhone 16 Pro
iPhone 16 Pro Max
iPhone SE (3rd generation)
iPad (10th generation)
iPad Air 11-inch (M2)
iPad Air 13-inch (M2)
iPad mini (6th generation)
iPad Pro 11-inch (M4)
iPad Pro 13-inch (M4)
|
| iOS 18.1 | iPhone 16
iPhone 16 Plus
iPhone 16 Pro
iPhone 16 Pro Max
iPhone SE (3rd generation)
iPad (10th generation)
iPad Air 11-inch (M2)
iPad Air 13-inch (M2)
iPad mini (A17 Pro)
iPad Pro 11-inch (M4)
iPad Pro 13-inch (M4)
|
| iOS 18.2 | iPhone 16
iPhone 16 Plus
iPhone 16 Pro
iPhone 16 Pro Max
iPhone SE (3rd generation)
iPad (10th generation)
iPad Air 11-inch (M2)
iPad Air 13-inch (M2)
iPad mini (A17 Pro)
iPad Pro 11-inch (M4)
iPad Pro 13-inch (M4)
|
| tvOS 17.5 | Apple TV
Apple TV 4K (3rd generation)
Apple TV 4K (3rd generation) (at 1080p)
|
| tvOS 18.0 | Apple TV
Apple TV 4K (3rd generation)
Apple TV 4K (3rd generation) (at 1080p)
|
| tvOS 18.1 | Apple TV
Apple TV 4K (3rd generation)
Apple TV 4K (3rd generation) (at 1080p)
|
| tvOS 18.2 | Apple TV
Apple TV 4K (3rd generation)
Apple TV 4K (3rd generation) (at 1080p)
|
| watchOS 10.5 | Apple Watch SE (40mm) (2nd generation)
Apple Watch SE (44mm) (2nd generation)
Apple Watch Series 5 (40mm)
Apple Watch Series 5 (44mm)
Apple Watch Series 6 (40mm)
Apple Watch Series 6 (44mm)
Apple Watch Series 7 (41mm)
Apple Watch Series 7 (45mm)
Apple Watch Series 9 (41mm)
Apple Watch Series 9 (45mm)
Apple Watch Ultra 2 (49mm)
|
| watchOS 11.0 | Apple Watch SE (40mm) (2nd generation)
Apple Watch SE (44mm) (2nd generation)
Apple Watch Series 10 (42mm)
Apple Watch Series 10 (46mm)
Apple Watch Ultra 2 (49mm)
|
| watchOS 11.1 | Apple Watch SE (40mm) (2nd generation)
Apple Watch SE (44mm) (2nd generation)
Apple Watch Series 10 (42mm)
Apple Watch Series 10 (46mm)
Apple Watch Ultra 2 (49mm)
|
| watchOS 11.2 | Apple Watch SE (40mm) (2nd generation)
Apple Watch SE (44mm) (2nd generation)
Apple Watch Series 10 (42mm)
Apple Watch Series 10 (46mm)
Apple Watch Ultra 2 (49mm)
|
| visionOS 1.2 | Apple Vision Pro |
| visionOS 2.0 | Apple Vision Pro |
| visionOS 2.1 | Apple Vision Pro |
| visionOS 2.2 | Apple Vision Pro |
## Android
| Package Name | Version |
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Android Command Line Tools | 16.0 |
| Android Emulator | 35.3.11 |
| Android SDK Build-tools | 35.0.0 35.0.1 |
| Android SDK Platforms | android-35-ext14 (rev 1)
android-35 (rev 2)
android-34-ext8 (rev 1)
android-34-ext12 (rev 1)
android-34-ext11 (rev 1)
android-34-ext10 (rev 1)
android-34 (rev 3)
android-33-ext5 (rev 1)
android-33-ext4 (rev 1)
|
| Android SDK Platform-Tools | 35.0.2 |
| Android Support Repository | 47.0.0 |
| CMake | 3.31.0 |
| Google Play services | 49 |
| Google Repository | 58 |
| NDK | 26.3.11579264
27.2.12479018 (default)
|
### **Environment variables**
| Name | Value |
| -------------------------- | --------------------------------------------------- |
| ANDROID\_HOME | /Users/runner/Library/Android/sdk |
| ANDROID\_NDK | /Users/runner/Library/Android/sdk/ndk/27.2.12479018 |
| ANDROID\_NDK\_HOME | /Users/runner/Library/Android/sdk/ndk/27.2.12479018 |
| ANDROID\_NDK\_LATEST\_HOME | /Users/runner/Library/Android/sdk/ndk/27.2.12479018 |
| ANDROID\_NDK\_ROOT | /Users/runner/Library/Android/sdk/ndk/27.2.12479018 |
| ANDROID\_SDK\_ROOT | /Users/runner/Library/Android/sdk |
# Custom Images
### Custom Images
If a build-tool from the [Golden Image](/products/ci-engine/resources/golden-images#macos-15-golden) should be missing or you have specific requirements for the Image your runners are using, you can customise any of our Global Images in your Professional subscription.
For detailed instructions see: [How-to: Customise Image](/products/ci-engine/how-to/customise-image).
Once your Custom Image is available you can setup a new integration using it or change the image of an existing integration.
#### Important Information
* The Custom Image will be bound to your subscription and cannot be transferred or re-used between other subscriptions.
* One custom image is included in every Professional subscription, for details refer to our [pricing page](/platform/pricing).
* Customising an Image will occupy a single [concurrency](/products/ci-engine/resources/runners-and-concurrency#concurrency) of your subscription, until you finalised the image.
* Do not pre-install any other agents of your CI-provider as they might conflict with our runners.
* Do not update the macOS of the Image as it might become incompatible with CI-Engine.
* If you have a specific need for an updated macOS version please contact our [support](https://flow.swiss/contact/#support).
# Overview
Flow provides several command-line interfaces (CLIs) and application programming interfaces (APIs) for managing your resources. This section provides the reference materials for these offerings.
# API
The Flow API allows you to manage resources within the Flow cloud in a simple, programmatic way using conventional HTTP requests. The endpoints are intuitive and powerful, allowing you to easily make calls to retrieve information or to execute actions.
All of the functionality that you are familiar with in the Flow control panel is also available through the API, allowing you to script the complex actions that your situation requires. Our API has predictable resource-oriented URLs, accepts and returns JSON-encoded content and uses standard HTTP response codes.
### Documentation
The latest API documentation is available here:[ https://my.flow.swiss/#/doc/](https://my.flow.swiss/#/doc/)
### Authentication
Most of our requests are protected tough a user role management system and therefore require identification of the current user. This authentication system works by requesting an authentication token using username and password and sending the generated token with each request in the X-Auth-Token header.
To generate such a token you have to make the following request:
```
POST https://api.flow.swiss/v3/auth
{
"username": "…",
"password": "…"
}
```
```
{
"token": "…",
"id": 1,
"username": "my@flow.swiss"
}
```
Please find here more details about the authentication endpoints and models:\
# Product Entities
### Mac Bare Metal
| ID | Product |
| -- | ---------------------- |
| 11 | macmini.2018.6-16-256 |
| 12 | macmini.2018.6-32-512 |
| 13 | macmini.2018.6-64-1024 |
| 14 | macmini.m1.8-16-512 |
| 23 | Bare Metal Elastic IP |
### Object Storage
| ID | Product |
| -- | -------------- |
| 20 | Object Storage |
### Compute
| ID | Product |
| -- | ---------- |
| 40 | b1.1x1 |
| 24 | b1.1x2 |
| 25 | b1.2x2 |
| 26 | b1.2x4 |
| 27 | b1.2x8 |
| 28 | b1.4x8 |
| 29 | b1.4x16 |
| 30 | b1.4x32 |
| 31 | b1.8x32 |
| 32 | b1.8x64 |
| 33 | b1.8x96 |
| 34 | b1.16x96 |
| 35 | b1.16x128 |
| 36 | b1.24x128 |
| 37 | b1.24x256 |
| 38 | b1.32x256 |
| 39 | b1.32x512 |
| 8 | Elastic IP |
### Kubernetes
| ID | Product |
| --- | -------- |
| 44 | k1.1x2 |
| 45 | k1.2x2 |
| 46 | k1.2x4 |
| 47 | k1.2x8 |
| 48 | k1.4x8 |
| 49 | k1.4x16 |
| 50 | k1.4x32 |
| 51 | k1.8x32 |
| 52 | k1.8x64 |
| 53 | k1.8x96 |
| 54 | k1.16x96 |
| 130 | k2.1x2 |
| 131 | k2.2x2 |
| 132 | k2.2x4 |
| 133 | k2.2x8 |
| 134 | k2.4x8 |
| 135 | k2.4x16 |
| 136 | k2.4x32 |
| 137 | k2.8x32 |
| 138 | k2.8x64 |
| 139 | k2.8x96 |
| 140 | k2.16x96 |
# Location Entities
### Location
| ID | Location |
| -- | -------- |
| 1 | ALP1 |
| 2 | ZRH1 |
{% hint style="info" %}
Mac Bare Metal is currently not available in ALP1
{% endhint %}
# CLI
Flow CLI allows you to interact with the Flow API via the command line. It supports most functionality found in the control panel. You can create, configure, and destroy Flow resources like Instances, Security Groups, Networks and more. We will add Mac Bare Metal and Object Storage support soon.
### Installation
The CLI is written in Go and the source code is public available: \
If you have GoLang installed, you can download and install the CLI with
```
go get github.com/flowswiss/cli/cmd/flow
```
otherwise, you will need to download the [Go](https://golang.org) executable for your system.
### Usage
After downloading you first of all need to authenticate the cli with your username and password. **Warning**: those credentials will be stored in `$HOME/.flow/credentials.json`
```
flow auth login --username 'USERNAME' --password 'PASSWORD'
```
alternatively you can also pass `--username USERNAME` and `--password PASSWORD` to every other command or set the environment variables `FLOW_USERNAME` and `FLOW_PASSWORD` to avoid the credentials getting stored in your home directory.
Once you have successfully logged in into your account, you can start manipulating things in your organization. As a first step it would be a good idea to upload your personal ssh key onto our platform. You will need this for every linux virtual machine you deploy.
```
flow compute key-pair create \
--name 'My first key pair' \
--public-key ~/.ssh/id_rsa.pub
```
Just to test things out, you can try creating an ubuntu virtual machine using the previously uploaded key pair:
```
flow compute server create \
--name 'My first virtual machine' \
--location 'ALP1' \
--image 'ubuntu-20.04' \
--product 'b1.1x1' \
--key-pair 'My first key pair'
```
Further usage manuals can be found in the application itself using the `-h` or `--help` flags or in our usage documentation found [here](https://github.com/flowswiss/cli/blob/master/docs/usage.md).
# Terraform
Terraform is an Infrastructure-as-Code tool that lets you provision, and version cloud resources safely and efficiently. It enables automated and repeatable provisioning of Flow cloud resources.