Register an SSH key
curl --request POST \
--url https://api.onecli.sh/v1/user/ssh-keys \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "work laptop",
"publicKey": "ssh-ed25519 AAAAC3… user@host"
}
'import requests
url = "https://api.onecli.sh/v1/user/ssh-keys"
payload = {
"name": "work laptop",
"publicKey": "ssh-ed25519 AAAAC3… user@host"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: 'work laptop', publicKey: 'ssh-ed25519 AAAAC3… user@host'})
};
fetch('https://api.onecli.sh/v1/user/ssh-keys', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.onecli.sh/v1/user/ssh-keys",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'work laptop',
'publicKey' => 'ssh-ed25519 AAAAC3… user@host'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.onecli.sh/v1/user/ssh-keys"
payload := strings.NewReader("{\n \"name\": \"work laptop\",\n \"publicKey\": \"ssh-ed25519 AAAAC3… user@host\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.onecli.sh/v1/user/ssh-keys")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"work laptop\",\n \"publicKey\": \"ssh-ed25519 AAAAC3… user@host\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.onecli.sh/v1/user/ssh-keys")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"work laptop\",\n \"publicKey\": \"ssh-ed25519 AAAAC3… user@host\"\n}"
response = http.request(request)
puts response.read_body{
"sshKey": {
"id": "<string>",
"name": "<string>",
"fingerprint": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"lastUsedAt": "2023-11-07T05:31:56Z"
}
}{
"error": "<string>"
}{
"error": "<string>"
}User
Register an SSH public key
Registers an ed25519 public key on your account. The fingerprint is computed server-side, duplicates are refused, and each account holds up to 25.
POST
/
user
/
ssh-keys
Register an SSH key
curl --request POST \
--url https://api.onecli.sh/v1/user/ssh-keys \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "work laptop",
"publicKey": "ssh-ed25519 AAAAC3… user@host"
}
'import requests
url = "https://api.onecli.sh/v1/user/ssh-keys"
payload = {
"name": "work laptop",
"publicKey": "ssh-ed25519 AAAAC3… user@host"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: 'work laptop', publicKey: 'ssh-ed25519 AAAAC3… user@host'})
};
fetch('https://api.onecli.sh/v1/user/ssh-keys', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.onecli.sh/v1/user/ssh-keys",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'work laptop',
'publicKey' => 'ssh-ed25519 AAAAC3… user@host'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.onecli.sh/v1/user/ssh-keys"
payload := strings.NewReader("{\n \"name\": \"work laptop\",\n \"publicKey\": \"ssh-ed25519 AAAAC3… user@host\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.onecli.sh/v1/user/ssh-keys")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"work laptop\",\n \"publicKey\": \"ssh-ed25519 AAAAC3… user@host\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.onecli.sh/v1/user/ssh-keys")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"work laptop\",\n \"publicKey\": \"ssh-ed25519 AAAAC3… user@host\"\n}"
response = http.request(request)
puts response.read_body{
"sshKey": {
"id": "<string>",
"name": "<string>",
"fingerprint": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"lastUsedAt": "2023-11-07T05:31:56Z"
}
}{
"error": "<string>"
}{
"error": "<string>"
}Registers a public key with your account. Use it to set up a new machine for SSH access to your agents.
Related guide: Quickstart.
ed25519 only. The fingerprint is computed server-side; the same key cannot be registered twice. At most 25 keys per account.
Availability: Cloud · Community (self-hosted) · Enterprise (self-hosted)
Authorizations
A workspace API key (oc_…) or organization API key (oc_org_…). Workspace-scoped endpoints called with an organization key also need X-Workspace-Id.
Body
application/json
Response
Registered
Show child attributes
Show child attributes