maestropanel api · 2013. 9. 27. · maestropanel rest* api, domain, bayi (reseller) ve sunucu...

MaestroPanel APIv1.1

[email protected]

1MaestroPanel

New Generation Web Hosting Control Panel

İçindekiler

● MaestroPanel API○ Temel URL○ Geri Dönüş Tipleri○ Şema (Schema)○ API Key Üretimi

● Eylemler○ Domain Eylemleri

■ Web● Create● Delete● Stop● Start● Password● AddDomainAlias● AddSubDomain● ChangeIpAddr● GetList● GetLimits● SetLimits● SetWriteAccess● Forwarding● ChangeReseller

●■ Mail

● AddMailBox● DeleteMailBox● ChangeMailBoxPassword● ChangeMailBoxQuota● GetMailList

■ Database● AddDatabase● DeleteDatabase● AddDatabaseUser

■ Ftp● AddFtpAccount● DeleteFtpAccount● ChangeFtpPassword

2MaestroPanel


https://docs.google.com/document/d/sCzCm9bkKCgUujRn6-yjkIA/headless/print#bookmark=id.er7402a0xh8chttps://docs.google.com/document/d/sCzCm9bkKCgUujRn6-yjkIA/headless/print#bookmark=id.1ydlnyyhf35zhttps://docs.google.com/document/d/sCzCm9bkKCgUujRn6-yjkIA/headless/print#bookmark=id.fbphxtj1t95qhttps://docs.google.com/document/d/sCzCm9bkKCgUujRn6-yjkIA/headless/print#bookmark=id.vsbe5lj88qj4https://docs.google.com/document/d/sCzCm9bkKCgUujRn6-yjkIA/headless/print#bookmark=id.5nwxir1b4gtghttps://docs.google.com/document/d/sCzCm9bkKCgUujRn6-yjkIA/headless/print#bookmark=id.wmbwrt3l8t79https://docs.google.com/document/d/sCzCm9bkKCgUujRn6-yjkIA/headless/print#bookmark=id.4zqcgol6v4rthttps://docs.google.com/document/d/sCzCm9bkKCgUujRn6-yjkIA/headless/print#bookmark=id.qg2hhwxs548ehttps://docs.google.com/document/d/sCzCm9bkKCgUujRn6-yjkIA/headless/print#bookmark=id.m6os08fpd7jlhttps://docs.google.com/document/d/sCzCm9bkKCgUujRn6-yjkIA/headless/print#bookmark=id.pe11i9zaavixhttps://docs.google.com/document/d/sCzCm9bkKCgUujRn6-yjkIA/headless/print#bookmark=id.n1b0dy2ck2rdhttps://docs.google.com/document/d/sCzCm9bkKCgUujRn6-yjkIA/headless/print#bookmark=id.xhwfxulg3x5hhttps://docs.google.com/document/d/sCzCm9bkKCgUujRn6-yjkIA/headless/print#bookmark=id.onl6yevvi2z7https://docs.google.com/document/d/sCzCm9bkKCgUujRn6-yjkIA/headless/print#bookmark=id.ug9kjby8uptihttps://docs.google.com/document/d/sCzCm9bkKCgUujRn6-yjkIA/headless/print#bookmark=id.wa8hcucybbc5https://docs.google.com/document/d/sCzCm9bkKCgUujRn6-yjkIA/headless/print#bookmark=id.cm024phq4kb0https://docs.google.com/document/d/sCzCm9bkKCgUujRn6-yjkIA/headless/print#bookmark=id.q45452sjvhwvhttps://docs.google.com/document/d/sCzCm9bkKCgUujRn6-yjkIA/headless/print#bookmark=id.5siatpg2baokhttps://docs.google.com/document/d/sCzCm9bkKCgUujRn6-yjkIA/headless/print#bookmark=id.32i30kop88vqhttps://docs.google.com/document/d/sCzCm9bkKCgUujRn6-yjkIA/headless/print#bookmark=id.e9c4x9338qa2https://docs.google.com/document/d/sCzCm9bkKCgUujRn6-yjkIA/headless/print#bookmark=id.yzxl0f9adnu4https://docs.google.com/document/d/sCzCm9bkKCgUujRn6-yjkIA/headless/print#bookmark=id.8jt20g5t89kbhttps://docs.google.com/document/d/sCzCm9bkKCgUujRn6-yjkIA/headless/print#bookmark=id.pj25kp8y4h6rhttps://docs.google.com/document/d/sCzCm9bkKCgUujRn6-yjkIA/headless/print#bookmark=id.f2og2msehn5uhttps://docs.google.com/document/d/sCzCm9bkKCgUujRn6-yjkIA/headless/print#bookmark=id.x7g9wa00djzhttps://docs.google.com/document/d/sCzCm9bkKCgUujRn6-yjkIA/headless/print#bookmark=id.7ruc0pmd0ehbhttps://docs.google.com/document/d/sCzCm9bkKCgUujRn6-yjkIA/headless/print#bookmark=id.jn3ffc48f23jhttps://docs.google.com/document/d/sCzCm9bkKCgUujRn6-yjkIA/headless/print#bookmark=id.x18xsymwk4i4https://docs.google.com/document/d/sCzCm9bkKCgUujRn6-yjkIA/headless/print#bookmark=id.w5oms9x7gg16

■ Dns● SetDnsZone● AddDnsRecord● DeleteDnsRecord

○ Bayi (Reseller) Eylemleri■ Create■ Stop■ Start■ ChangePassword■ AddDomain■ DeleteDomain■ GetDomains■ GetResellers■ SetLimits

○ Kullanıcı (User) Eylemleri■ Whoami■ LogOff

● Örnek Kodlar○ C# ile API Kullanımı○ PHP ile API Kullanımı○ PowerShell ile API Kullanımı

3MaestroPanel


https://docs.google.com/document/d/sCzCm9bkKCgUujRn6-yjkIA/headless/print#bookmark=id.oswpslpmzfwxhttps://docs.google.com/document/d/sCzCm9bkKCgUujRn6-yjkIA/headless/print#bookmark=id.kclpywo8akyvhttps://docs.google.com/document/d/sCzCm9bkKCgUujRn6-yjkIA/headless/print#bookmark=id.iht2rqlbrtl6https://docs.google.com/document/d/sCzCm9bkKCgUujRn6-yjkIA/headless/print#bookmark=id.py6rsjx4fjclhttps://docs.google.com/document/d/sCzCm9bkKCgUujRn6-yjkIA/headless/print#bookmark=id.ry48qy2yvxwihttps://docs.google.com/document/d/sCzCm9bkKCgUujRn6-yjkIA/headless/print#bookmark=id.e9f9d7kwe53whttps://docs.google.com/document/d/sCzCm9bkKCgUujRn6-yjkIA/headless/print#bookmark=id.ndxg1pmhv3jqhttps://docs.google.com/document/d/sCzCm9bkKCgUujRn6-yjkIA/headless/print#bookmark=id.fbjlkxjn0je2https://docs.google.com/document/d/sCzCm9bkKCgUujRn6-yjkIA/headless/print#bookmark=id.pnmefpk1l3g5https://docs.google.com/document/d/sCzCm9bkKCgUujRn6-yjkIA/headless/print#bookmark=id.o70uotkjae3mhttps://docs.google.com/document/d/sCzCm9bkKCgUujRn6-yjkIA/headless/print#bookmark=id.12knuv3zfyighttps://docs.google.com/document/d/sCzCm9bkKCgUujRn6-yjkIA/headless/print#bookmark=id.o1ppfcy0e30shttps://docs.google.com/document/d/sCzCm9bkKCgUujRn6-yjkIA/headless/print#bookmark=id.h4ipxv9zxt3uhttps://docs.google.com/document/d/sCzCm9bkKCgUujRn6-yjkIA/headless/print#bookmark=id.ycdy4gmkit2khttps://docs.google.com/document/d/sCzCm9bkKCgUujRn6-yjkIA/headless/print#bookmark=id.piws24hk2txchttps://docs.google.com/document/d/sCzCm9bkKCgUujRn6-yjkIA/headless/print#bookmark=id.l9ep8u960xrhhttps://docs.google.com/document/d/sCzCm9bkKCgUujRn6-yjkIA/headless/print#bookmark=id.7l43sw6e1dft

MaestroPanel REST Web Service ArayüzüMaestroPanel REST* API, Domain, Bayi (Reseller) ve Sunucu özelliklerine HTTP üzerindenbelirli kurallar çerçevesinden erişebileceğiniz bir programlama arayüzüdür.

