Nesneler

Netface API işlemlerinin aldığı ve döndürdüğü nesneler.

Reference

Projenin başka bir kaynağına kimlikle başvuru

Alan	Tür	Zorunlu	Açıklama
id	string (uuid)	Evet

NamedReference

Alan	Tür	Zorunlu	Açıklama
id	string (uuid)	Evet
name	string	Evet	(en uzun uzunluk 64)

NullableNamedReference

Şunlardan biri: NamedReference, null

Protection

Alan	Tür	Zorunlu	Açıklama
delete	boolean	Evet

ProtectionRequest

Alan	Tür	Zorunlu	Açıklama
delete	boolean	Evet

NameLabelsUpdateRequest

Alan	Tür	Zorunlu	Açıklama
name	string	Hayır	@ içermeyen 1-64 yazdırılabilir karakter (en kısa uzunluk 1, en uzun uzunluk 64)
labels	string eşlemesi	Hayır	En çok 32 anahtar; anahtarlar ve değerler 1-63 karakter (değerler boş olabilir): harf, rakam, ., _, -; harf ya da rakamla başlar ve biter

ErrorResponse

Alan	Tür	Zorunlu	Açıklama
error	Error	Evet

Error

Alan	Tür	Zorunlu	Açıklama
code	unauthenticated, forbidden, resource_limit_exceeded, not_found, method_not_allowed, conflict, idempotency_in_progress, invalid_input, idempotency_key_mismatch, locked, rate_limit_exceeded, internal_error, unavailable	Evet
message	string	Evet	Sabit İngilizce metin; istemciler code değerine göre yerelleştirir
details	object	Evet	forbidden: reason (scope_missing, entitlement_inactive, entitlement_restricted); resource_limit_exceeded: metric, limit, used; invalid_input: fields ([{name, message}]); locked: action (çalışan eylemin kimliği)

Meta

Alan	Tür	Zorunlu	Açıklama
pagination	Pagination	Evet

Pagination

Alan	Tür	Zorunlu	Açıklama
page	integer	Evet	(en az 1)
per_page	integer	Evet	(en az 1, en çok 100)
previous_page	integer ya da null	Evet	(en az 1)
next_page	integer ya da null	Evet	(en az 1)
last_page	integer	Evet	(en az 1)
total_entries	integer	Evet	(en az 0)

Action

Alan	Tür	Zorunlu	Açıklama
id	string (uuid)	Evet
command	string	Evet	create_server, delete_server, poweron_server, ... (snake_case, kaynak başına kapalı küme) (desen ^[a-z][a-z0-9_]{1,63}$)
actor	object	Evet	Eylemi kimin başlattığı: Console üzerinden bir kişi (user) ya da bir API anahtarı; ad ya da adres içermez
actor.type	user, api_key	Evet
actor.id	string (uuid)	Evet
status	running, success, error	Evet
progress	integer	Evet	(en az 0, en çok 100)
started	string (date-time)	Evet	RFC 3339, UTC
finished	string ya da null (date-time)	Evet
error	null ya da object	Evet
error.code	string	Evet	(desen ^[a-z][a-z0-9_]{1,63}$)
error.message	string	Evet
resources	object dizisi	Evet
resources[].id	string (uuid)	Evet
resources[].type	server, network, firewall, floating_ip, volume, snapshot, ssh_key	Evet

ActionList

Alan	Tür	Zorunlu	Açıklama
actions	Action dizisi	Evet
meta	Meta	Evet

Project

Alan	Tür	Zorunlu	Açıklama
id	string (uuid)	Evet
slug	string	Evet	(desen ^[a-z0-9][a-z0-9-]{0,38}[a-z0-9]$)
name	string	Evet	(en uzun uzunluk 120)
labels	string eşlemesi	Evet	En çok 32 anahtar; anahtarlar ve değerler 1-63 karakter (değerler boş olabilir): harf, rakam, ., _, -; harf ya da rakamla başlar ve biter
status	active, archived	Evet
created	string (date-time)	Evet	RFC 3339, UTC

ApiKey

