Mint an SSH certificate for a hosted agent

Mint an SSH certificate for an agent

curl --request POST \
  --url https://api.onecli.sh/v1/agents/{agentId}/ssh-certificate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "publicKey": "<string>"
}
'

import requests

url = "https://api.onecli.sh/v1/agents/{agentId}/ssh-certificate"

payload = { "publicKey": "<string>" }
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({publicKey: '<string>'})
};

fetch('https://api.onecli.sh/v1/agents/{agentId}/ssh-certificate', 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/agents/{agentId}/ssh-certificate",
  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([
    'publicKey' => '<string>'
  ]),
  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/agents/{agentId}/ssh-certificate"

	payload := strings.NewReader("{\n  \"publicKey\": \"<string>\"\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/agents/{agentId}/ssh-certificate")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"publicKey\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onecli.sh/v1/agents/{agentId}/ssh-certificate")

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  \"publicKey\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "certificate": "<string>",
  "host": "<string>",
  "port": 123,
  "user": "<string>",
  "serial": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

POST

agents

{agentId}

ssh-certificate

Mint an SSH certificate for an agent

curl --request POST \
  --url https://api.onecli.sh/v1/agents/{agentId}/ssh-certificate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "publicKey": "<string>"
}
'

import requests

url = "https://api.onecli.sh/v1/agents/{agentId}/ssh-certificate"

payload = { "publicKey": "<string>" }
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({publicKey: '<string>'})
};

fetch('https://api.onecli.sh/v1/agents/{agentId}/ssh-certificate', 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/agents/{agentId}/ssh-certificate",
  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([
    'publicKey' => '<string>'
  ]),
  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/agents/{agentId}/ssh-certificate"

	payload := strings.NewReader("{\n  \"publicKey\": \"<string>\"\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/agents/{agentId}/ssh-certificate")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"publicKey\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onecli.sh/v1/agents/{agentId}/ssh-certificate")

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  \"publicKey\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "certificate": "<string>",
  "host": "<string>",
  "port": 123,
  "user": "<string>",
  "serial": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Issues a certificate for exactly one key source. It answers 404 when the deployment has no SSH front door. See Self-hosting for deployment options. Signs a short-lived OpenSSH user certificate that lets you SSH into the hosted agent’s sandbox. Name exactly one key source: an ed25519 public key pasted inline, or the id of a key registered at POST /user/ssh-keys. Answers 404 when the deployment has no SSH front door (see ssh in GET /instance).

Availability: Cloud · Community (self-hosted) · Enterprise (self-hosted)

Authorizations

Authorization

string

header

required

A workspace API key (oc_…) or organization API key (oc_org_…). Workspace-scoped endpoints called with an organization key also need X-Workspace-Id.

Path Parameters

agentId

string

required

Body

application/json

Inline public key
Registered key

publicKey

string

required

An ssh-ed25519 … public key line.

Maximum string length: 1024

Response

The certificate and where to connect

certificate

string

The signed OpenSSH user certificate line (ssh-ed25519-cert-v01@openssh.com …). Save it next to your private key as <key>-cert.pub.

host

string

port

integer

user

string

The SSH username to connect as (the agent id).

serial

string

expiresAt

string<date-time>

Workspace

Organization

Enterprise

Platform

Mint an SSH certificate for a hosted agent

Authorizations

Path Parameters

Body

Response