Api, REST (Representational State Transfer) olarak çalıştığından herhangi bir programlamadiline ihtiyacınız olmadan herhangi bir HTTP istemcisi ile (örneğin browser'ınız) rahatlıklakomutlar gönderebilir ve kendi geliştirdiğiniz yazılımlarla erişebilirsiniz.

MaestroPanel API kendi iş akışınıza MaestroPanel'i entegre etmenizi kolayca sağlamaktadır.

*REST kavramı ile ilgili daha detaylı bilgi almak için:http://en.wikipedia.org/wiki/Representational_state_transfer

Temel URL (Base URL)

MaestroPane API'de tüm komutları göndereceğiniz adres aşağıdaki gibidir.

http://[DOMAIN]:[PORT]/Api/[VERSION]

Örnek:

http://contoso.com:9715/Api/v1

Yukarıdaki adresi açıklamak gerekirse;

● DomainIP adresi, yine bu IP adresine tanımlanmış bir alanadı veya yerel bilgisayardan istektebulunuyorsanız localhost olabilir.

● PortMaestroPanel'in Web Management Servisi için varsayılan portu 9715'dir. API'ye ulaşırkende bu port'u kullanabilirsiniz.

● VersionMaestroPanel API'nin versiyonunu belirler, API zaman içerisinde yeni özelliklerineklenmesi ile birlikte genişler. Bu özelliklerin yönetilmesi ve çeşitli platformlar tarafındanAPI uyumluluklarının düzenlenmesi için API versiyonu eklenmiştir.

4MaestroPanel


http://www.google.com/url?q=http%3A%2F%2Fen.wikipedia.org%2Fwiki%2FRepresentational_state_transfer&sa=D&sntz=1&usg=AFQjCNGjE-4kBxWsikyQQROU-v0spxA64w

Global Parametreler

Global parametreler her istekte dikkate alınan parametrelerdir. Bu parametreler belirtilmediğitaktirde API varsayılan değerlerle çalışır

Parameter Değer (Value)

format Varsayılan Değer: XmlAlabileceği Değerler: Xml, JsonTip: String

format parametresi MaestroPanel API'nin hangi tiptecevap vereceğini belirler. Xml ve Json tipinde cevapverebilir.

* Büyük küçük harf fark etmez

suppress_response_codes Varsayılan Değer: trueAlabileceği Değerler: true, falseTip: Boolean

MaestroPanel API'nin http durum kodu ile cevap vermesinipasivize eder veya aktif eder. False değeri verildiğinde HTTPdurum kodlarını verilen cevap içinde alabilirsiniz.

* Büyük küçük harf fark etmez

Örnek Kullanım:

Aşağıdaki istek sahip olduğumuz API anahtarının kullanıcı detaylarını Json formatı ile vermektedir.http response kodları suppress edilmiştir yani baskılanmıştır. Bunun anlamı sunucuda herhangibir hata olduğunda bile web server http durum kodunu 200 olarak (başarılı) döndürür. Programcıgerçek durum koduna ulaşmak için Details objesinin StatusCode özelliğine erişmelidir.

İstek

GEThttp://contoso.com:9715/Api/v1/Api/v1/User/Whoami?key=1_9bd61d3da73040c3a8b214afb25e4656&format=JSON&suppress_response_codes=true

5MaestroPanel


Cevap

{ "Details" : { "Email" : "[email protected]", "FirstName" : "Admin", "Id" : 1, "LastName" : "Panel", "Organization" : "MaestroPanel", "Status" : 1, "Type" : 0, "Username" : "admin" }, "ErrorCode" : 0, "Message" : "", "StatusCode" : 200}

HTTP ve HTTPS

MaestroPanel API şu anda HTTP ve HTTPS protokolleri üzerinden haberleşmeniz mümkündür.Versiyon 1.0'dan itibaren veri güvenliğini sağlamak için sadece HTTPS protokolünün devreyealınması planlanmaktadır.

Geri Dönüş Tipleri (Temsil Representation)

MaestroPanel API'nin geri dönüş tipleri XML veya JSON olarak opsiyonel şekildeayarlanabilmektedir. Bu ayar yukarıda bahsedilen format global parametresi ile API'yebelirtilmektedir. Geri dönüş şeması her eylemde sabit gelecek şekilde oluşturulup istemcinineylem bilgisini bu şemaya göre alması kolay bir şekilde sağlanmaktadır.

Şema (Schema)

API'de istenen eylemin geri dönüş yapısı şeması bir wrapper ile sarmalanmıştır ve geri dönüşşemasının Details alanında her eylemin tipine göre değişiklik göstermektedir. Aşağıda Detailsalanı boş olan bir geri dönüş şemasını Xml ve Json formatında bulabilirsiniz.

6MaestroPanel


XML Reply Schema

200 0

Json Reply Schema

{ "Details" : null, "ErrorCode" : 0, "Message" : "", "StatusCode" : 200}

Şema (Schema) Alanları

Aşağıda istemcinin istemiş olduğu eylemin geri dönüş yapısının açıklamalarını bulabilirsiniz.

Alan Açıklama

Result Kök (Root) alan.API Geri dönüş değerini içinde barındırırSchema : SabitTip: Result

ErrorCode İstenilen eylemin başarılı olup olmadığının bilgisini tutar. 0 (sıfır) ise istenileneylem başarılı sayılır.Sıfırdan farklı ise hata ile ilgili "Message" kısmında bilgilendirme yapılır.

Sık karşılaşılan geri dönüş kodları aşağıda tablo halinde verilmiştir.

Geri Dönüş Kodları

Code Açıklama

1 İşlem başarısız. Genel Hata. Bu hata kodunda detay görmek için

7MaestroPanel


Details alanına bakılabilir.

Constant: DOMAIN_OPERATION_ONERROR

0 İşlem başarılı.

Constant: DOMAIN_OPERATION_SUCCESS

5 Kimlik doğrulama işlemi geçersiz.

Constant: API_AUTHENTICATION_ERROR

6 Beklenen parametre eksik veya boş.

Constant: API_PARAMETER_ERROR

7 İstenilen eylemin gerçekleşmesi için kullanıcı haklarıyetersiz.

Constant: API_ACCESS_DENIED

8 İstenilen domain adı yanlış veya domain sistemde yok

Constant: API_DOMAIN_NOT_FOUND

Schema: SabitTip: Integer

Message Geri dönüş değeri hakkında özet açıklamalar içeren alandır. Eylemindurumunu net bir şekilde açıklanmasına yardımcı olur.

Schema: SabitTip: String

Details Bu alan bilgilendirme amaçlıdır ve istenildiğinde kullanılabilir. İstenileneylemin alt esas işlem sonucunu tutar.

Bu alan yapısı sabit olmakla birlikte her istek için içeriği farklı olabilir.Domain Planına göre farklılık gösterebilir.

Schema: DinamikTip: dynamic

8MaestroPanel


API Key Üretimi

MaestroPanel API Admin ve Bayi (Reseller) seviyesinde ki kullanıcılar için tanımlanabilmektedir.Kullanıcıların API eylemlerine erişebilmeleri için API Key'e sahip olmalıdırlar.

Bayiler İçin API Anahtarı TanımlamasıMaestroPanel'e Admin hakları ile giriş yaptıktan sonra;

1. Bayiler (Reseller)2. (Bayi listesinden ilgili bayi ismine tıklanır)3. İzinler (Permissions)4. Api Anahtarı Oluştur (Generate Api Key)"

menüleri izleyerek yaratılması sağlanır.

Yöneticiler için API Anahtarı TanımlanmasıMaestroPanel'e Admin hakları ile giriş yaptıktan sonra.

1. Profil2. Api Anahtarı Oluştur (Generate Api Key)

menüleri izlenebilir.

Örnek API Key:1_e9f1131d7cc44fd8c5df1aca0155937

9MaestroPanel


Kullanılabilir Eylemler (Action/Verb)MaestroPanel API'de Domain, Bayi ve Sunucu seviyesinde eylemler gerçekleştirebilirsiniz. Bueylemlerin çalışması, Api Key'in tanımlı olduğu kullanıcı haklarının izin verdiği çerçevedeplanlanmıştır.

Aşağıda üç temel özellikte kullanılabilen eylemler, ve bu eylemlere nasıl istekte bulunabilineceği,geri dönüş değerleri ile birlikte verilmiştir.

10MaestroPanel


Domain EylemleriDomain/Create

MaestroPanel üzerinde yeni bir domain (hosting) oluşturmak için kullanılan API eylemidir. Bueylem POST metodu ile çalışır ve tüm parametrelerin girilmesi zorunludur.

Bu eylemin sağlıklı çalışabilmesi için MaestroPanel Web Management Service üzerindenDomain Planı yaratılmış ve planın alias isminin verilmiş olması gerekmektedir.

Url

Method POST

Url ~/Api/v1/Domain/Create

Parametreler

Parametre Açıklama

key Zorunlu alanSisteme erişimi sağlarTip : StringVarsayılan Değer : Empty

name Zorunlu alanSistemde daha önce bulunmayan bir domain ismi olmalıdır. FQDNstandartlarında alanadı değeri verilmelidir.Tip: StringVarsayılan Değer: Empty

planAlias Zorunlu AlanDomain Planı oluştururken "alias" kısmında verilen isim. Hosting açılmadanönce "Domain Planları"'dan planın oluşturulması gerekiyor.Tip: StringVarsayılan Değer: Empty

username Zorunlu AlanKullanıcı adına ihtiyaç duyulan modüller kullanır. Örneğin: FTP

11MaestroPanel


Tip: StringVarsayılan Değer: Empty

password Zorunlu AlanŞifre ihtiyacı duyan modüler kullanır. Örneğin: FTP, EmailTip: StringVarsayılan Değer: Empty

activedomainuser Opsiyonel AlanHosting oluşturulurken aynı zamanda domain kullanıcısınıda oluşturur vekullanıma hazır halde getirir. Domain'in müstakil olarak yönetilebilmesinisağlar.Tip: BooleanAlabildiği Değerler: ture, false Varsayılan Değer: false

firstname Opsiyonel AlanBu alanın aktif olabilmesi için "activedomainuser" parametresinin trueolması gerekiyor. Alanadı kullanıcısının ismini tanımlayabileceğiniz alan.Tip: StringVarsayılan Değer: null

lastname Opsiyonel AlanBu alanın aktif olabilmesi için "activedomainuser" parametresinin trueolması gerekiyor. Alanadı kullanıcısının soy ismini tanımlayabileceğiniz alan.Tip: StringVarsayılan Değer: null

email Opsiyonel AlanBu alanın aktif olabilmesi için "activedomainuser" parametresinin trueolması gerekiyor. Alanadı kullanıcısının email adresini tanımlayabileceğinizalan.Tip: StringVarsayılan Değer: null

expiration Opsiyonel AlanOluşturulan web sitesinin sonlanma tarihini belirler. Boş bırakıldığı taktirdeplanAlias 'da verilen Domain Planına göre hareket eder.Tarih formatı yyyyMMdd şeklinde olmalıdır. Örn: 20121028Tip: StringVarsayılan Değer: null

İstek

POSThttp://contoso.com:9715/Api/v1/Domain/Create?key=1_e9f1131d7cc44fd8c5df1aca0155937&name=domain.com&planAlias=GOLDPLAN&username=domain.com&password=PassW0Rd!&activedomainuser=true&firstname=John&lastnam

12MaestroPanel


e=Doe&[email protected]

Cevap

200 0 Domain created successfully: domain.com 0 Domain created successfully: domain.com 120 19mayismuftulugu.gov.tr domain.com PassW0Rd! false true Web Site Created: domain.com IIS 7.5 Add true Ftp host created: domain.com Microsoft FTP Add

Domain/Delete

MaestroPanel üzerindeki mevcut domain'in (hosting) ve tüm verilerinin bir daha geri gelmeyecekşekilde silinmesini sağlar. HTTP eyleminde bulunurken HTTP Metodunun Delete olmasına dikkatedilmelidir.

13MaestroPanel


Url

Method DELETE

Url ~/Api/v1/Domain/Delete

Parametreler



name Zorunlu alanSistemde mevcut olan alanadı ismi. FQDN standartlarında alanadı değeriverilmelidir.Tip: StringVarsayılan Değer: Empty

İstek

DELETEhttp://contoso.com:9715/Api/v1/Domain/Delete?key=1_e9f1131d7cc44fd8c5df1aca0155937&name=domain.com

Cevap: Xml

200 0 Domain deleted successfully: domain.com 0 Domain deleted successfully: domain.com 121 domain.com false

14MaestroPanel


true Ftp host deleted: domain.com Microsoft FTP Delete true Website deleted: domain.com IIS 7.5 Delete

Domain/Stop

MaestroPanel üzerindeki start durumda olan bir domain'in (hosting) durdurulmasını sağlar.Domain'in çalıştığı tüm modüller durdurulur. Domain durumu bu eylemden sonra "Stop" olarakişaretlenir.

Url

Method POST

Url ~/Api/v1/Domain/Stop

Parametreler



name Zorunlu alanSistemda mevcut olan alanadı ismi. FQDN standartlarında alanadıdeğeri verilmelidir.Tip: StringVarsayılan Değer: Empty

15MaestroPanel


İstek

POSThttp://contoso.com:9715/Api/v1/Domain/Stop?key=1_e9f1131d7cc44fd8c5df1aca0155937&name=domain.com

Cevap

200 0 Domain stopped successfully: domain.com 0 Domain stopped successfully: domain.com 122 domain.com false true domain.com status is Disabled Microsoft FTP Stop true Stopped domain.com IIS 7.5 Stop

Domain/Start

MaestroPanel üzerindeki stop durumda olan domain'in (hosting) başlatılmasını sağlar sağlar.Domain'in çalıştığı tüm modülller tekrardan başlatılır. Domain durumu bu eylemden sonra "Start"olarak işaretlenir.

16MaestroPanel


Url

Method POST

Url ~/Api/v1/Domain/Start

Parametreler



name Zorunlu alanSistemda mevcut olan alanadı ismi. FQDN standartlarında alanadı değeriverilmelidir.Tip: StringVarsayılan Değer: Empty

İstek

POSThttp://contoso.com:9715/Api/v1/Domain/Start?key=1_e9f1131d7cc44fd8c5df1aca0155937&name=domain.com

Cevap

200 0 Domain started successfully: domain.com 0 Domain started successfully: domain.com 0 domain.com false

17MaestroPanel


true domain.com status is Enabled Microsoft FTP Start true Started domain.com IIS 7.5 Start

Domain/Password

MaestroPanel üzerindeki mevcut olan domain kullanıcısının parolasını değiştirir. Daha öncekiparolaya ihtiyaç olmadan direkt değiştirilebilir. Bu eylemden sonra domain yöneticisi yenitanımlanan parola ile giriş yapmalıdır.

Url

Method POST

Url ~/Api/v1/Domain/Password

Parametreler



name Zorunlu alanSistemda mevcut olan alanadı ismi. FQDN standartlarında alanadıdeğeri verilmelidir.Tip: String

18MaestroPanel


Varsayılan Değer: Empty

newpassword Zorunlu alanDomain kullanıcısının kullanacağı yeni şifre.Tip: StringVarsayılan Değer: Empty

İstek

POSThttp://contoso.com:9715/Api/v1/Domain/Password?key=1_e9f1131d7cc44fd8c5df1aca0155937&name=domain.com&newpassword=p4ssw0rd

Cevap

200 0 Password changed successfully: domain.com 0 Password changed successfully: domain.com 122 domain.com domain.com false

Domain/AddDomainAlias

MaestroPanel üzerinde mevcut olan bir domain için yeni takma isim oluşturur. Bu fonksiyon DNSmodülü ile bir likte çalışır. Domain alias eklendiğinde DNS üzerinde bir tane Zone açılır ve anadomain'in zone'u eşitlenir.

19MaestroPanel


Url

Method POST

Url ~/Api/v1/Domain/AddDomainAlias

Parametreler



name Zorunlu alanSistemde mevcut olan FQDN standartlarında alanadı değeri verilmelidir.Tip: StringVarsayılan Değer: Empty

alias Zorunlu alanOluşturulacak domain alias ismi verilmelidir fqdn standartları geçerlidir.Örn: domain.comTip: StringVarsayılan Değer: Empty

İstek

POSThttp://contoso.com:9715/Api/v1/Domain/AddDomainAlias?key=1_e9f1131d7cc44fd8c5df1aca0155937&name=domain.com&alias=domain.net

Cevap

200 0 domain.net binding added to domain.com

20MaestroPanel


0 domain.net binding added to domain.com 0 domain.com false

Domain/AddSubDomain

MaestroPanel üzerinde bulunan domain'e yeni bir subdomain ekler. Dns ve FTP modülü ilebağlantılı çalışır. Subdomain eklendiğinde subdomain isminde bir A record DNS'e eklenir.Belirtilen kullancı isminde bir FTP hesabı açılır.

Url

Method POST

Url ~/Api/v1/Domain/AddSubDomain

Parametreler



name Zorunlu alanSistemde mevcut olan FQDN standartlarında alanadı değeriverilmelidir.Tip: StringVarsayılan Değer: Empty

subdomain Zorunlu alanOluşturulacak subdomain'in sadece ismi girilmelidir. Örneğin:blog.maestropanel.com isteniyorsa sadece blog giriniz.

21MaestroPanel


Tip: StringVarsayılan Değer: null

ftpuser Zorunlu alanOluşturulacak subdomain'e erişim için kullanılacak FTP kullanıcısıTip: StringVarsayılan Değer: null

İstek

POSThttp://contoso.com:9715/Api/v1/Domain/AddSubDomain?key=1_e9f1131d7cc44fd8c5df1aca0155937&name=domain.com&subdomain=blog&ftpuser=blogftp

Cevap

200 0 Create Web Site: blog.domain.com 0 Create Web Site: blog.domain.com 0 domain.com false

22MaestroPanel


Domain/ChangeIpAddrMaestroPanel üzerinde mevcut olan domain'in IP Adresini değiştirir. Tanımlanan IP adresiMaestroPanel üzerinde tanımlı ve API kullanıcısının erişim hakkı olmalıdır.

Url

Method POST

Url ~/Api/v1/Domain/ChangeIpAddr

Parametreler




newip Zorunlu alanDomain'in yeni IP'sinin belirlendiği parametre Ipv4 standartlarındaolmalıdır. Örneğin: 192.168.1.39Tip: StringVarsayılan Değer: null

İstek

POSThttp://contoso.com:9715/Api/v1/Domain/ChangeIpAddr?key=1_e9f1131d7cc44fd8c5df1aca0155937&name=domain.com&newip=192.168.2.5

23MaestroPanel


Cevap

200 0 Change IP: domain.com; Errors: 0 0 Change IP: domain.com; Errors: 0 0 domain.com false 192.168.2.5 true Change IP: domain.com INTERNALIIS75 Add true Errors: 0 INTERNALDOMAINALIAS Change

24MaestroPanel


Domain/GetList

MaestroPanel üzerinde çalışan domain isimlerini istenilen formata göre geri döndürür. XML,JSON formatlarında array tipinde geri dönüş yapar. Bu liste sayesinde Domain ID, Domain Ismi,Durumu, Sonlanma Tarihini ve Domain'in sahibini elde edebilirsiniz.

Url

Method GET

Url ~/Api/v1/Domain/GetList

Parametreler



İstek

GEThttp://contoso.com:9715/Api/v1/Domain/GetList?key=1_e9f1131d7cc44fd8c5df1aca0155937&format=XML

Cevap: Xml

200 0

25MaestroPanel


28 bayidomain.com 20140329T00:00:00 Start c1982 117 deneme.com 20140911T00:00:00 Start admin 118 db1.com 20140921T03:14:46 Start admin 119 webhostingturkey.com 20140921T19:07:04 Start admin 122 domain.com 20140922T00:00:00 Start admin

Cevap: Json

{ "Details" : [ { "ExpirationDate" : "/Date(1396044000000)/", "Id" : 28, "Name" : "bayidomain.com", "OwnerName" : "c1982", "Status" : 0

26MaestroPanel


}, { "ExpirationDate" : "/Date(1410382800000)/", "Id" : 117, "Name" : "deneme.com", "OwnerName" : "admin", "Status" : 0 }, { "ExpirationDate" : "/Date(1411258486000)/", "Id" : 118, "Name" : "db1.com", "OwnerName" : "admin", "Status" : 0 }, { "ExpirationDate" : "/Date(1411315624000)/", "Id" : 119, "Name" : "webhostingturkey.com", "OwnerName" : "admin", "Status" : 0 }, { "ExpirationDate" : "/Date(1411333200000)/", "Id" : 122, "Name" : "domain.com", "OwnerName" : "admin", "Status" : 0 } ], "ErrorCode" : 0, "Message" : "", "StatusCode" : 200}

27MaestroPanel


Domain/GetLimits

MaestroPanel üzerindeki herhangi bir domain'in limitleri ve kaynak kullanımlarını listeler. Geridönüş değeri XML'dir. API kullanıcısının kaynakları istenilen domain'e erişim hakları olmasıgerekmektedir. Bir istek içinde tek bir domain'in limit bilgileri döner.

Url

Method GET

Url ~/Api/v1/Domain/GetLimits

Parametreler




İstek

GEThttp://contoso.com:9715/Api/v1/Domain/GetLimits?key=1_057bbe002afe418c81a17cbe073114c6&name=domain.com

28MaestroPanel


Cevap: Xml

200 0 IIS_CPU_LIMIT INTERNALIIS75 Web Site CPU Limit (%) 0 0 true None IIS_LIMIT_BANDWITH_USAGE INTERNALIIS75 Web Site Speed Limit (MB) 0 0 true None IIS_LIMIT_TRAFFIC INTERNALIIS75 Web Site Traffic (Month/MB) 0 0 true None FTP_TRAFFIC_LIMIT INTERNALMSFTP75 Ftp Traffic (Month/MB) 0 0 true None MSFTP_FTPACCOUNTCOUNT INTERNALMSFTP75 Ftp Account Count 0 1 true

29MaestroPanel


None MSFTP_FTPQUOTA INTERNALMSFTP75 Ftp Quota (MB) 0 0 true None DOMAIN_ALIAS_LIMIT INTERNALDOMAINALIAS Domain Alias 0 1 true None IISSUBDOMAINLIMITI IISSUBDOMAIN SubDomain Count 0 1 true None

Cevap: Json

{ "Details" : [ { "FriendlyName" : "Web Site CPU Limit (%)", "Group" : 0, "Limit" : 0, "ModuleName" : "INTERNALIIS75", "Name" : "IIS_CPU_LIMIT", "Usage" : 0, "isUnlimited" : true }, { "FriendlyName" : "Web Site Speed Limit (MB)", "Group" : 0, "Limit" : 0, "ModuleName" : "INTERNALIIS75", "Name" : "IIS_LIMIT_BANDWITH_USAGE", "Usage" : 0, "isUnlimited" : true },

30MaestroPanel


{ "FriendlyName" : "Web Site Traffic (Month/MB)", "Group" : 0, "Limit" : 0, "ModuleName" : "INTERNALIIS75", "Name" : "IIS_LIMIT_TRAFFIC", "Usage" : 0, "isUnlimited" : true }, { "FriendlyName" : "Ftp Traffic (Month/MB)", "Group" : 0, "Limit" : 0, "ModuleName" : "INTERNALMSFTP75", "Name" : "FTP_TRAFFIC_LIMIT", "Usage" : 0, "isUnlimited" : true }, { "FriendlyName" : "Ftp Account Count", "Group" : 0, "Limit" : 0, "ModuleName" : "INTERNALMSFTP75", "Name" : "MSFTP_FTPACCOUNTCOUNT", "Usage" : 1, "isUnlimited" : true }, { "FriendlyName" : "Ftp Quota (MB)", "Group" : 0, "Limit" : 0, "ModuleName" : "INTERNALMSFTP75", "Name" : "MSFTP_FTPQUOTA", "Usage" : 0, "isUnlimited" : true }, { "FriendlyName" : "Domain Alias", "Group" : 0, "Limit" : 0, "ModuleName" : "INTERNALDOMAINALIAS", "Name" : "DOMAIN_ALIAS_LIMIT", "Usage" : 1, "isUnlimited" : true }, { "FriendlyName" : "SubDomain Count", "Group" : 0, "Limit" : 0, "ModuleName" : "IISSUBDOMAIN", "Name" : "IISSUBDOMAINLIMITI", "Usage" : 1, "isUnlimited" : true } ], "ErrorCode" : 0, "Message" : "", "StatusCode" : 200}

31MaestroPanel


Domain/SetLimits

MaestroPanel üzerindeki domain'in limitlerini tanımlar.

Url

Method GET

Url ~/Api/v1/Domain/SetLimits

Parametreler




maxdiskspace Opsiyonel AlanDomain'in sunucu üzerinde kullanabileceği maksimum disk alanınıbelirler. Değer MB cinsindendir.Tip: IntegerVarsayılan Değer: 0

maxmailbox Opsiyonel AlanDomain'in sunucu üzerinde kullanabileceği maksimum email adedinibelirler.Tip: IntegerVarsayılan Değer: 0

maxftpuser Opsiyonel AlanDomain'in sunucu üzerinde kullanabileceği maksimum ftp kullanıcıadedini belirler.Tip: Integer

32MaestroPanel


Varsayılan Değer: 0

maxsubdomain Opsiyonel AlanDomain'in sunucu üzerinde kullanabileceği maksimum sub domainadedini belirler.Tip: IntegerVarsayılan Değer: 0

maxdomainalias Opsiyonel AlanDomain'in sunucu üzerinde kullanabileceği maksimum domain aliasadedini belirler.Tip: IntegerVarsayılan Değer: 0

totalwebtraffic Opsiyonel AlanDomain'in sunucu üzerinde kullanabileceği aylık toplam web trafikmiktarını belirler. Değer MB Cİnsindendir.Tip: IntegerVarsayılan Değer: 0

totalmailspace Opsiyonel AlanDomain'in sunucu üzerinde kullanabileceği toplam email boyutunubelirler. Değer MB Cinsindendir.Tip: IntegerVarsayılan Değer: 0

maxwebtraffic Opsiyonel AlanDomain'in kullanabileceği aylık trafik limitini belirler.Değer MBcinsindendir.Tip: IntegerVarsayılan Değer: 0

maxftptraffic Opsiyonel AlanDomain'in kullanabileceği aylık ftp trafik limitini belirler.Değer MBcinsindendir.Tip: IntegerVarsayılan Değer: 0

maxmailtraffic Opsiyonel AlanDomain'in kullanabileceği aylık email trafik limitini belirler.Değer MBcinsindendir.Tip: IntegerVarsayılan Değer: 0

maxmysql Opsiyonel AlanDomain'in kullanabileceği maksimum MySQL database adedinibelirler.Tip: Integer

33MaestroPanel


Varsayılan Değer: 0

maxmysqluser Opsiyonel AlanDomain'in kullanabileceği maksimum MySQL kullanıcılarını adedinibelirler.Tip: IntegerVarsayılan Değer: 0

maxmysqlspace Opsiyonel AlanDomain'in kullanabileceği maksimum MySQL database boyutunu MBCinsinden belirler.Tip: IntegerVarsayılan Değer: 0

maxmssql Opsiyonel AlanDomain'in kullanabileceği maksimum MsSQL database adedinibelirler.Tip: IntegerVarsayılan Değer: 0

maxmssqluser Opsiyonel AlanDomain'in kullanabileceği maksimum MsSQL kullanıcılarını adedinibelirler.Tip: IntegerVarsayılan Değer: 0

maxmssqlspace Opsiyonel AlanDomain'in kullanabileceği maksimum MsSQL database boyutunu MBCinsinden belirler.Tip: IntegerVarsayılan Değer: 0

İstek

POSThttp://contoso.com:9715/Api/v1/Domain/SetLimits?key=1_9bd61d3da73040c3a8b214afb25e4656&name=domain.com&maxdiskspace=100&maxmailbox=5&maxftpuser=1&maxsubdomain=5&maxdomainalias=5&totalwebtraffic=10000&totalmailspace=1000&maxwebtraffic=5&maxftptraffic=10000&maxmailtraffic=10000&maxmysql=1&maxmysqluser=2&maxmysqlspace=1000&maxmssql=1&maxmssqluser=1&maxmssqlspace=1000

34MaestroPanel


Cevap: Xml

200 0 Limits set successfully: domain.com 0 Limits set successfully: domain.com 122 domain.com false true Set Maxbandwidth: domain.com IIS 7.5 Set true Quota Added: C:\vhosts\domain.com\http Microsoft FTP Set true Domain Alias Set true IIS Subdomain Set

35MaestroPanel


Cevap: Json

{ "StatusCode":200, "ErrorCode":0, "Message":"Limits set successfully: domain.com", "Details":{ "Code":0, "Message":"Limits set successfully: domain.com", "Id":122, "Name":"domain.com", "Username":null, "Password":null, "DomainUser":false, "IpString":null, "ModuleResults":[ { "Status":true, "Msg":"Set Maxbandwidth: domain.com", "Name":"IIS 7.5", "PType":"Set" }, { "Status":true, "Msg":"Quota Added: C:\\vhosts\\domain.com\\http", "Name":"Microsoft FTP", "PType":"Set" }, { "Status":true, "Msg":"", "Name":"Domain Alias", "PType":"Set" }, { "Status":true, "Msg":"", "Name":"IIS Subdomain", "PType":"Set" } ] }}

36MaestroPanel


Domain/SetWriteAccess

MaestroPanel üzerinde host edilen herhangi bir domain'in http klasörü altındaki herhangi birnesneye yazma izni verir. Örneğin bir veritabanı dosyası veya bir text dosyasına SetWriteAccessfonksiyonunu kullanarak yazma izni verebilirsiniz.

Url

Method POST

Url ~/Api/v1/Domain/SetWriteAccess

Parametreler




path Zorunlu AlanDomain'in home path'inden itibaren baz alınır yani http klasörü.Örneğin: web sitesinin altında ki db klasörüne hak vereceksenizsadece db. Upload klasörünün altındaki db klasörüne hakverecekseniz upload\db değeri giriniz.Tip: StringVersayılan Değer: Empty

37MaestroPanel


İstek

GEThttp://contoso.com:9715/Api/v1/Domain/SetWriteAccess?key=1_057bbe002afe418c81a17cbe073114c6&name=domain.com&path=t1

Cevap : Xml

200 0 Set Write Access: C:\vhosts\domain.com\http\db 0 Set Write Access: C:\vhosts\domain.com\http\db 0 domain.com false

Cevap: Json

{ "StatusCode":200, "ErrorCode":0, "Message":"Set Write Access: C:\\vhosts\\domain.com\\http\\db", "Details":{ "Code":0, "Message":"Set Write Access: C:\\vhosts\\domain.com\\http\\db", "Id":0, "Name":"domain.com", "Username":null, "Password":null, "DomainUser":false, "IpString":null, "ModuleResults":[

] }}

38MaestroPanel


Domain/Forwarding

MaestroPanel üzerinde mevcut olan bir domain'i başka bir URL'ye yönlendirir.

Url

Method POST

Url ~/Api/v1/Domain/Forwarding

Parametreler




enabled OpsiyonelYönlendirmeyi aktif veya pasif duruma getirir. True veya False değerialabilir.Tip: BooleanVarsayılan Değer: False

destination Zorunlu AlanYönlendirilecek URL bilgisini içerir.Tip: StringVarsayılan Değer: Empty

exacDestination OpsiyonelYönlendirilecek adresin mutlak bir konumda değil göreceli birkonumda olduğunu belirler.

39MaestroPanel


Tip: BooleanVarsayılan Değer: False

childOnly OpsiyonelAna URL'nin altında bir dosya istenirse alt dosya ile birlikteyönlendirilir. Örneğin: http://domain.com/kayit/index.html istenirse vehttp://test.domain.com'a yönlendirme yapılırsa sistem otomatikmanhttp://test.domain.com/kayit/index.html e yönlendirir.Tip: BooleanVarsayılan Değer: False

statusCode Zorunlu AlanYönlendirmenin hangi http status code ile cevap verileceğini belirler.

Alabileceği değerler.

Değer Açıklama

Found 302 durum kodunu döndürür.

Permanent 301 durum kodunu döndürür.

Temporary 307 durum kodunu döndürür.

Tip: StringVarsayılan Değer: Found

İstek

GEThttp://contoso.com:9715/Api/v1/Domain/Forwarding?key=1_057bbe002afe418c81a17cbe073114c6&name=domain.com&enabled=true&destination=http://www.maestropanel.com&exacDestination=False&childOnly=False&statusCode=Found

Cevap : Xml

200 0 Redirection active: domain.com

40MaestroPanel


0 Redirection active: domain.com 0 domain.com false

Cevap: Json

{ "Details" : { "Code" : 0, "DomainUser" : false, "Id" : 0, "IpString" : null, "Message" : "Redirection active: domain.com", "ModuleResults" : [ ], "Name" : "domain.com", "Password" : null, "Username" : null }, "ErrorCode" : 0, "Message" : "Redirection active: domain.com", "StatusCode" : 200}

Domain/ChangeReseller

MaestroPanel üzerinde mevcut olan bir domain'in bağlı olduğu Bayi'yi (Reseller) değiştirir.

Url

Method POST

Url ~/Api/v1/Domain/ChangeReseller

Parametreler

key Zorunlu alan

41MaestroPanel


Sisteme erişimi sağlarTip : StringVarsayılan Değer : Empty


resellerName Zorunlu AlanMaestroPanel üzerinde mevcut olan bir bayi (Reseller) kullanıcı adıolmalıdır.Tip: StringVarsayılan Değer: Empty

İstek

GEThttp://contoso.com:9715/Api/v1/Domain/ChangeReseller?key=1_057bbe002afe418c81a17cbe073114c6&name=domain.com&resellerName=okyhosting

Cevap : Xml

200 0 Domain owner changed: domain.com 0 Domain owner changed: domain.com 0 domain.com false

42MaestroPanel


Cevap: Json

{ "Details" : { "Code" : 0, "DomainUser" : false, "Id" : 0, "IpString" : null, "Message" : "Redirection active: domain.com", "ModuleResults" : [ ], "Name" : "domain.com", "Password" : null, "Username" : null }, "ErrorCode" : 0, "Message" : "Redirection active: domain.com", "StatusCode" : 200}

Domain/AddMailBox

MaestroPanel üzerinde mevcut olan bir domain'e yeni mail hesabı eklemek için kullanılaneylemdir.

Url

Method POST

Url ~/Api/v1/Domain/AddMailBox

Parametreler



name Zorunlu alanSistemde daha önce bulunmayan bir domain ismi olmalıdır. FQDN

43MaestroPanel


standartlarında alanadı değeri verilmelidir.Tip: StringVarsayılan Değer: Empty

account Zorunlu alanMail adresinin adı. Sadece ismi giriniz Örn: infoTip: StringVarsayılan Değer: Empty

password Zorunlu alanMail adresinin parolası.Tip: StringVarsayılan Değer: Empty

quota Zorunlu alanMail adresinin MB cinsinden boyutu. 1 Sınırsız (Unlimited)Tip: int?Varsayılan Değer: null

redirect Opsiyonel AlanEklenmekte olan email adresine gelen maillerin başka bir emailadresine yönlendirilip, yönlendirilmemesini sağlar. true veya false değerialır.Tip: boolVarsayılan Değer: false

remail Opsiyonel AlanEklenmete olan email adresine gelen maillerin yönleneceği emailadresini belirler. Bu parametrenin etkili olabilmesi için redirectparametresinin true olması gerekir.Direkt email adresi girilebilir. Örnek: [email protected]: StringVarsayılan Değer: null

İstek

POSThttp://contoso.com:9715/Api/v1/Domain/AddMailBox?key=1_e9f1131d7cc44fd8c5df1aca0155937&name=domain.com&account=info&password=PassW0Rd!&quota=1000

44MaestroPanel


Cevap:Xml

200 0 Mailbox Created: [email protected] 0 Mailbox Created: [email protected] 0 domain.com false

Cevap: Json

{ "StatusCode":200, "ErrorCode":0, "Message":"Mailbox Created: [email protected]", "Details":{ "Code":0, "Message":"Mailbox Created: [email protected]", "Id":0, "Name":"domain.com", "Username":null, "Password":null, "DomainUser":false, "IpString":null, "ModuleResults":[

] }}

45MaestroPanel


Domain/DeleteMailBox

MaestroPanel üzerinde mevcut olan bir domain'e tanımlı olan mail adresini silmek için kullanılır.

Url

Method POST

Url ~/Api/v1/Domain/DeleteMailBox

Parametreler



name Zorunlu alanSistemde daha önce bulunmayan bir domain ismi olmalıdır.FQDN standartlarında alanadı değeri verilmelidir.Tip: StringVarsayılan Değer: Empty


İstek

POSThttp://contoso.com:9715/Api/v1/Domain/DeleteMailBox?key=1_e9f1131d7cc44fd8c5df1aca0155937&name=domain.com&account=info

46MaestroPanel


Cevap: Xml

200 0 Account deleted successfully: infoq 0 Account deleted successfully: info 0 domain.com false

Cevap: Json

{ "StatusCode":200, "ErrorCode":0, "Message":"Account deleted successfully: info", "Details":{ "Code":0, "Message":"Account deleted successfully: info", "Id":0, "Name":"domain.com", "Username":null, "Password":null, "DomainUser":false, "IpString":null, "ModuleResults":[] }}

47MaestroPanel


Domain/ChangeMailBoxQuota

MaestroPanel üzerinde mevcut olan bir domain'a ait mailbox'ın kotasını değiştirmek için kullanılır.Domain limitleri dahilinde MB cinsinden değer tanımlaması yapılabilir.

Url

Method POST

Url ~/Api/v1/Domain/ChangeMailBoxQuota

Parametreler





quota Zorunlu AlanMail adresinin yeni kotasını belirler. Girilen değer MB cinsindenhesaplanır. Örneğin: 1000 değeri 1GB'a eşittir.Tip: IntegerVarsayılan Değer: null

48MaestroPanel


İstek

POSThttp://contoso.com:9715/Api/v1/Domain/ChangeMailBoxQuota?key=1_e9f1131d7cc44fd8c5df1aca0155937&name=domain.com&account=info&quota=500

Cevap: Xml

200 0 Quota set: [email protected] Quota: 512000 0 Quota set: [email protected] Quota: 512000 0 domain.com false

Cevap: Json

{ "StatusCode":200, "ErrorCode":0, "Message":"Quota set: [email protected] Quota: 512000", "Details":{ "Code":0, "Message":"Quota set: [email protected] Quota: 512000", "Id":0, "Name":"domain.com", "Username":null, "Password":null, "DomainUser":false, "IpString":null, "ModuleResults":[

] }}

49MaestroPanel


Domain/ChangeMailBoxPassword

MaestroPanel üzerinde mevcut olan bir domain'a ait mailbox'ın parolasını değiştirmek içinkullanılır.

Url

Method POST

Url ~/Api/v1/Domain/ChangeMailBoxPassword

Parametreler





newpassword Zorunlu AlanMail adresinin yeni parolasını belirler.Tip: StringVarsayılan Değer: Empty

50MaestroPanel


İstek

POSThttp://contoso.com:9715/Api/v1/Domain/ChangeMailBoxPassword?key=1_e9f1131d7cc44fd8c5df1aca0155937&name=domain.com&account=info&newpassword=p@ssw0rd!

Cevap: Xml

200 0 Password changed: [email protected] 0 Password changed: [email protected] 0 domain.com false

Cevap: Json

{ "StatusCode":200, "ErrorCode":0, "Message":"Password changed: [email protected]", "Details":{ "Code":0, "Message":"Password changed: [email protected]", "Id":0, "Name":"domain.com", "Username":null, "Password":null, "DomainUser":false, "IpString":null, "ModuleResults":[

] }}

51MaestroPanel


Domain/GetMailList

MaestroPanel üzerinde mevcut olan bir domain'a ait mail yapısının çıktısını XML şeklinde verir.Tek seferde domain'e ait tüm mailbox'ların durumunu, disk kotalarını ve kullandığı disk boyutunugörebilirsiniz.

Url

Method GET

Url ~/Api/v1/Domain/GetMailList

Parametreler




İstek

GEThttp://contoso.com:9715/Api/v1/Domain/GetMailList?key=1_e9f1131d7cc44fd8c5df1aca0155937&name=domain.com

52MaestroPanel


Cevap: Xml

200 0

Cevap: Json

{ "StatusCode":200, "ErrorCode":0, "Message":"", "Details":{ "Name":"domain.com", "Quota":0, "Accounts":[ { "Name":"info", "Status":true, "Quota":500, "Usage":0 }, { "Name":"ismail", "Status":true, "Quota":1, "Usage":0 } ] }}

53MaestroPanel


Domain/AddDatabase

MaestroPanel üzerinde mevcut olan bir domain için yeni veritabanı oluşturur. Bu eylem ile bir çokveritabanı tipi oluşturulabilir.

Url

Method POST

Url ~/Api/v1/Domain/AddDatabase

Parametreler




dbtype Zorunlu alanOluşturulacak veritabanı tipi. mssql, mysql değerleri kabul edilir.Tip: StringVarsayılan Değer: Empty

database Zorunlu alanOluşutulacak veritabanı ismi.Tip: StringVarsayılan Değer: Empty

username Zorunlu alanOluşturulacak veritabanı kullanıcısı.Tip: StringVarsayılan Değer: Empty

password Zorunlu alanOluşturulacak veritabanı kullanıcısının parolası.

54MaestroPanel


Tip: StringVarsayılan Değer: Empty

quota Zorunlu alanVeritabanının adresinin MB cinsinden boyutu. 1 Sınırsız (Unlimited)Tip: int?Varsayılan Değer: null

İstek

POSThttp://contoso.com:9715/Api/v1/Domain/AddDatabase?key=1_e9f1131d7cc44fd8c5df1aca0155937&name=domain.com&database=wordpressdb&username=pressdb&password=PassW0Rd!&dbtype=mysql&quota=1000

Cevap: Xml

200 0 Success 0 Success 0 domain.com false

55MaestroPanel


Cevap: Json

{ "StatusCode":200, "ErrorCode":0, "Message":"Success", "Details":{ "Code":0, "Message":"Success", "Id":0, "Name":"domain.com", "Username":null, "Password":null, "DomainUser":false, "IpString":null, "ModuleResults":[

] }}

Domain/DeleteDatabase

MaestroPanel üzerinde mevcut olan bir domain için yeni veritabanı oluşturur. Bu eylem ile bir çokveritabanı tipi oluşturulabilir.

Url

Method POST

Url ~/Api/v1/Domain/DeleteDatabase

Parametreler



56MaestroPanel




database Zorunlu alanOluşutulacak veritabanı ismi.Tip: StringVarsayılan Değer: Empty

İstek

POSThttp://contoso.com:9715/Api/v1/Domain/DeleteDatabase?key=1_e9f1131d7cc44fd8c5df1aca0155937&name=domain.com&database=testdb1&dbtype=mysql

Cevap: Xml

200 0 Success 0 Success 0 domain.com false

57MaestroPanel


Cevap: Json


] }}

