Use Cases

• Enable SSH Access on a Newly Provisioned Server After creating a server and an SSH key pair separately, call this endpoint to associate the key with the server. This completes the provisioning workflow by enabling secure, password-less SSH authentication from the moment the server is accessible.
• Deploy the Same SSH Key Across Multiple Servers at Once The serverId field accepts an array of server IDs, so you can attach a single SSH key pair to several servers in one request. Use this to roll out a shared team key or a deployment key across your entire fleet without making repeated API calls.
• Grant a New Team Member Access to Existing Infrastructure When a new developer or operator joins the team, create an SSH key pair with their public key and then attach it to all servers they need access to. This provides controlled, auditable access without modifying individual server configurations manually.
• Automate Key Distribution in CI/CD Pipelines Integrate this endpoint into your infrastructure automation to programmatically assign SSH keys to servers during deployment. A pipeline can create a key pair, provision servers, and attach the key — ensuring every deployed instance is accessible for post-deployment configuration or debugging.
• Rotate SSH Keys Across Your Server Fleet As part of a key rotation policy, create a new SSH key pair and use this endpoint to assign it to all affected servers. Once confirmed, remove the old key pair. The array-based serverId parameter makes it efficient to update multiple servers in a single call.

Getting Required Parameters

• subscriptionId (query): Retrieve available subscription IDs using the List all Subscriptions endpoint. Pass your organizationId as a query parameter to list all subscriptions, then use the id field from the response.
• sshId (path): Retrieve available SSH key pair IDs using the List SSH Key Pairs by Subscription endpoint. Pass the subscriptionId as a query parameter to get all key pairs in that subscription, then use the id field from the response.
• serverId (body): Retrieve available server IDs using the Get All Servers for a Subscription Id endpoint. Pass the subscriptionId as a query parameter to list all servers, then use the id field of each target server. This parameter accepts an array, so you can include multiple server IDs in a single request.