Pass the host ID in your infrastructure as external_id in the API path, the vault name in the vault, address, and optional label fields. Additionally, pass the ssh port in port field inside the ssh object or telnet port in port inside the telnet object.

To see the full schema of the request, click on the Schema in Request body below.

Example of the request that creates a new host with external_id as vm-1234 in Team vault with address example.com, label Database, ssh port 22, and ssh credentials in username and password properties, and SSH key in the key property:

• path: /v1/host/vm-1234/
• body:

  {
    "vault": "Team",
    "address": "example.com",
    "label": "Database",
    "ssh": {
      "port": 22,
      "credentials": {
        "username": "username",
        "password": "password",
        "key": {
          "label": "shared with the team",
          "private": "-----BEGIN OPENSSH PRIVATE KEY-----\nb3Blbn..."
        }
      }
    }
  }
  

Optionally, pass the group field with the group external_id instead of the vault. Create such a group with the <a rel="noopener noreferrer" href="#operations-group-createGroup"> <code>/group/{external_id}/</code> API</a>.

{
  "vault": "Team",
  "address": "some.address.for.connection"
}