Domain/AddDatabaseUser

Mevcut olan veritabanına yeni bir kullanıcı tanımlamak için kullanılır.

Url

Method POST

Url ~/Api/v1/Domain/AddDatabaseUser

Parametreler



58MaestroPanel




database Zorunlu alanKullanıcı tanımlanacak veritabanı adı.Tip: StringVarsayılan Değer: Empty

username Zorunlu alanOluşturulacak veritabanı kullanıcısı.Tip: StringVarsayılan Değer: Empty

password Zorunlu alanOluşturulacak veritabanı kullanıcısının parolası.Tip: StringVarsayılan Değer: Empty

İstek

POSThttp://contoso.com:9715/Api/v1/Domain/AddDatabaseUser?key=1_e9f1131d7cc44fd8c5df1aca0155937&name=domain.com&database=wordpressdb&username=test_user&password=PassW0Rd!&dbtype=mysql

Cevap: Xml

200 0 Success 0 Success 0 domain.com

59MaestroPanel


false

Cevap: Json


] }}

Domain/AddFtpAccount

MaestroPanel üzerinde mevcut domain için yeni ftp hesabı oluşturur.

Url

Method POST

Url ~/Api/v1/Domain/AddFtpAccount

60MaestroPanel


Parametreler




account Zorunlu alanFtp kullanıcısının ismi.Tip: StringVarsayılan Değer: Empty

