Update a key

PUT/compute/{connection_id}/key/{id}

Parameters

Payload

idstring

Unique identifier for the key

created_atdate-time

When the key was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atdate-time

When the key was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring

Display name of the key

type enum

Valid values:

"SSH"

"REGISTRY"

"SECRET"

"OTHER"

The kind of credential

public_keystring

SSH public key

private_keystring

SSH private key generated by the vendor; returned only in the create response

fingerprintstring

SSH key fingerprint

registry_urlstring

Container registry URL (REGISTRY keys)

usernamestring

Registry or SSH username

secretstring

Registry password or secret value (write-only; never returned)

instance_idstring

The instance this key is scoped to, for per-instance keys

expires_atdate-time

When the key expires (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

raw

Raw data from integration

Returns

ComputeKey

Response field	Type	Required	Description
`id`	string	No	Unique identifier for the key
`created_at`	string (date-time)	No	When the key was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`updated_at`	string (date-time)	No	When the key was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`name`	string	No	Display name of the key
`type`	enum	No	The kind of credential Values: `SSH`, `REGISTRY`, `SECRET`, `OTHER`
`public_key`	string	No	SSH public key
`private_key`	string	No	SSH private key generated by the vendor; returned only in the create response
`fingerprint`	string	No	SSH key fingerprint
`registry_url`	string	No	Container registry URL (REGISTRY keys)
`username`	string	No	Registry or SSH username
`secret`	string	No	Registry password or secret value (write-only; never returned)
`instance_id`	string	No	The instance this key is scoped to, for per-instance keys
`expires_at`	string (date-time)	No	When the key expires (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}

Status	Error	Meaning
`400`	Bad Request	The request was malformed or failed validation.
`401`	Unauthorized	The connection is likely broken; re-authorize it.
`403`	Forbidden	The connection is missing permissions or scopes.
`404`	Not Found	The requested resource does not exist.
`429`	Too Many Requests	Rate limit exceeded (see the two sources below).
`500`	Internal Server Error	An unexpected error occurred.
`501`	Not Implemented	Not supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

The integration's own rate limit, passed through.
Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.

const options = {
  method: 'PUT',
  url: 'https://api.unified.to/compute/5de520f96e439b002043d8dc/key/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);

Code Samples

Node.js SDK

import { UnifiedTo } from '@unified-api/typescript-sdk';

const sdk = new UnifiedTo({
    security: {
        jwt: '<YOUR_API_KEY_HERE>',
    },
});

const connectionId = '5de520f96e439b002043d8dc';

const id = '1234';

const results = await sdk.compute.updateComputeKey({ connectionId, id, computeKey: { }, 
    fields: '',
    raw: '',
 });

Node.js (axios)

const options = {
  method: 'PUT',
  url: 'https://api.unified.to/compute/5de520f96e439b002043d8dc/key/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);

Java

AsyncHttpClient client = new DefaultAsyncHttpClient();

client.prepare("PUT", "https://api.unified.to/compute/5de520f96e439b002043d8dc/key/5de520f96e439b002043d8d8?fields=&raw=")
  .setHeader("accept", "application/json")
  .setHeader("authorization", ".....")
  .execute()
  .toCompletableFuture()
  .thenAccept(System.out::println)
  .join();

client.close();

Go

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

url := `https://api.unified.to/compute/5de520f96e439b002043d8dc/key/5de520f96e439b002043d8d8?fields=&raw=

req, _ := http.NewRequest("PUT", url, nil)

req.Header.Add("accept", "application/json")
req.Header.Add("authorization", ".....")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)

Python

import requests

url = "https://api.unified.to/compute/5de520f96e439b002043d8dc/key/5de520f96e439b002043d8d8?fields=&raw="

headers = {
    "accept": "application/json",
    "authorization": "....."
}

response = requests.put(url, headers=headers)

PHP

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unified.to/compute/5de520f96e439b002043d8dc/key/5de520f96e439b002043d8d8?fields=&raw=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_HTTPHEADER => [
    "accept: application/json",
    "authorization: ....."
  ],
]);

Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.unified.to/compute/5de520f96e439b002043d8dc/key/5de520f96e439b002043d8d8?fields=&raw=")

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

request = Net::HTTP::Put.new(url)
request["accept"] = 'application/json'
request["authorization"] = '....'

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

cURL

curl --request PUT \
  --url 'https://api.unified.to/compute/5de520f96e439b002043d8dc/key/5de520f96e439b002043d8d8?fields=&raw=' \
  --header 'accept: application/json' \
  --header 'authorization: .....'

Are we missing anything? Let us know

Was this page helpful?