Güvenlik grupları

Projenin güvenlik grupları

GET /firewalls

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 bir parçası veya label:key, label:key=value (en kısa uzunluk 2, en uzun uzunluk 100)

Yanıtlar

Durum	Açıklama
200	Güvenlik grupları
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
firewalls	Firewall dizisi	Evet
meta	Meta	Evet

Güvenlik grubu oluştur

POST /firewalls

Gelen trafik varsayılan olarak kapalıdır; istek neyin açık olacağını listeler.

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

Yanıtlar

Durum	Açıklama
201	Güvenlik grubu ve onu uygulayan eylemler
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
firewall	Firewall	Evet
actions	Action dizisi	Evet

Tek güvenlik grubu

GET /firewalls/{id}

Parametreler

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

Yanıtlar

Durum	Açıklama
200	Güvenlik grubu
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
firewall	Firewall	Evet

Güvenlik grubunu yeniden adlandır ya da etiketle

PUT /firewalls/{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	Güvenlik grubu
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
firewall	Firewall	Evet

Güvenlik grubunu sil

DELETE /firewalls/{id}

Bir sunucuya uygulanmışken reddedilir (409).

Parametreler

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

Yanıtlar

Durum	Açıklama
204	Silindi
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

Güvenlik grubunun eylemleri

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

Güvenlik grubunun tek eylemi

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

Güvenlik grubunun kurallarını değiştir

POST /firewalls/{id}/actions/set_rules

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
rules	FirewallRule dizisi	Evet	(en çok öğe 50)

Yanıtlar

Durum	Açıklama
201	Etkilenen her kaynak için bir 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
actions	Action dizisi	Evet

Güvenlik grubunu sunuculara uygula

POST /firewalls/{id}/actions/apply_to_resources

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
apply_to	FirewallTarget dizisi	Evet	(en az öğe 1, en çok öğe 100)

Yanıtlar

Durum	Açıklama
201	Etkilenen her kaynak için bir 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
actions	Action dizisi	Evet

Güvenlik grubunu sunuculardan kaldır

POST /firewalls/{id}/actions/remove_from_resources

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
remove_from	FirewallTarget dizisi	Evet	(en az öğe 1, en çok öğe 100)

Yanıtlar

Durum	Açıklama
201	Etkilenen her kaynak için bir 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
actions	Action dizisi	Evet