password Zorunlu alanFtp kullanıcısının parolası.Tip: StringVarsayılan Değer: Empty

homePath Zorunlu alanFtp kullanıcısının klasörü. Bu değer http klasörünü başlangıç alır.Örn: / veya /veritabaniTip: StringVarsayılan Değer: /

ronly Zorunlu alanFtp kullanıcısını sadece okuma yetkisi ile açar. Bu parametre trueveya false değeri alabilir.Tip: boolVarsayılan Değer: false

İstek

POSThttp://contoso.com:9715/Api/v1/Domain/AddFtpAccount?key=1_e9f1131d7cc44fd8c5df1aca0155937&name=domain.com&account=ftpuser&password=Pass12!&ronly=false

61MaestroPanel


Cevap: Xml

200 0 User Created: ftpuser 0 User Created: ftpuser 0 domain.com false

Cevap: Json

{ "StatusCode":200, "ErrorCode":0, "Message":"User Created: ftpuser2", "Details":{ "Code":0, "Message":"User Created: ftpuser2", "Id":0, "Name":"domain.com", "Username":null, "Password":null, "DomainUser":false, "IpString":null, "ModuleResults":[

] }}

62MaestroPanel


Domain/DeleteFtpAccount

MaestroPanel üzerinde mevcut domain'in varolan ftp kullanıcısını siler.