Alan	Tür	Zorunlu	Açıklama
id	string (uuid)	Evet
name	string	Evet	@ içermeyen 1-64 yazdırılabilir karakter (en kısa uzunluk 1, en uzun uzunluk 64)
prefix	string	Evet	nfk_<key version>_ ve gizli değerin ilk altı karakteri (desen ^nfk_[1-9][0-9]{0,5}_[A-Za-z0-9_-]{6}$)
scope	read, read_write	Evet
status	active, revoked	Evet
created	string (date-time)	Evet	RFC 3339, UTC
expires	string ya da null (date-time)	Evet
last_used	string ya da null (date-time)	Evet

Location

Alan	Tür	Zorunlu	Açıklama
id	string (uuid)	Evet
name	string	Evet	Netface bölge kodu, ör. ist (desen ^[a-z]{3}[0-9]?$)
description	string	Evet	(en uzun uzunluk 120)
country	string	Evet	ISO 3166-1 alpha-2 (desen ^[A-Z]{2}$)
city	string	Evet	(en uzun uzunluk 64)
network_zone	string	Evet	(en uzun uzunluk 32)

ServerType

Alan	Tür	Zorunlu	Açıklama
id	string (uuid)	Evet
name	string	Evet	(desen ^[a-z][a-z0-9-]{1,31}$)
description	string	Evet	(en uzun uzunluk 120)
cores	integer	Evet	(en az 1)
memory_gb	integer	Evet	GiB (en az 1)
disk_gb	integer	Evet	GB (en az 1)
cpu_type	shared, dedicated	Evet
architecture	x86, arm	Evet
deprecated	boolean	Evet
locations	NamedReference dizisi	Evet	Bu sunucu tipini şu anda sunan konumlar
prices	Price dizisi	Evet	Yürürlükteki aylık fiyatlar, para birimi başına bir tane (aylık faturalanır, gün başına orantılanır; vergiler hariç). USD kanoniktir; diğer para birimleri ondan türetilir. Tipin henüz fiyatı yoksa boştur.

PriceEstimate

Alan	Tür	Zorunlu	Açıklama
currency	string	Evet	(desen ^[A-Z]{3}$)
currency_source	billing_profile, canonical, requested	Evet
priced	boolean	Evet	Bir satırın fiyatı yoksa false; toplam o zaman null olur
lines	object dizisi	Evet
lines[].resource	server_type, volume, floating_ip	Evet
lines[].quantity	integer	Evet	1 sunucu (en az 1)
lines[].unit	month, gb_month	Evet
lines[].unit_amount_minor	integer ya da null	Evet	(en az 0)
lines[].amount_minor	integer ya da null	Evet	(en az 0)
total_minor	integer ya da null	Evet	Para biriminin küçük biriminde bir aylık tutar (en az 0)

UnitPricing

Alan	Tür	Zorunlu	Açıklama
unit	month, gb_month	Evet	month adres ve ay başınadır; gb_month GB ve ay başınadır
prices	Price dizisi	Evet	Para birimi başına bir tane; kaynağın henüz fiyatı yoksa boştur

Price

Alan	Tür	Zorunlu	Açıklama
currency	string	Evet	(desen ^[A-Z]{3}$)
monthly_amount_minor	integer	Evet	Para biriminin küçük biriminde bir aylık tutar (sunucu, GB ya da adres başına) (en az 0)
origin	list, derived, synthetic	Evet	list doğrudan belirlenir, derived USD fiyatından gelir; synthetic yalnız test ortamlarında görünür
effective_from	string (date-time)	Evet

Image

Alan	Tür	Zorunlu	Açıklama
id	string (uuid)	Evet
type	system	Evet
status	available, unavailable	Evet
name	string	Evet	(en uzun uzunluk 64)
description	string	Evet	(en uzun uzunluk 120)
os_flavor	ubuntu, debian, rocky, alma, fedora, other	Evet
os_version	string	Evet	(en uzun uzunluk 32)
architecture	x86, arm	Evet
disk_size_gb	integer	Evet	(en az 1)
default_user	string ya da null	Hayır	İmajın cloud-init ile oluşturduğu kullanıcı, ssh <user>@<address> için; bilinmiyorsa null. SSH, oluşturmada verilen anahtarları kullanır; konsol parolası isteğe bağlıdır (console_password_hash). (en uzun uzunluk 32)
created	string (date-time)	Evet	RFC 3339, UTC
labels	string eşlemesi	Evet	En çok 32 anahtar; anahtarlar ve değerler 1-63 karakter (değerler boş olabilir): harf, rakam, ., _, -; harf ya da rakamla başlar ve biter
locations	NamedReference dizisi	Evet	Bu imajı şu anda sunan konumlar

