Sunucular

Projenin sunucuları

GET /servers

Parametreler

Ad	Yer	Tür	Zorunlu	Açıklama
page	sorgu	integer	Hayır	(en az 1, varsayılan 1)
per_page	sorgu	integer	Hayır	(en az 1, en çok 100, varsayılan 25)
name	sorgu	string	Hayır	Tam ad (en uzun uzunluk 64)
label_selector	sorgu	string	Hayır	key, !key, key==v, key=v, key!=v, key in (a,b), key notin (a,b); virgülle ayrılır (ve) (en uzun uzunluk 1024)
sort	sorgu	string	Hayır	<field>:asc|desc; alanlar id, name, created, status, server_type; varsayılan created:desc (desen ^(id|name|created|status|server_type):(asc|desc)$)
q	sorgu	string	Hayır	Her sözcük, büyük-küçük harf gözetmeden eşleşmelidir: adın ya da genel bir adresin parçası veya label:key, label:key=value (en kısa uzunluk 2, en uzun uzunluk 100)
status	sorgu	initializing, starting, running, stopping, off, deleting, rebuilding, migrating, unknown	Hayır
busy	sorgu	boolean	Hayır	true: çalışan bir eylem ya da geçiş durumu var; false: ikisi de yok

Yanıtlar

Durum	Açıklama
200	Sunucular
401	Geçerli API anahtarı yok
403	Anahtarın kapsamı ya da kuruluşun aboneliği isteğe izin vermiyor (forbidden) veya kota doldu (resource_limit_exceeded)
422	Bir alan eksik ya da hatalı (invalid_input, details.fields) veya bir Idempotency-Key farklı bir istekle yeniden kullanıldı (idempotency_key_mismatch)
429	Anahtarın istek hakkı bitti

Yanıt gövdesi

Alan	Tür	Zorunlu	Açıklama
servers	Server dizisi	Evet
meta	Meta	Evet

Sunucu oluştur

POST /servers

Projenin servers, vcpu, ram ve volume kotasından düşer (403 resource_limit_exceeded).

Parametreler

Ad	Yer	Tür	Zorunlu	Açıklama
Idempotency-Key	başlık	string	Hayır	16-128 görünür ASCII karakter; 24 saat boyunca aynı yanıt döner (desen ^[\x21-\x7e]{16,128}$)

İstek gövdesi

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}$)

Yanıtlar

Durum	Açıklama
201	Sunucu (initializing) ve oluşturma eylemi
401	Geçerli API anahtarı yok
403	Anahtarın kapsamı ya da kuruluşun aboneliği isteğe izin vermiyor (forbidden) veya kota doldu (resource_limit_exceeded)
409	İstek kaynağın durumuyla çakışıyor (conflict) ya da bir Idempotency-Key hâlâ işleniyor (idempotency_in_progress)
422	Bir alan eksik ya da hatalı (invalid_input, details.fields) veya bir Idempotency-Key farklı bir istekle yeniden kullanıldı (idempotency_key_mismatch)
429	Anahtarın istek hakkı bitti

Yanıt gövdesi

Alan	Tür	Zorunlu	Açıklama
server	Server	Evet
action	Action	Evet
root_password	string ya da null	Evet	Ayrılmış alan; bu sürümde null. SSH anahtarıyla ya da konsol parolasıyla giriş yapın.

Tek sunucu

GET /servers/{id}

Parametreler

Ad	Yer	Tür	Zorunlu	Açıklama
id	yol	string (uuid)	Evet

Yanıtlar

Durum	Açıklama
200	Sunucu
401	Geçerli API anahtarı yok
404	Bu projede böyle bir kaynak yok
429	Anahtarın istek hakkı bitti

Yanıt gövdesi

Alan	Tür	Zorunlu	Açıklama
server	Server	Evet

Sunucuyu yeniden adlandır ya da etiketle

PUT /servers/{id}

Parametreler

Ad	Yer	Tür	Zorunlu	Açıklama
id	yol	string (uuid)	Evet

İstek gövdesi

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

Yanıtlar

