Key data model

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

FieldTypeRequiredDescription
idstringNoUnique identifier for the key
created_atstring (date-time)NoWhen the key was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)NoWhen the key was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestringNoDisplay name of the key
typeenumNoThe kind of credential Values: SSH, REGISTRY, SECRET, OTHER
public_keystringNoSSH public key
private_keystringNoSSH private key generated by the vendor; returned only in the create response
fingerprintstringNoSSH key fingerprint
registry_urlstringNoContainer registry URL (REGISTRY keys)
usernamestringNoRegistry or SSH username
secretstringNoRegistry password or secret value (write-only; never returned)
instance_idstringNoThe instance this key is scoped to, for per-instance keys
expires_atstring (date-time)NoWhen the key expires (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

TypeScript

TypeScript
export type ComputeKey = {
	id?: string; // Unique identifier for the key
	created_at?: string-time; // When the key was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // When the key was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	name?: string; // Display name of the key
	type?: 'SSH' | 'REGISTRY' | 'SECRET' | 'OTHER'; // The kind of credential
	public_key?: string; // SSH public key
	private_key?: string; // SSH private key generated by the vendor; returned only in the create response
	fingerprint?: string; // SSH key fingerprint
	registry_url?: string; // Container registry URL (REGISTRY keys)
	username?: string; // Registry or SSH username
	secret?: string; // Registry password or secret value (write-only; never returned)
	instance_id?: string; // The instance this key is scoped to, for per-instance keys
	expires_at?: string-time; // When the key expires (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	raw?: any; // Raw data from integration
} 

Zod

Zod
import { z } from 'zod';

export const ZodComputeKey = z.object({
	id: z.string().optional().describe("Unique identifier for the key"),
	created_at: z.string-time().optional().describe("When the key was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("When the key was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	name: z.string().optional().describe("Display name of the key"),
	type: z.enum("SSH", "REGISTRY", "SECRET", "OTHER").optional().describe("The kind of credential"),
	public_key: z.string().optional().describe("SSH public key"),
	private_key: z.string().optional().describe("SSH private key generated by the vendor; returned only in the create response"),
	fingerprint: z.string().optional().describe("SSH key fingerprint"),
	registry_url: z.string().optional().describe("Container registry URL (REGISTRY keys)"),
	username: z.string().optional().describe("Registry or SSH username"),
	secret: z.string().optional().describe("Registry password or secret value (write-only; never returned)"),
	instance_id: z.string().optional().describe("The instance this key is scoped to, for per-instance keys"),
	expires_at: z.string-time().optional().describe("When the key expires (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class ComputeKeyType(str, Enum):
	SSH = 'SSH'
	REGISTRY = 'REGISTRY'
	SECRET = 'SECRET'
	OTHER = 'OTHER'

@dataclasses.dataclass
class ComputeKey:
	"""Unique identifier for the key"""
	id: Optional[str]
	"""When the key was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""When the key was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""Display name of the key"""
	name: Optional[str]
	"""The kind of credential"""
	type: Optional[ComputeKeyType]
	"""SSH public key"""
	public_key: Optional[str]
	"""SSH private key generated by the vendor; returned only in the create response"""
	private_key: Optional[str]
	"""SSH key fingerprint"""
	fingerprint: Optional[str]
	"""Container registry URL (REGISTRY keys)"""
	registry_url: Optional[str]
	"""Registry or SSH username"""
	username: Optional[str]
	"""Registry password or secret value (write-only; never returned)"""
	secret: Optional[str]
	"""The instance this key is scoped to, for per-instance keys"""
	instance_id: Optional[str]
	"""When the key expires (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	expires_at: Optional[str]
Are we missing anything? Let us know
Was this page helpful?