DeployHQ
Overview
Section titled “Overview”The DeployHQ integration connects your DeployHQ account to Oneleet and syncs its users, so Oneleet can track who has access to your deployments.
What does Oneleet monitor?
Section titled “What does Oneleet monitor?”- DeployHQ users, including whether they’re an account administrator and which account permissions they have (managing users, billing, projects, and network agents)
DeployHQ’s API doesn’t report whether a user has two-factor authentication enabled, or whether your account requires it, so Oneleet can’t check it.
To set up the DeployHQ integration, navigate to Integrations > Add integration > DeployHQ and click Continue.
Oneleet requires your DeployHQ account subdomain, the email address of a DeployHQ account administrator, and a read-only API key created by that user.
Creating a read-only API key
Section titled “Creating a read-only API key”- Copy your account subdomain from the address bar. For
https://yourcompany.deployhq.com, the subdomain isyourcompany - Go to Settings, and under Personal select Security
- Under API Credentials, enter a description for the new key and check Read-only (can only call read endpoints)
- Click Create API Key and copy the key. DeployHQ shows it only once
For more information, see the DeployHQ API documentation.
Connecting to Oneleet
Section titled “Connecting to Oneleet”- Enter your DeployHQ account subdomain
- Enter the email address you sign in to DeployHQ with
- Paste the API key
- Click Submit
Oneleet validates the credentials by querying the DeployHQ API, and creates the connection if they’re valid.