Ağlar

Projenin özel ağları

GET /networks

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; varsayılan created:desc (desen ^(id|name|created):(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 IP aralığının bir parçası veya label:key, label:key=value (en kısa uzunluk 2, en uzun uzunluk 100)

Yanıtlar

Durum	Açıklama
200	Ağlar
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
networks	Network dizisi	Evet
meta	Meta	Evet

Özel ağ oluştur

POST /networks

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

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

Yanıtlar

Durum	Açıklama
201	Ağ 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)
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
network	Network	Evet
action	Action	Evet

Tek ağ

GET /networks/{id}

Parametreler

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

Yanıtlar

Durum	Açıklama
200	Ağ
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
network	Network	Evet

Ağı yeniden adlandır ya da etiketle

PUT /networks/{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	Ağ
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
network	Network	Evet

Ağı sil

DELETE /networks/{id}

Bağlı sunucu varken ya da protection.delete açıkken reddedilir (409).

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

Ağın eylemleri

GET /networks/{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

Ağın tek eylemi

GET /networks/{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

Alt ağ ekle

POST /networks/{id}/actions/add_subnet

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
ip_range	string	Evet	CIDR gösteriminde IPv4 ya da IPv6 aralığı (en uzun uzunluk 49)

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

Boş alt ağı kaldır

POST /networks/{id}/actions/delete_subnet

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
ip_range	string	Evet	CIDR gösteriminde IPv4 ya da IPv6 aralığı (en uzun uzunluk 49)

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

Ağı silinmeye karşı koru

POST /networks/{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