Durum	Açıklama
200	Sunucu
401	Geçerli API anahtarı yok
403	Anahtarın kapsamı ya da kuruluşun aboneliği isteğe izin vermiyor (forbidden) veya kota doldu (resource_limit_exceeded)
404	Bu projede böyle bir kaynak yok
409	İstek kaynağın durumuyla çakışıyor (conflict) ya da bir Idempotency-Key hâlâ işleniyor (idempotency_in_progress)
422	Bir alan eksik ya da hatalı (invalid_input, details.fields) veya bir Idempotency-Key farklı bir istekle yeniden kullanıldı (idempotency_key_mismatch)
423	Kaynağın çalışan bir eylemi var
429	Anahtarın istek hakkı bitti

Yanıt gövdesi

Alan	Tür	Zorunlu	Açıklama
server	Server	Evet

Sunucuyu sil

DELETE /servers/{id}

protection.delete açıkken reddedilir (409). Eylem başarılı olunca sunucunun kotası serbest kalır.

Parametreler

Ad	Yer	Tür	Zorunlu	Açıklama
id	yol	string (uuid)	Evet

Yanıtlar

Durum	Açıklama
201	Eylem
401	Geçerli API anahtarı yok
403	Anahtarın kapsamı ya da kuruluşun aboneliği isteğe izin vermiyor (forbidden) veya kota doldu (resource_limit_exceeded)
404	Bu projede böyle bir kaynak yok
409	İstek kaynağın durumuyla çakışıyor (conflict) ya da bir Idempotency-Key hâlâ işleniyor (idempotency_in_progress)
423	Kaynağın çalışan bir eylemi var
429	Anahtarın istek hakkı bitti

Yanıt gövdesi

Alan	Tür	Zorunlu	Açıklama
action	Action	Evet

Sunucunun eylemleri

GET /servers/{id}/actions

Parametreler

Ad	Yer	Tür	Zorunlu	Açıklama
id	yol	string (uuid)	Evet
page	sorgu	integer	Hayır	(en az 1, varsayılan 1)
per_page	sorgu	integer	Hayır	(en az 1, en çok 100, varsayılan 25)
status	sorgu	running, success, error	Hayır
sort	sorgu	string	Hayır	<field>:asc|desc; alanlar id, command, status, started, finished; varsayılan started:desc (desen ^(id|command|status|started|finished):(asc|desc)$)

Yanıtlar

Durum	Açıklama
200	Eylemler
401	Geçerli API anahtarı yok
404	Bu projede böyle bir kaynak yok
422	Bir alan eksik ya da hatalı (invalid_input, details.fields) veya bir Idempotency-Key farklı bir istekle yeniden kullanıldı (idempotency_key_mismatch)
429	Anahtarın istek hakkı bitti

Yanıt gövdesi

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

Sunucunun tek eylemi

GET /servers/{id}/actions/{action_id}

Parametreler

Ad	Yer	Tür	Zorunlu	Açıklama
id	yol	string (uuid)	Evet
action_id	yol	string (uuid)	Evet

Yanıtlar

Durum	Açıklama
200	Eylem
401	Geçerli API anahtarı yok
404	Bu projede böyle bir kaynak yok
429	Anahtarın istek hakkı bitti

Yanıt gövdesi

Alan	Tür	Zorunlu	Açıklama
action	Action	Evet

Sunucuyu başlat

POST /servers/{id}/actions/poweron

Parametreler

Ad	Yer	Tür	Zorunlu	Açıklama
id	yol	string (uuid)	Evet
Idempotency-Key	başlık	string	Hayır	16-128 görünür ASCII karakter; 24 saat boyunca aynı yanıt döner (desen ^[\x21-\x7e]{16,128}$)

Yanıtlar

Durum	Açıklama
201	Eylem
401	Geçerli API anahtarı yok
403	Anahtarın kapsamı ya da kuruluşun aboneliği isteğe izin vermiyor (forbidden) veya kota doldu (resource_limit_exceeded)
404	Bu projede böyle bir kaynak yok
409	İstek kaynağın durumuyla çakışıyor (conflict) ya da bir Idempotency-Key hâlâ işleniyor (idempotency_in_progress)
422	Bir alan eksik ya da hatalı (invalid_input, details.fields) veya bir Idempotency-Key farklı bir istekle yeniden kullanıldı (idempotency_key_mismatch)
423	Kaynağın çalışan bir eylemi var
429	Anahtarın istek hakkı bitti