SshKey

Alan	Tür	Zorunlu	Açıklama
id	string (uuid)	Evet
name	string	Evet	@ içermeyen 1-64 yazdırılabilir karakter (en kısa uzunluk 1, en uzun uzunluk 64)
fingerprint	string	Evet	SHA256: ve açık anahtarın base64 özeti (en uzun uzunluk 128)
public_key	string	Evet	(en uzun uzunluk 4096)
labels	string eşlemesi	Evet	En çok 32 anahtar; anahtarlar ve değerler 1-63 karakter (değerler boş olabilir): harf, rakam, ., _, -; harf ya da rakamla başlar ve biter
created	string (date-time)	Evet	RFC 3339, UTC

SshKeyCreateRequest

Alan	Tür	Zorunlu	Açıklama
name	string	Evet	@ içermeyen 1-64 yazdırılabilir karakter (en kısa uzunluk 1, en uzun uzunluk 64)
public_key	string	Evet	ssh-ed25519 ... ya da ssh-rsa ... (OpenSSH biçimi) (en uzun uzunluk 4096)
labels	string eşlemesi	Hayır	En çok 32 anahtar; anahtarlar ve değerler 1-63 karakter (değerler boş olabilir): harf, rakam, ., _, -; harf ya da rakamla başlar ve biter

Server

Alan	Tür	Zorunlu	Açıklama
id	string (uuid)	Evet
name	string	Evet	@ içermeyen 1-64 yazdırılabilir karakter (en kısa uzunluk 1, en uzun uzunluk 64)
status	initializing, starting, running, stopping, off, deleting, rebuilding, migrating, unknown	Evet
created	string (date-time)	Evet	RFC 3339, UTC
server_type	NamedReference	Evet
image	NullableNamedReference	Evet
location	NamedReference	Evet
public_net	object	Evet
public_net.ipv4	null ya da object	Evet
public_net.ipv4.ip	string	Evet	(en uzun uzunluk 15)
public_net.ipv4.dns_ptr	string ya da null	Evet	(en uzun uzunluk 253)
public_net.ipv6	null ya da object	Evet
public_net.ipv6.ip	string	Evet	CIDR gösteriminde IPv4 ya da IPv6 aralığı (en uzun uzunluk 49)
public_net.floating_ips	string (uuid) dizisi	Evet
private_net	object dizisi	Evet
private_net[].network	string (uuid)	Evet
private_net[].ip	string	Evet	(en uzun uzunluk 45)
volumes	string (uuid) dizisi	Evet
firewalls	string (uuid) dizisi	Evet
labels	string eşlemesi	Evet	En çok 32 anahtar; anahtarlar ve değerler 1-63 karakter (değerler boş olabilir): harf, rakam, ., _, -; harf ya da rakamla başlar ve biter
locked	boolean	Evet	Bu sunucuda çalışan bir eylem var
protection	Protection	Evet

ServerCreateRequest

image ve snapshot alanlarından tam olarak biri verilir. Snapshot yalnız kök diskini verir; bu proje ve konumdan olmalı, sunucu tipinin diski snapshot'tan küçük olmamalıdır.