Url

Method POST

Url ~/Api/v1/Domain/DeleteFtpAccount

Parametreler





İstek

POSThttp://contoso.com:9715/Api/v1/Domain/DeleteFtpAccount?key=1_e9f1131d7cc44fd8c5df1aca0155937&name=domain.com&account=ftpuser

63MaestroPanel


Cevap: Xml

200 0 User deleted: ftpuser 0 User deleted: ftpuser 0 domain.com false

Cevap: Json

{ "StatusCode":200, "ErrorCode":0, "Message":"User deleted: ftpuser", "Details":{ "Code":0, "Message":"User deleted: ftpuser", "Id":0, "Name":"domain.com", "Username":null, "Password":null, "DomainUser":false, "IpString":null, "ModuleResults":[

] }}

64MaestroPanel


Domain/ChangeFtpPasswordMaestroPanel üzerinde mevcut domain'in varolan ftp kullanıcısının parolasını değiştirir.

Url

Method POST

Url ~/Api/v1/Domain/ChangeFtpPassword

Parametreler





newpassword Zorunlu alanYeni parola.Tip: StringVarsayılan Değer: Empty

İstek

POSThttp://contoso.com:9715/Api/v1/Domain/ChangeFtpPassword?key=1_e9f1131d7cc44fd8c5df1aca0155937&name=domain.com&account=ftpuser&newpassword=NewP4s5!