Yanıt gövdesi

Alan	Tür	Zorunlu	Açıklama
action	Action	Evet

Sunucunun gücünü kes (sert)

POST /servers/{id}/actions/poweroff

Parametreler

Ad	Yer	Tür	Zorunlu	Açıklama
id	yol	string (uuid)	Evet
Idempotency-Key	başlık	string	Hayır	16-128 görünür ASCII karakter; 24 saat boyunca aynı yanıt döner (desen ^[\x21-\x7e]{16,128}$)

Yanıtlar

Durum	Açıklama
201	Eylem
401	Geçerli API anahtarı yok
403	Anahtarın kapsamı ya da kuruluşun aboneliği isteğe izin vermiyor (forbidden) veya kota doldu (resource_limit_exceeded)
404	Bu projede böyle bir kaynak yok
409	İstek kaynağın durumuyla çakışıyor (conflict) ya da bir Idempotency-Key hâlâ işleniyor (idempotency_in_progress)
422	Bir alan eksik ya da hatalı (invalid_input, details.fields) veya bir Idempotency-Key farklı bir istekle yeniden kullanıldı (idempotency_key_mismatch)
423	Kaynağın çalışan bir eylemi var
429	Anahtarın istek hakkı bitti

Yanıt gövdesi

Alan	Tür	Zorunlu	Açıklama
action	Action	Evet

Sunucuyu işletim sistemiyle kapat (ACPI)

POST /servers/{id}/actions/shutdown

Parametreler

Ad	Yer	Tür	Zorunlu	Açıklama
id	yol	string (uuid)	Evet
Idempotency-Key	başlık	string	Hayır	16-128 görünür ASCII karakter; 24 saat boyunca aynı yanıt döner (desen ^[\x21-\x7e]{16,128}$)

Yanıtlar

Durum	Açıklama
201	Eylem
401	Geçerli API anahtarı yok
403	Anahtarın kapsamı ya da kuruluşun aboneliği isteğe izin vermiyor (forbidden) veya kota doldu (resource_limit_exceeded)
404	Bu projede böyle bir kaynak yok
409	İstek kaynağın durumuyla çakışıyor (conflict) ya da bir Idempotency-Key hâlâ işleniyor (idempotency_in_progress)
422	Bir alan eksik ya da hatalı (invalid_input, details.fields) veya bir Idempotency-Key farklı bir istekle yeniden kullanıldı (idempotency_key_mismatch)
423	Kaynağın çalışan bir eylemi var
429	Anahtarın istek hakkı bitti

Yanıt gövdesi

Alan	Tür	Zorunlu	Açıklama
action	Action	Evet

Sunucuyu yeniden başlat (ACPI)

POST /servers/{id}/actions/reboot

Parametreler

Ad	Yer	Tür	Zorunlu	Açıklama
id	yol	string (uuid)	Evet
Idempotency-Key	başlık	string	Hayır	16-128 görünür ASCII karakter; 24 saat boyunca aynı yanıt döner (desen ^[\x21-\x7e]{16,128}$)

Yanıtlar

Durum	Açıklama
201	Eylem
401	Geçerli API anahtarı yok
403	Anahtarın kapsamı ya da kuruluşun aboneliği isteğe izin vermiyor (forbidden) veya kota doldu (resource_limit_exceeded)
404	Bu projede böyle bir kaynak yok
409	İstek kaynağın durumuyla çakışıyor (conflict) ya da bir Idempotency-Key hâlâ işleniyor (idempotency_in_progress)
422	Bir alan eksik ya da hatalı (invalid_input, details.fields) veya bir Idempotency-Key farklı bir istekle yeniden kullanıldı (idempotency_key_mismatch)
423	Kaynağın çalışan bir eylemi var
429	Anahtarın istek hakkı bitti

Yanıt gövdesi

Alan	Tür	Zorunlu	Açıklama
action	Action	Evet

Sunucuyu sıfırla (sert)

POST /servers/{id}/actions/reset

Parametreler

Ad	Yer	Tür	Zorunlu	Açıklama
id	yol	string (uuid)	Evet
Idempotency-Key	başlık	string	Hayır	16-128 görünür ASCII karakter; 24 saat boyunca aynı yanıt döner (desen ^[\x21-\x7e]{16,128}$)