Alan	Tür	Zorunlu	Açıklama
name	string	Evet	@ içermeyen 1-64 yazdırılabilir karakter (en kısa uzunluk 1, en uzun uzunluk 64)
server_type	Reference	Evet
image	Reference	Hayır
snapshot	Reference	Hayır
location	Reference	Evet
ssh_keys	Reference dizisi	Hayır	(en çok öğe 20)
networks	Reference dizisi	Hayır	(en çok öğe 10)
firewalls	Reference dizisi	Hayır	(en çok öğe 5)
user_data	string	Hayır	cloud-init kullanıcı verisi; en çok 24 KiB (UTF-8'de 24576 bayt). Daha uzun değer 422 user_data malformed döner. (en uzun uzunluk 24576)
start_after_create	boolean	Hayır	(varsayılan true)
labels	string eşlemesi	Hayır	En çok 32 anahtar; anahtarlar ve değerler 1-63 karakter (değerler boş olabilir): harf, rakam, ., _, -; harf ya da rakamla başlar ve biter
console_password_hash	string	Hayır	İmajın varsayılan kullanıcısı (Image.default_user) için isteğe bağlı konsol parolası, yalnız SHA-512 crypt özeti olarak: parola Netface'e ulaşmaz. SSH yalnız anahtarla kalır. Özet, sunucunun kullanıcı verisine user_data sonrasında en son eklenir ve sunucu başladıktan sonra kaldırılır; ikisinin toplamı 24576 baytla sınırlıdır. Varsayılan kullanıcısı olmayan imajda ve kendisi MIME multipart olan user_data ile sunulmaz. (desen ^\$6\$(rounds=[1-9][0-9]{3,8}\$)?[./0-9A-Za-z]{1,16}\$[./0-9A-Za-z]{86}$)

Network

Alan	Tür	Zorunlu	Açıklama
id	string (uuid)	Evet
name	string	Evet	@ içermeyen 1-64 yazdırılabilir karakter (en kısa uzunluk 1, en uzun uzunluk 64)
ip_range	string	Evet	CIDR gösteriminde IPv4 ya da IPv6 aralığı (en uzun uzunluk 49)
subnets	object dizisi	Evet
subnets[].ip_range	string	Evet	CIDR gösteriminde IPv4 ya da IPv6 aralığı (en uzun uzunluk 49)
subnets[].gateway	string	Evet	(en uzun uzunluk 45)
servers	string (uuid) dizisi	Evet
labels	string eşlemesi	Evet	En çok 32 anahtar; anahtarlar ve değerler 1-63 karakter (değerler boş olabilir): harf, rakam, ., _, -; harf ya da rakamla başlar ve biter
created	string (date-time)	Evet	RFC 3339, UTC
locked	boolean	Evet
protection	Protection	Evet

NetworkCreateRequest

Alan	Tür	Zorunlu	Açıklama
name	string	Evet	@ içermeyen 1-64 yazdırılabilir karakter (en kısa uzunluk 1, en uzun uzunluk 64)
ip_range	string	Evet	CIDR gösteriminde IPv4 ya da IPv6 aralığı (en uzun uzunluk 49)
subnets	object dizisi	Hayır	(en çok öğe 50)
subnets[].ip_range	string	Evet	CIDR gösteriminde IPv4 ya da IPv6 aralığı (en uzun uzunluk 49)
labels	string eşlemesi	Hayır	En çok 32 anahtar; anahtarlar ve değerler 1-63 karakter (değerler boş olabilir): harf, rakam, ., _, -; harf ya da rakamla başlar ve biter

FirewallRule

Alan	Tür	Zorunlu	Açıklama
direction	in, out	Evet
protocol	tcp, udp, icmp, esp, gre	Evet
port	string ya da null	Evet	80 ya da 1024-2048; icmp, esp ve gre için null (desen ^[0-9]{1,5}(-[0-9]{1,5})?$)
source_ips	string dizisi	Evet	(en çok öğe 100)
destination_ips	string dizisi	Evet	(en çok öğe 100)
description	string ya da null	Evet	(en uzun uzunluk 200)

FirewallTarget

Alan	Tür	Zorunlu	Açıklama
type	server	Evet
server	Reference	Evet

Firewall

Alan	Tür	Zorunlu	Açıklama
id	string (uuid)	Evet
name	string	Evet	@ içermeyen 1-64 yazdırılabilir karakter (en kısa uzunluk 1, en uzun uzunluk 64)
rules	FirewallRule dizisi	Evet	(en çok öğe 50)
applied_to	FirewallTarget dizisi	Evet
labels	string eşlemesi	Evet	En çok 32 anahtar; anahtarlar ve değerler 1-63 karakter (değerler boş olabilir): harf, rakam, ., _, -; harf ya da rakamla başlar ve biter
created	string (date-time)	Evet	RFC 3339, UTC
locked	boolean	Evet

FirewallCreateRequest

Alan	Tür	Zorunlu	Açıklama
name	string	Evet	@ içermeyen 1-64 yazdırılabilir karakter (en kısa uzunluk 1, en uzun uzunluk 64)
rules	object dizisi	Hayır	(en çok öğe 50)
rules[].direction	in, out	Evet
rules[].protocol	tcp, udp, icmp, esp, gre	Evet
rules[].port	string ya da null	Hayır	(desen ^[0-9]{1,5}(-[0-9]{1,5})?$)
rules[].source_ips	string dizisi	Hayır	(en çok öğe 100)
rules[].destination_ips	string dizisi	Hayır	(en çok öğe 100)
rules[].description	string ya da null	Hayır	(en uzun uzunluk 200)
apply_to	FirewallTarget dizisi	Hayır	(en çok öğe 100)
labels	string eşlemesi	Hayır	En çok 32 anahtar; anahtarlar ve değerler 1-63 karakter (değerler boş olabilir): harf, rakam, ., _, -; harf ya da rakamla başlar ve biter

FloatingIp

Alan	Tür	Zorunlu	Açıklama
id	string (uuid)	Evet
name	string	Evet	@ içermeyen 1-64 yazdırılabilir karakter (en kısa uzunluk 1, en uzun uzunluk 64)
description	string ya da null	Evet	(en uzun uzunluk 200)
ip	string	Evet	Adres (IPv4) ya da /64 aralığı (IPv6) (en uzun uzunluk 49)
type	ipv4, ipv6	Evet
server	null ya da string (uuid)	Evet
location	NamedReference	Evet
dns_ptr	object dizisi	Evet
dns_ptr[].ip	string	Evet	(en uzun uzunluk 45)
dns_ptr[].dns_ptr	string	Evet	(en uzun uzunluk 253)
labels	string eşlemesi	Evet	En çok 32 anahtar; anahtarlar ve değerler 1-63 karakter (değerler boş olabilir): harf, rakam, ., _, -; harf ya da rakamla başlar ve biter
created	string (date-time)	Evet	RFC 3339, UTC
blocked	boolean	Evet	Platform tarafından engellendi (kötüye kullanım)
locked	boolean	Evet
protection	Protection	Evet

FloatingIpCreateRequest

Alan	Tür	Zorunlu	Açıklama
type	ipv4, ipv6	Evet
location	Reference	Hayır
server	Reference	Hayır
name	string	Hayır	@ içermeyen 1-64 yazdırılabilir karakter (en kısa uzunluk 1, en uzun uzunluk 64)
description	string	Hayır	(en uzun uzunluk 200)
labels	string eşlemesi	Hayır	En çok 32 anahtar; anahtarlar ve değerler 1-63 karakter (değerler boş olabilir): harf, rakam, ., _, -; harf ya da rakamla başlar ve biter

Volume

Alan	Tür	Zorunlu	Açıklama
id	string (uuid)	Evet
name	string	Evet	@ içermeyen 1-64 yazdırılabilir karakter (en kısa uzunluk 1, en uzun uzunluk 64)
size_gb	integer	Evet	(en az 10, en çok 10000)
status	creating, available	Evet
server	null ya da string (uuid)	Evet
location	NamedReference	Evet
format	ext4, xfs, null	Evet
linux_device	string ya da null	Evet	(en uzun uzunluk 128)
labels	string eşlemesi	Evet	En çok 32 anahtar; anahtarlar ve değerler 1-63 karakter (değerler boş olabilir): harf, rakam, ., _, -; harf ya da rakamla başlar ve biter
created	string (date-time)	Evet	RFC 3339, UTC
locked	boolean	Evet
protection	Protection	Evet

VolumeCreateRequest

Alan	Tür	Zorunlu	Açıklama
name	string	Evet	@ içermeyen 1-64 yazdırılabilir karakter (en kısa uzunluk 1, en uzun uzunluk 64)
size_gb	integer	Evet	(en az 10, en çok 10000)
location	Reference	Hayır
server	Reference	Hayır
automount	boolean	Hayır	(varsayılan false)
format	ext4, xfs	Hayır
labels	string eşlemesi	Hayır	En çok 32 anahtar; anahtarlar ve değerler 1-63 karakter (değerler boş olabilir): harf, rakam, ., _, -; harf ya da rakamla başlar ve biter

Snapshot

Alan	Tür	Zorunlu	Açıklama
id	string (uuid)	Evet
name	string	Evet	@ içermeyen 1-64 yazdırılabilir karakter (en kısa uzunluk 1, en uzun uzunluk 64)
status	creating, available, deleting	Evet
server	NullableNamedReference	Evet
size_gb	integer	Evet	(en az 0)
labels	string eşlemesi	Evet	En çok 32 anahtar; anahtarlar ve değerler 1-63 karakter (değerler boş olabilir): harf, rakam, ., _, -; harf ya da rakamla başlar ve biter
created	string (date-time)	Evet	RFC 3339, UTC
locked	boolean	Evet