65MaestroPanel


Cevap: Xml

200 0 Password changed: domain.com 0 Password changed: domain.com 0 domain.com false

Cevap: Json

{ "StatusCode":200, "ErrorCode":0, "Message":"Password changed: domain.com", "Details":{ "Code":0, "Message":"Password changed: domain.com", "Id":0, "Name":"domain.com", "Username":null, "Password":null, "DomainUser":false, "IpString":null, "ModuleResults":[

] }}

66MaestroPanel


Domain/SetDnsZone

MaestroPanel üzerindeki domain'in DNS alanını yönetir. Bu method mevcut dns alanını siler vealdığı parametrelere göre zone'u tekrar oluşturur. MaestroPanel üzerindeki DNSTemplate'lerinden bağımsız olarak çalışır.

Url

Method POST

Url ~/Api/v1/Domain/SetDnsZone

Parametreler



name Zorunlu alanFQDN standartlarında alanadı değeri verilmelidir.Tip: StringVarsayılan Değer: Empty

soa_expired İsteğe BağlıZone'un soa alanının expired değerini tanımlar.Tip: intVarsayılan Değer: 3600

soa_ttl İsteğe BağlıZone'un soa alanının time to live (ttl) değerini tanımlar.Tip: intVarsayılan Değer: 172800