Yanıtlar

Durum	Açıklama
201	Eylem
401	Geçerli API anahtarı yok
403	Anahtarın kapsamı ya da kuruluşun aboneliği isteğe izin vermiyor (forbidden) veya kota doldu (resource_limit_exceeded)
404	Bu projede böyle bir kaynak yok
409	İstek kaynağın durumuyla çakışıyor (conflict) ya da bir Idempotency-Key hâlâ işleniyor (idempotency_in_progress)
422	Bir alan eksik ya da hatalı (invalid_input, details.fields) veya bir Idempotency-Key farklı bir istekle yeniden kullanıldı (idempotency_key_mismatch)
423	Kaynağın çalışan bir eylemi var
429	Anahtarın istek hakkı bitti

Yanıt gövdesi

Alan	Tür	Zorunlu	Açıklama
action	Action	Evet

Sunucu tipini değiştir

POST /servers/{id}/actions/resize

Sunucu off olmalıdır. vcpu, ram ve volume kotasından düşer.

Parametreler

Ad	Yer	Tür	Zorunlu	Açıklama
id	yol	string (uuid)	Evet
Idempotency-Key	başlık	string	Hayır	16-128 görünür ASCII karakter; 24 saat boyunca aynı yanıt döner (desen ^[\x21-\x7e]{16,128}$)

İstek gövdesi

Alan	Tür	Zorunlu	Açıklama
server_type	Reference	Evet
upgrade_disk	boolean	Hayır	(varsayılan false)

Yanıtlar

Durum	Açıklama
201	Eylem
401	Geçerli API anahtarı yok
403	Anahtarın kapsamı ya da kuruluşun aboneliği isteğe izin vermiyor (forbidden) veya kota doldu (resource_limit_exceeded)
404	Bu projede böyle bir kaynak yok
409	İstek kaynağın durumuyla çakışıyor (conflict) ya da bir Idempotency-Key hâlâ işleniyor (idempotency_in_progress)
422	Bir alan eksik ya da hatalı (invalid_input, details.fields) veya bir Idempotency-Key farklı bir istekle yeniden kullanıldı (idempotency_key_mismatch)
423	Kaynağın çalışan bir eylemi var
429	Anahtarın istek hakkı bitti

Yanıt gövdesi

Alan	Tür	Zorunlu	Açıklama
action	Action	Evet

Sunucuyu bir imajdan ya da snapshot'tan yeniden kur

POST /servers/{id}/actions/rebuild

image ve snapshot alanlarından tam olarak biri verilir. Kök diskteki her şey değiştirilir; başarısız bir yeniden kurma diski değiştirmiş olabilir (eylem o zaman resolution_required ile biter).

Parametreler

Ad	Yer	Tür	Zorunlu	Açıklama
id	yol	string (uuid)	Evet
Idempotency-Key	başlık	string	Hayır	16-128 görünür ASCII karakter; 24 saat boyunca aynı yanıt döner (desen ^[\x21-\x7e]{16,128}$)

İstek gövdesi

Alan	Tür	Zorunlu	Açıklama
image	Reference	Hayır
snapshot	Reference	Hayır
console_password_hash	string	Hayır	İmajın varsayılan kullanıcısı için isteğe bağlı yeni konsol parolası; yalnız SHA-512 crypt özeti olarak verilir. Daha önce belirlenen parola yeniden kurmaya geçmez. Özet, sunucu başladıktan sonra kaldırılır. snapshot ile ve varsayılan kullanıcısı olmayan imajda sunulmaz; user_data'sı buna uygun olmayan sunucuda (MIME çok parçalı ya da toplamı 24576 baytı aşıyorsa) eylem provider_refused ile biter, disk değişmez. (desen ^\$6\$(rounds=[1-9][0-9]{3,8}\$)?[./0-9A-Za-z]{1,16}\$[./0-9A-Za-z]{86}$)

Yanıtlar

