Create a tunneling key

curl --request POST \
  --url https://dashboard.hologram.io/api/1/tunnelkeys \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "public_key": "ssh-rsa AAAAB3Nzaasdf... user@example.com"
}
'

{
  "success": true,
  "data": {
    "id": 1234,
    "public_key": "ssh-rsa AAAAB3Nzaasdf... user@example.com",
    "userid": 4321,
    "disabled": 0
  }
}

Secure device tunneling

Create a tunneling key

Create a public secure device tunneling key.

Associate an SSH key with your user. This key can then be used to tunnel to devices that you control. There is a limit of 5 enabled keys per user.

If public_key is omitted, the server generates a 2048-bit RSA keypair. The private key is returned in the response and is not stored — save it immediately. The key type must be ssh-rsa.

If the org does not have a plan that supports device tunneling, this endpoint will return with a 403.

POST

tunnelkeys

Create a tunneling key

curl --request POST \
  --url https://dashboard.hologram.io/api/1/tunnelkeys \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "public_key": "ssh-rsa AAAAB3Nzaasdf... user@example.com"
}
'

{
  "success": true,
  "data": {
    "id": 1234,
    "public_key": "ssh-rsa AAAAB3Nzaasdf... user@example.com",
    "userid": 4321,
    "disabled": 0
  }
}

Authorizations

Authorization

string

header

required

HTTP Basic authentication using API keys. Set the username to apikey and the password to your API key.

You can find your API key on the Hologram Dashboard under Account Settings.

Body

application/json

public_key

string

SSH RSA public key. If omitted, a keypair is generated server-side and the private key is returned in the response.

Response

data

object

Show child attributes

success

boolean

Whether the request was successful or not

Example:

true

Documentation Index

Authorizations

Body

Response