soa_refresh İsteğe BağlıZone'un soa alanının refresh değerini tanımlar.Tip: intVarsayılan Değer: 8640

soa_email İsteğe Bağlı

67MaestroPanel


Zone'dan sorumlu olan personelin email adresini tanımlar. Geneldehostmaster.domain.com şeklindedir. @ işareti yerine noktakullanulması önerilir.Tip: StringVarsayılan Değer: Empty

soa_retry İsteğe Bağlı:Zone'a ulaşılamama durumda bir sonraki erişme isteğinin ne zamanolacağını belirler.Tip: intVarsayılan Değer:7200

soa_serial İsteğe BağlıZone alanının güncellenip güncellenmediğini belirler. Değiştirildiğindezone güncellenmiş sayılır ve diğer dns sunucuları buna göre hareketeder.Tip: intVarsayılan Değer: yyyyMMddHHss (tarih formatıdır)

primaryServer İsteğe BağlıZone alanının başvurulacak ilk Name Server bilgisini tutar.Tip: StringVarsayılan Değer: ns1.domain.com

record İsteğe BağlıZone alanının kayıtlarını tutar. Tekrarlanabilir olarak kullanılabilir.

Record parametresi sırası ile şu şekilde olmalıdır:

Name Kayıt ismi @,www,mail,ftp gibi değerleralabilir. Boş girilirse @ değeri alır. @ değeridomain'in kendisi demektir.

Type Kayıt Tipi: A, AAAA, MX, NS, TXT, CNAMEtiplerini desteklenmektedir.

Host Tip A olduğunda IPv4 adresi alabilir,Tip AAAA olduğunda IPv6 adresi alabilir.Tip MX olduğunda domain ismi alabilir.Tip CNAME olduğunda domain ismi alabilir.Tip NS olduğunda domain ismi alabilir.Tip TXT olduğunda herhangi bir değeralabilir.

Priority MX tipinde kullanılan önem derecesidir.Birden fazla MX'i derecelendirir.5,10,20,30,40,50 değerlerle

68MaestroPanel


derecelendirilmesi önerilmektedir.

Örnek record parametresi:

&record=@,A,4.2.2.1,0&record=www,CNAME,domain.com,0

Tip: ArrayVarsayılan Değer: Empty

İstek

POSThttp://contoso.com:9715/Api/v1/Domain/SetDnsZone?key=1_e9f1131d7cc44fd8c5df1aca0155937&name=domain.com&soa_expired=3600&soa_ttl=172800&soa_refresh=8640&soa_email=hostmaster.domain.com&soa_retry=7200&soa_serial=201309241857&primaryServer=ns1.domain.com&record=@,A,192.168.2.1,0&record=www,CNAME,domain.com,0&record=@,MX,domain.com,5

Cevap: Xml

200 0 Zone Added: domain.com 0 Zone Added: domain.com 0 domain.com false

69MaestroPanel


Cevap: Json

{ "StatusCode":200, "ErrorCode":0, "Message":"Zone Added: domain.com", "Details":{ "Code":0, "Message":"Zone Added: domain.com", "Id":0, "Name":"domain.com", "Username":null, "Password":null, "DomainUser":false, "IpString":null, "ModuleResults":[

] }}

Domain/AddDnsRecord

MaestroPanel'deki domain'e yeni bir DNS kayıt ekler.

Url

Method POST

Url ~/Api/v1/Domain/AddDnsRecord

Parametreler



70MaestroPanel



rec_type Zorunlu alanDNS kayıt tipini belirler.Alabileceği Değerler: AFSDB, ATMA, A, HINFO, AAAA, CNAME,TXT, PTR, MX, NS, MG, MB, MINFO, MR, RP, RT, SRV, SIG,WKS, X25,KEYTip: StringVarsayılan Değer: Empty

rec_name Zorunlu alanDNS kaydının ismini belirler. Domain'in kendisine bir kayıt eklenecekse@ işareti kullanılmalıdır. @, domain.com demektir.Tip: StringVarsayılan Değer: Empty

rec_value Zorunlu alanDNS Kaydının değerini belirler. DNS kayı tipine göre (rec_type) değerideğişir. SetDnsZone eyleminin paramerelerine bakınız.

priority Zorunlu alanDNS kaydının önem derecesini belirler. Kayıt tipi MX olduğunda geçerliolur. Her MX kaydının priority değerinin farklı olması önerilmektedir.Tip: IntegerVarsayılan Değer: 0

İstek

POSThttp://contoso.com:9715/Api/v1/Domain/AddDnsRecord?key=1_e9f1131d7cc44fd8c5df1aca0155937&name=domain.com&rec_type=A&rec_name=ftp&rec_value=10.0.0.50&priority=0

Cevap: Xml

200 0 Record Added: ftp

xmlns:d2p1="http://www.w3.org/2001/XMLSchemainstance"> 0 Record Added: ftp 0 domain.com false

Cevap: Json

{ "StatusCode":200, "ErrorCode":0, "Message":"Record Added: ftp", "Details":{ "Code":0, "Message":"Record Added: ftp", "Id":0, "Name":"domain.com", "Username":null, "Password":null, "DomainUser":false, "IpString":null, "ModuleResults":[ ] }}

Domain/DeleteDnsRecord

MaestroPanel'deki domain'in mevcut DNS kaydını siler.

Url

Method POST

Url ~/Api/v1/Domain/DeleteDnsRecord

72MaestroPanel


Parametreler




rec_type Zorunlu alanDNS kayıt tipini belirler.Alabileceği Değerler: AFSDB, ATMA, A, HINFO, AAAA, CNAME,TXT, PTR, MX, NS, MG, MB, MINFO, MR, RP, RT, SRV, SIG,WKS, X25,KEYTip: StringVarsayılan Değer: Empty

rec_name Zorunlu alanDNS kaydının ismini belirler. Domain'in kendisine bir kayıt eklenecekse@ işareti kullanılmalıdır. @, domain.com demektir.Tip: StringVarsayılan Değer: Empty

rec_value Zorunlu alanDNS Kaydının değerini belirler. DNS kayı tipine göre (rec_type) değerideğişir. SetDnsZone eyleminin parametrelerine bakınız.

priority Zorunlu alanDNS kaydının önem derecesini belirler. Kayıt tipi MX olduğunda geçerliolur. Her MX kaydının priority değerinin farklı olması önerilmektedir.Tip: IntegerVarsayılan Değer: 0

İstek

POSThttp://contoso.com:9715/Api/v1/Domain/AddDnsRecord?key=1_e9f1131d7cc44fd8c5df1aca0155937&name=domain.com&rec_type=A&rec_name=ftp&rec_value=10.0.0.50&priority=0

73MaestroPanel


Cevap: Xml

200 0 Record Deleted: ftp 0 Record Deleted: ftp 0 domain.com false

Cevap: Json

{ "StatusCode":200, "ErrorCode":0, "Message":"Record Deleted: ftp", "Details":{ "Code":0, "Message":"Record Deleted: ftp", "Id":0, "Name":"domain.com", "Username":null, "Password":null, "DomainUser":false, "IpString":null, "ModuleResults":[

] }}

74MaestroPanel


Bayi (Reseller) Eylemleri

Reseller/Create

MaestroPanel'de yeni bir bayi açmak için kullanılır. Açılacak bayi planının ön tanımlı ve planalias'ın bilinmesi gerekir.

Url

Method POST

Url ~/Api/v1/Reseller/Create

Parametreler



username Zorunlu alanYeni açılacak bayi kullanıcı adını belirler.Tip: StringVarsayılan Değer: Empty

password Zorunlu AlanYeni açılacak bayinin parolasını belirler.Tip: StringVarsayılan Değer: Empty

planAlias Zorunlu AlanYeni açılacak bayinin hangi bayi planına göre oluşturulacağını belirler.Daha önce sistemde oluşturulmuş olmalıdır.Tip: StringVarsayılan Değer: Empty

75MaestroPanel


firstName Zorunlu AlanYeni açılacak bayinin adını belirler.Tip: StringVarsayılan Değer: Empty