Durum	Açıklama
201	Eylem
401	Geçerli API anahtarı yok
403	Anahtarın kapsamı ya da kuruluşun aboneliği isteğe izin vermiyor (forbidden) veya kota doldu (resource_limit_exceeded)
404	Bu projede böyle bir kaynak yok
409	İstek kaynağın durumuyla çakışıyor (conflict) ya da bir Idempotency-Key hâlâ işleniyor (idempotency_in_progress)
422	Bir alan eksik ya da hatalı (invalid_input, details.fields) veya bir Idempotency-Key farklı bir istekle yeniden kullanıldı (idempotency_key_mismatch)
423	Kaynağın çalışan bir eylemi var
429	Anahtarın istek hakkı bitti

Yanıt gövdesi

Alan	Tür	Zorunlu	Açıklama
action	Action	Evet

Sunucunun diskinin snapshot'ını al

POST /servers/{id}/actions/create_snapshot

snapshot kotasından düşer.

Parametreler

Ad	Yer	Tür	Zorunlu	Açıklama
id	yol	string (uuid)	Evet
Idempotency-Key	başlık	string	Hayır	16-128 görünür ASCII karakter; 24 saat boyunca aynı yanıt döner (desen ^[\x21-\x7e]{16,128}$)

İstek gövdesi

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)
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

Yanıtlar

Durum	Açıklama
201	Snapshot (creating) ve eylemi
401	Geçerli API anahtarı yok
403	Anahtarın kapsamı ya da kuruluşun aboneliği isteğe izin vermiyor (forbidden) veya kota doldu (resource_limit_exceeded)
404	Bu projede böyle bir kaynak yok
409	İstek kaynağın durumuyla çakışıyor (conflict) ya da bir Idempotency-Key hâlâ işleniyor (idempotency_in_progress)
422	Bir alan eksik ya da hatalı (invalid_input, details.fields) veya bir Idempotency-Key farklı bir istekle yeniden kullanıldı (idempotency_key_mismatch)
423	Kaynağın çalışan bir eylemi var
429	Anahtarın istek hakkı bitti

Yanıt gövdesi

Alan	Tür	Zorunlu	Açıklama
snapshot	Snapshot	Evet
action	Action	Evet

Sunucuyu özel ağa bağla

POST /servers/{id}/actions/attach_to_network

Parametreler

Ad	Yer	Tür	Zorunlu	Açıklama
id	yol	string (uuid)	Evet
Idempotency-Key	başlık	string	Hayır	16-128 görünür ASCII karakter; 24 saat boyunca aynı yanıt döner (desen ^[\x21-\x7e]{16,128}$)

İstek gövdesi

Alan	Tür	Zorunlu	Açıklama
network	Reference	Evet
ip	string	Hayır	Ağın alt ağından boş bir adres; verilmezse platform seçer (en uzun uzunluk 45)

Yanıtlar

Durum	Açıklama
201	Eylem
401	Geçerli API anahtarı yok
403	Anahtarın kapsamı ya da kuruluşun aboneliği isteğe izin vermiyor (forbidden) veya kota doldu (resource_limit_exceeded)
404	Bu projede böyle bir kaynak yok
409	İstek kaynağın durumuyla çakışıyor (conflict) ya da bir Idempotency-Key hâlâ işleniyor (idempotency_in_progress)
422	Bir alan eksik ya da hatalı (invalid_input, details.fields) veya bir Idempotency-Key farklı bir istekle yeniden kullanıldı (idempotency_key_mismatch)
423	Kaynağın çalışan bir eylemi var
429	Anahtarın istek hakkı bitti

Yanıt gövdesi

Alan	Tür	Zorunlu	Açıklama
action	Action	Evet

Sunucuyu özel ağdan ayır

POST /servers/{id}/actions/detach_from_network

Parametreler

Ad	Yer	Tür	Zorunlu	Açıklama
id	yol	string (uuid)	Evet
Idempotency-Key	başlık	string	Hayır	16-128 görünür ASCII karakter; 24 saat boyunca aynı yanıt döner (desen ^[\x21-\x7e]{16,128}$)

İstek gövdesi

Alan	Tür	Zorunlu	Açıklama
network	Reference	Evet

Yanıtlar

