Update SSH Public Key

PATCH /v1/ssh-public-keys/{uuid}

Update SSH Public Key

cURL

curl --request PATCH \
  --url https://api.dispersed.com/v1/ssh-public-keys/{uuid} \
  --header 'Content-Type: application/json' \
  --data '
{
  "is_default": true,
  "name": "Work Laptop"
}
'

import requests

url = "https://api.dispersed.com/v1/ssh-public-keys/{uuid}"

payload = {
    "is_default": True,
    "name": "Work Laptop"
}
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({is_default: true, name: 'Work Laptop'})
};

fetch('https://api.dispersed.com/v1/ssh-public-keys/{uuid}', 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.dispersed.com/v1/ssh-public-keys/{uuid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'is_default' => true,
    'name' => 'Work Laptop'
  ]),
  CURLOPT_HTTPHEADER => [
    "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.dispersed.com/v1/ssh-public-keys/{uuid}"

	payload := strings.NewReader("{\n  \"is_default\": true,\n  \"name\": \"Work Laptop\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	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.patch("https://api.dispersed.com/v1/ssh-public-keys/{uuid}")
  .header("Content-Type", "application/json")
  .body("{\n  \"is_default\": true,\n  \"name\": \"Work Laptop\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dispersed.com/v1/ssh-public-keys/{uuid}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"is_default\": true,\n  \"name\": \"Work Laptop\"\n}"

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

200

{
  "created_at": "2023-11-07T05:31:56Z",
  "fingerprint": "<string>",
  "is_default": true,
  "object": "ssh_public_key",
  "public_key": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "account": "<string>",
  "account_uuid": "<string>",
  "deleted_at": "2023-11-07T05:31:56Z",
  "last_used_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "uuid": "<string>"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "timestamp": "<string>",
    "details": []
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "timestamp": "<string>",
    "details": []
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "timestamp": "<string>",
    "details": []
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "timestamp": "<string>",
    "details": []
  }
}

Path Parameters

uuid · string<uuid> · required

Body

application/json

is_default · boolean

Set or unset this key as the default

Example:

true

name · string | null

Optional label for this SSH public key (null to clear)

Maximum string length: 100

Example:

"Work Laptop"

Response

200

application/json

SSH public key updated successfully

created_at · string<date-time> | null · required

fingerprint · string · required

is_default · boolean · required

object · enum<string> · required

Available options: ssh_public_key

public_key · string · required

updated_at · string<date-time> | null · required

account · string | null

account_uuid · string | null

deleted_at · string<date-time> | null

last_used_at · string<date-time> | null

name · string | null

uuid · string | null