lastName Zorunlu AlanYeni açılacak bayinin soyadını belirler.Tip: StringVarsayılan Değer: Empty

email Zorunlu AlanYeni açılacak bayinin email adresini belirler.Tip: StringVarsayılan Değer: Empty

country İsteğe BağlıYeni açılacak bayinin ülkesini belirler.Tip: StringVarsayılan Değer: Empty

organization İsteğe BağlıYeni açılacak bayinin firma veya organizasyon adını belirler.Tip: StringVarsayılan Değer: Empty

address1 İsteğe BağlıYeni açılacak bayinin birinci adres satırını belirler.Tip: StringVarsayılan Değer: Empty

address2 İsteğe BağlıYeni açılacak bayinin ikinci adres satırınu belirler.Tip: StringVarsayılan Değer: Empty

city İsteğe BağlıYeni açılacak bayinin şehirini belirler.Tip: StringVarsayılan Değer: Empty

province İsteğe BağlıYeni açılacak bayinin varsa bölge/Eyaleti belirler.Tip: StringVarsayılan Değer: Empty

postalcode İsteğe BağlıYeni açılacak bayinin posta kodunu belirler.Tip: String

76MaestroPanel



phone İsteğe BağlıYeni açılacak bayinin telefon numarasını belirler.Tip: StringVarsayılan Değer: Empty

fax İsteğe BağlıYeni açılacak bayinin fax numarasını belirler.Tip: StringVarsayılan Değer: Empty

İstek

POSThttp://contoso.com:9715/Api/v1/Reseller/Create?key=1_e9f1131d7cc44fd8c5df1aca0155937&username=reseller1&password=p@ssw0rd&planAlias=RESELLERPLAN1&firstname=Sari Cizmeli&lastname=Mehmet Aga&[email protected]

Cevap: Xml

200 0 Reseller successfully created: reseller1 0 Reseller successfully created: reseller1 83 reseller1

Cevap: Json

{ "Details" : { "ClientId" : 83, "ClientName" : "reseller1", "Code" : 0, "Message" : "Reseller successfully created: reseller1"

77MaestroPanel


}, "ErrorCode" : 0, "Message" : "Reseller successfully created: reseller1", "StatusCode" : 200}

Reseller/Stop

MaestroPanel üzerindeki bir bayiyi durdurur. Bayi durdurulursa giriş yapamaz, sahip olduğudomainleri yönetemez.

Url

Method POST

Url ~/Api/v1/Reseller/Stop

Parametreler



username Zorunlu alanBayi kullanıcı adıTip: StringVarsayılan Değer: Empty

İstek

POSThttp://contoso.com:9715/Api/v1/Reseller/Stop?key=1_17449299035c40f0926538271320de25&username=reseller2

78MaestroPanel


Cevap: Xml

200 0 Reseller stopped: reseller2 0 Reseller stopped: reseller2 0

Cevap: Json

{ "Details" : { "ClientId" : 0, "ClientName" : null, "Code" : 0, "Message" : "Reseller stopped: reseller2" }, "ErrorCode" : 0, "Message" : "Reseller stopped: reseller2", "StatusCode" : 200}

Reseller/Start

MaestroPanel üzerindeki "Stop" durumdaki bir bayiyi tekrar aktif hale getirir.

Url

Method POST

Url ~/Api/v1/Reseller/Start

79MaestroPanel


Parametreler




İstek

POSThttp://contoso.com:9715/Api/v1/Reseller/Start?key=1_17449299035c40f0926538271320de25&username=reseller1

Cevap: Xml

200 0 Reseller started: reseller2 0 Reseller started: reseller2 0

Cevap: Json

{ "Details" : { "ClientId" : 0, "ClientName" : null, "Code" : 0, "Message" : "Reseller started: reseller2" },

80MaestroPanel


"ErrorCode" : 0, "Message" : "Reseller started: reseller2", "StatusCode" : 200}

Reseller/ChangePassword

MaestroPanel üzerindeki bayi'nin parolasını değiştirir. Ayalar bölümündeki parola politikasınatabidir.

Url

Method POST

Url ~/Api/v1/Reseller/ChangePassword

Parametreler




newpassword Zorunlu alanBayi kullanıcısının yeni parolası.Tip: StringVarsayılan Değer: Empty

81MaestroPanel


İstek

POSThttp://contoso.com:9715/Api/v1/Reseller/ChangePassword?key=1_17449299035c40f0926538271320de25&username=reseller&newpassword=p@ssw0rd

Cevap: Xml

200 0 Reseller password has been changed 0 Reseller password has been changed 0

Cevap: Json

{ "Details" : { "ClientId" : 0, "ClientName" : null, "Code" : 0, "Message" : "Reseller password has been changed" }, "ErrorCode" : 0, "Message" : "Reseller password has been changed", "StatusCode" : 200}

82MaestroPanel


Reseller/AddDomain

MaestroPanel'deki bayi kullanıcısı hesabına yeni bir Domain ekler.

Url

Method POST

Url ~/Api/v1/Reseller/AddDomain

Parametreler




domainName Zorunlu alanSistemde daha önce bulunmayan bir domain ismi olmalıdır. FQDNstandartlarında alanadı değeri verilmelidir.Tip: StringVarsayılan Değer: Empty

planAlias Zorunlu AlanDomain Planı oluştururken "alias" kısmında verilen isim. Hostingaçılmadan önce "Domain Planları"'dan planın oluşturulmasıgerekiyor. Bu plan username alanında belirtilmiş olan bayikullanıcısına ait olması gerekmektedir.Tip: StringVarsayılan Değer: Empty

domainUsername Zorunlu AlanKullanıcı adına ihtiyaç duyulan modüller kullanır. Örneğin: FTPTip: String

83MaestroPanel



domainPassword Zorunlu AlanŞifre ihtiyacı duyan modüler kullanır. Örneğin: FTP, EmailTip: StringVarsayılan Değer: Empty

activedomainuser Opsiyonel AlanHosting oluşturulurken aynı zamanda domain kullanıcısınıda oluştururve kullanıma hazır halde getirir. Domain'in müstakil olarakyönetilebilmesini sağlar.Tip: BooleanAlabildiği Değerler: ture, false Varsayılan Değer: false

firstname Opsiyonel AlanBu alanın aktif olabilmesi için "activedomainuser" parametresinin trueolması gerekiyor. Alanadı kullanıcısının ismini tanımlayabileceğinizalan.Tip: StringVarsayılan Değer: null

lastname Opsiyonel AlanBu alanın aktif olabilmesi için "activedomainuser" parametresinin trueolması gerekiyor. Alanadı kullanıcısının soyismini tanımlayabileceğinizalan.Tip: StringVarsayılan Değer: null

email Opsiyonel AlanBu alanın aktif olabilmesi için "activedomainuser" parametresinin trueolması gerekiyor. Alanadı kullanıcısının email adresinitanımlayabileceğiniz alan.Tip: StringVarsayılan Değer: null

expiration Opsiyonel AlanOluşturulan web sitesinin sonlanma tarihini belirler. Boş bırakıldığıtaktirde planAlias 'da verilen Domain Planına göre hareket eder.Tarih formatı yyyyMMdd şeklinde olmalıdır. Örn: 20121028Tip: StringVarsayılan Değer: null

İstek

POSThttp://contoso.com:9715/Api/v1/Reseller/AddDomain?key=1_17449299035c40f0926538271320de25&username=reseller&domainName=demo.net&planAlias=Deneme&domainUsername=demo.net&domainPassword=osman12!&activedomainuser=false

84MaestroPanel


Cevap: Xml

200 0 Domain created successfully: demo.net 0 Domain created successfully: demo.net 0

Cevap: Json

{ "Details" : { "ClientId" : 0, "ClientName" : null, "Code" : 0, "Message" : "Domain created successfully: demo.net" }, "ErrorCode" : 0, "Message" : "Domain created successfully: demo.net", "StatusCode" : 200}

Reseller/DeleteDomain

MaestroPanel'de ki bayi kullanıcı hesabından domain siler.

Url

Method DELETE

Url ~/Api/v1/Reseller/DeleteDomain

85MaestroPanel


Parametreler




domainName Zorunlu alanBayi kullanıcısınna tanımlanmış olan domain adı.Tip: StringVarsayılan Değer: Empty

İstek

DELETEhttp://contoso.com:9715/Api/v1/Reseller/DeleteDomain?key=1_17449299035c40f0926538271320de25&username=reseller&domainName=demo.net

Cevap: Xml

200 0 Domain deleted successfully: demo.net 0 Domain deleted successfully: demo.net 0

86MaestroPanel


Cevap: Json

{ "Details" : { "ClientId" : 0, "ClientName" : null, "Code" : 0, "Message" : "Domain deleted successfully: demo.net" }, "ErrorCode" : 0, "Message" : "Domain deleted successfully: demo.net", "StatusCode" : 200}

Reseller/GetDomains

MaestroPanel'deki bayinin sahip olduğu domain listesini verir. XML, JSON veya TEXT formatındaçıktı verebilir.

Url

Method GET

Url ~/Api/v1/Reseller/GetDomains

Parametreler




87MaestroPanel


İstek

GEThttp://contoso.com:9715/Api/v1/Reseller/GetDomains?key=1_17449299035c40f092653827132

maestropanel api · 2013. 9. 27. · maestropanel rest* api, domain, bayi (reseller) ve sunucu...

Documents