Durum	Açıklama
201	Eylem
401	Geçerli API anahtarı yok
403	Anahtarın kapsamı ya da kuruluşun aboneliği isteğe izin vermiyor (forbidden) veya kota doldu (resource_limit_exceeded)
404	Bu projede böyle bir kaynak yok
409	İstek kaynağın durumuyla çakışıyor (conflict) ya da bir Idempotency-Key hâlâ işleniyor (idempotency_in_progress)
422	Bir alan eksik ya da hatalı (invalid_input, details.fields) veya bir Idempotency-Key farklı bir istekle yeniden kullanıldı (idempotency_key_mismatch)
423	Kaynağın çalışan bir eylemi var
429	Anahtarın istek hakkı bitti

Yanıt gövdesi

Alan	Tür	Zorunlu	Açıklama
action	Action	Evet

Sunucuyu silinmeye karşı koru

POST /servers/{id}/actions/change_protection

Parametreler

Ad	Yer	Tür	Zorunlu	Açıklama
id	yol	string (uuid)	Evet
Idempotency-Key	başlık	string	Hayır	16-128 görünür ASCII karakter; 24 saat boyunca aynı yanıt döner (desen ^[\x21-\x7e]{16,128}$)

İstek gövdesi

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

Yanıtlar

Durum	Açıklama
201	Eylem
401	Geçerli API anahtarı yok
403	Anahtarın kapsamı ya da kuruluşun aboneliği isteğe izin vermiyor (forbidden) veya kota doldu (resource_limit_exceeded)
404	Bu projede böyle bir kaynak yok
409	İstek kaynağın durumuyla çakışıyor (conflict) ya da bir Idempotency-Key hâlâ işleniyor (idempotency_in_progress)
422	Bir alan eksik ya da hatalı (invalid_input, details.fields) veya bir Idempotency-Key farklı bir istekle yeniden kullanıldı (idempotency_key_mismatch)
423	Kaynağın çalışan bir eylemi var
429	Anahtarın istek hakkı bitti

Yanıt gövdesi

Alan	Tür	Zorunlu	Açıklama
action	Action	Evet

Çalışan bir sunucunun kısa ömürlü konsol bağlantısı

POST /servers/{id}/actions/request_console

Yalnız running durumundaki sunucu (409 conflict, details.reason = invalid_state) ve yalnız read_write anahtar ya da kişi; abonelik kısıtlıyken de geçerlidir. Gövde ve Idempotency-Key gönderilmez (422 invalid_input): bağlantı bir kez, yalnız isteyene döner ve yineleme için saklanmaz. Bağlantıyı açmak sunucunun ekranına ve klavyesine tam erişim verir; expires_at anına kadar gizli değer gibi saklayın (en çok 60 saniye; bağlantı bir kez çalışır). Bağlantı birkaç saniye içinde hazır olmazsa istek Retry-After ile 503 unavailable döner ve bağlantı sonradan verilmez; yeniden isteyin. Konsol sunmayan konum details.reason = not_offered ve details.action ile 409 conflict döner (eylem not_offered hata koduyla biter); yeniden istemek sonucu değiştirmez. Anahtarın sınırına ek olarak sunucu ve isteyen başına bir konsol sınırı uygulanır (429).

Parametreler

Ad	Yer	Tür	Zorunlu	Açıklama
id	yol	string (uuid)	Evet

Yanıtlar

Durum	Açıklama
201	Biten eylem ve bağlantı
401	Geçerli API anahtarı yok
403	Anahtarın kapsamı ya da kuruluşun aboneliği isteğe izin vermiyor (forbidden) veya kota doldu (resource_limit_exceeded)
404	Bu projede böyle bir kaynak yok
409	İstek kaynağın durumuyla çakışıyor (conflict) ya da bir Idempotency-Key hâlâ işleniyor (idempotency_in_progress)
422	Bir alan eksik ya da hatalı (invalid_input, details.fields) veya bir Idempotency-Key farklı bir istekle yeniden kullanıldı (idempotency_key_mismatch)
423	Kaynağın çalışan bir eylemi var
429	Anahtarın istek hakkı bitti
503	Hizmet zamanında yanıt veremedi (unavailable); Retry-After süresinden sonra yeniden isteyin

Yanıt gövdesi

Alan	Tür	Zorunlu	Açıklama
action	Action	Evet
console	object	Evet
console.url	string (uri)	Evet	Konsolu tarayıcıda açar
console.expires_at	string (date-time)	Evet