{ "swagger": "2.0", "info": { "description": "Our HTTP [REST API](https:\/\/en.wikipedia.org\/wiki\/Representational_state_transfer) allows you to manage vital details of your account and services in client portal. [JSON](http:\/\/www.json.org\/) is used for all API returns.", "version": "4.20251104", "title": "Your Business Name User API" }, "host": "ote.tino.org", "basePath": "\/api", "tags": [ { "name": "Clientarea" }, { "name": "Billing" }, { "name": "Support" }, { "name": "Domains" }, { "name": "SSL Certificates" }, { "name": "Services" }, { "name": "DNS" }, { "name": "Language" }, { "name": "Affiliate" }, { "name": "Security" }, { "name": "Cart" }, { "name": "Cloud Instance" } ], "schemes": [ "https" ], "paths": { "\/token": { "post": { "tags": [ "Clientarea" ], "summary": "Refresh Token", "description": "Generate new authorization token using refresh token", "operationId": "refreshToken", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "refresh_token", "type": "string", "in": "query", "description": "Refresh token previously obtained from `POST \/login`" } ], "responses": { "200": { "description": "`Success`" } } } }, "\/logout": { "post": { "tags": [ "Clientarea" ], "summary": "Logout", "description": "Invalidate authorization token", "operationId": "dropToken", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "`Success`" } } } }, "\/revoke": { "post": { "tags": [ "Clientarea" ], "summary": "Revoke Token", "description": "Invalidate authorization and refresh token.\nPass refresh token or call this method with valid access token", "operationId": "revokeToken", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "refresh_token", "type": "string", "in": "query" } ], "responses": { "200": { "description": "`Success`" } } } }, "\/passwordreset": { "post": { "tags": [ "Clientarea" ], "summary": "Password Reset", "description": "Request password reset email for account", "operationId": "postReminder", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "email", "type": "string", "in": "query", "description": "EMail address" } ], "responses": { "200": { "description": "`Success`" } } } }, "\/logs": { "get": { "tags": [ "Clientarea" ], "summary": "User Logs", "description": "Returns logs from history", "operationId": "getLogs", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "`Success`" } } } }, "\/affiliates\/summary": { "get": { "tags": [ "Affiliate" ], "summary": "Affiliate Info", "description": "", "operationId": "getAffiliateInfo", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "`Success`" } } } }, "\/affiliates\/campaigns": { "get": { "tags": [ "Clientarea" ], "summary": "Get Affiliate campaigns", "description": "", "operationId": "affiliates_campaigns", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "`Success`" } } } }, "\/affiliates\/commissions": { "get": { "tags": [ "Affiliate" ], "summary": "Affiliate Commissions", "description": "", "operationId": "getAffiliateCommision", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "`Success`" } } } }, "\/affiliates\/payouts": { "get": { "tags": [ "Affiliate" ], "summary": "Affiliate Payouts", "description": "", "operationId": "getAffiliatePayouts", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "`Success`" } } } }, "\/affiliates\/vouchers": { "get": { "tags": [ "Affiliate" ], "summary": "Affiliate Vouchers", "description": "", "operationId": "getAffiliateVouchers", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "`Success`" } } } }, "\/affiliates\/commissionplans": { "get": { "tags": [ "Clientarea" ], "summary": "Get Affiliate commission plans", "description": "", "operationId": "affiliates_commission_plans", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "`Success`" } } } }, "\/contact": { "get": { "tags": [ "Clientarea" ], "summary": "List contacts", "description": "Return a list of contacts on this account", "operationId": "profiles", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "```json\n\r{\n \"contacts\": [\n {\n \"email\": \"mary@example.com\",\n \"id\": \"49\",\n \"firstname\": \"Mary\",\n \"lastname\": \"Sue\",\n \"companyname\": \"\",\n \"company\": \"0\",\n \"lastlogin\": \"0000-00-00 00:00:00\"\n }\n ]\n}" } } }, "post": { "tags": [ "Clientarea" ], "summary": "Add contact", "description": "Create new contact account, if password is provided you\ncan use provided email addres to login as that contact.", "operationId": "profiles_add", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "password", "type": "string", "in": "query", "description": "Optional, allows you to login as contact" }, { "name": "privileges", "type": "array", "in": "query", "description": "Array with privileges that you want to enable. Formatted the same way as output from GET \/contact\/privileges<\/code>", "items": { "type": "string" } }, { "name": "email", "type": "string", "in": "query", "description": "Email Address" }, { "name": "firstname", "type": "string", "in": "query", "description": "First Name" }, { "name": "lastname", "type": "string", "in": "query", "description": "Last Name" }, { "name": "companyname", "type": "string", "in": "query", "description": "Organization" }, { "name": "address1", "type": "string", "in": "query", "description": "Address 1" }, { "name": "city", "type": "string", "in": "query", "description": "City" }, { "name": "state", "type": "string", "in": "query", "description": "State" }, { "name": "country", "type": "string", "in": "query", "description": "Country" }, { "name": "phonenumber", "type": "string", "in": "query", "description": "Phone" }, { "name": "type", "type": "string", "in": "query", "description": "Account Type", "enum": [ "Private", "Company" ] } ], "responses": { "200": { "description": "`Success`" } } } }, "\/contact\/privileges": { "get": { "tags": [ "Clientarea" ], "summary": "Contact privileges", "description": "List possible contact privileges.\nEach domain and service may list additional privileges, depending on available features.
", "operationId": "profile_privs", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "```json\n\r{\n \"privileges\": {\n \"billing\": [\n \"emails\", \/\/ Receive billing notifications\n \"payinvoice\", \/\/ Allow to view\/pay invoices\n \"orders\", \/\/ Allow to place new orders\n \"balance\", \/\/ View account balance\n \"addfunds\", \/\/ Add account funds\n \"creditcard\" \/\/ Edit Credit Card details\n ],\n \"support\": [\n \"newticket\", \/\/ Open new tickets\n \"tickets\", \/\/ View all tickets\n \"closeticket\", \/\/ Close tickets\n \"emails\" \/\/ Receive email notifications from support\n ],\n \"misc\": [\n \"editmain\", \/\/ Modify main profile details\n \"emails\", \/\/ View emails history\n \"editipaccess\", \/\/ Edit allowed IP access\n \"manageprofiles\", \/\/ Add \/ Edit contacts\n \"affiliates\" \/\/ Access affiliates section\n ],\n \"services\": {\n \"full\": 1, \/\/ Full control over services\n \"332\": [\n \"basic\", \/\/ View basic details\n \"billing\", \/\/ View billing info\n \"cancelation\", \/\/ Request cancellation\n \"upgrade\", \/\/ Upgrade \/ Downgrade\n \"notify\", \/\/ Receive related email notifications \n (...)\n \"logindetails\"\n ]\n },\n \"domains\": {\n \"full\": 1, \/\/ Full control over domains\n \"523\": [\n \"basic\", \/\/ View basic details\n \"renew\", \/\/ Renew domain\n \"notify\", \/\/ Receive related email notifications \n \"contactinfo\", \/\/ Contact Information\n (...)\n \"nameservers\" \/\/ Manage Nameservers\n ]\n }\n }\n}" } } } }, "\/contact\/{id}": { "get": { "tags": [ "Clientarea" ], "summary": "Get contacts details", "description": "Return array with contact details", "operationId": "profile_data", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Contact ID", "required": true } ], "responses": { "200": { "description": "```json\n\r{\n \"contact\": {\n \"id\": \"49\",\n \"email\": \"mary@example.com\",\n \"firstname\": \"Mary\",\n \"lastname\": \"Sue\",\n \"companyname\": \"\",\n \"address1\": \"Pretty View Lane\",\n \"address2\": \"3194\",\n \"city\": \"Santa Rosa\",\n \"state\": \"California\",\n \"postcode\": \"95401\",\n \"country\": \"US\",\n \"phonenumber\": \"+1.24123123\",\n \"type\": \"Private\",\n \"privileges\" : {\n \"support\" : [\"tickets\", \"newticket\"]\n }\n }\n}" } } }, "put": { "tags": [ "Clientarea" ], "summary": "Edit contact", "description": "Change contact details`", "operationId": "profile_edit", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Contact ID", "required": true }, { "name": "privileges", "type": "array", "in": "query", "description": "Array with privileges that you want to enable. Formatted the same way as output from GET \/contact\/privileges<\/code>", "items": { "type": "string" } }, { "name": "email", "type": "string", "in": "query", "description": "Email Address" }, { "name": "firstname", "type": "string", "in": "query", "description": "First Name" }, { "name": "lastname", "type": "string", "in": "query", "description": "Last Name" }, { "name": "companyname", "type": "string", "in": "query", "description": "Organization" }, { "name": "address1", "type": "string", "in": "query", "description": "Address 1" }, { "name": "city", "type": "string", "in": "query", "description": "City" }, { "name": "state", "type": "string", "in": "query", "description": "State" }, { "name": "country", "type": "string", "in": "query", "description": "Country" }, { "name": "phonenumber", "type": "string", "in": "query", "description": "Phone" }, { "name": "type", "type": "string", "in": "query", "description": "Account Type", "enum": [ "Private", "Company" ] } ], "responses": { "200": { "description": "`Success`" } } } }, "\/notifications": { "get": { "tags": [ "Clientarea" ], "summary": "List all portal notifications", "description": "Return a list of all portal notifications.", "operationId": "notifications", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "rel_type", "type": "string", "in": "query", "description": "Optional, return only by relation type" }, { "name": "rel_id", "type": "string", "in": "query", "description": "Optional, return only by relation id" } ], "responses": { "200": { "description": "`Success`" } } } }, "\/notifications\/new": { "get": { "tags": [ "Clientarea" ], "summary": "List new portal notifications", "description": "Return only new portal notifications.", "operationId": "notifications_new", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "rel_type", "type": "string", "in": "query", "description": "Optional, return only by relation type" }, { "name": "rel_id", "type": "string", "in": "query", "description": "Optional, return only by relation id" } ], "responses": { "200": { "description": "`Success`" } } } }, "\/notifications\/{id}\/ack": { "put": { "tags": [ "Clientarea" ], "summary": "Acknowledge notification", "description": "Marks the notification as read", "operationId": "notifications_set_seen", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "string", "in": "path", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/login": { "post": { "tags": [ "Clientarea" ], "summary": "User Login", "description": "Return Client details", "operationId": "userLogin", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "username", "type": "string", "in": "query", "description": "Your acount email address" }, { "name": "password", "type": "string", "in": "query", "description": "Account password" }, { "name": "remember", "type": "boolean", "in": "query", "description": "Remember login session with 360 day" } ], "responses": { "200": { "description": "`Success`" } } } }, "\/login-sso": { "post": { "tags": [ "Clientarea" ], "summary": "Login", "description": "Return Client", "operationId": "userLoginSSO", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "`Success`" } } } }, "\/details": { "get": { "tags": [ "Clientarea" ], "summary": "User Details", "description": "Return registration details for my account", "operationId": "getDetails", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "`Success`" } } }, "put": { "tags": [ "Clientarea" ], "summary": "Update User Details", "description": "Update registration details under my account", "operationId": "postDetails", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "firstname", "type": "string", "in": "query", "description": "First Name" }, { "name": "lastname", "type": "string", "in": "query", "description": "Last Name" }, { "name": "companyname", "type": "string", "in": "query", "description": "Organization" }, { "name": "address1", "type": "string", "in": "query", "description": "Address 1" }, { "name": "city", "type": "string", "in": "query", "description": "City" }, { "name": "state", "type": "string", "in": "query", "description": "State" }, { "name": "country", "type": "string", "in": "query", "description": "Country" }, { "name": "phonenumber", "type": "string", "in": "query", "description": "Phone" }, { "name": "type", "type": "string", "in": "query", "description": "Account Type", "enum": [ "Private", "Company" ] } ], "responses": { "200": { "description": "`Success`" } } } }, "\/password\/change": { "post": { "tags": [ "Clientarea" ], "summary": "Change Password", "description": "Change password", "operationId": "clientChangePassword", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "oldpassword", "type": "string", "in": "query", "description": "old password" }, { "name": "password", "type": "string", "in": "query", "description": "New password" }, { "name": "password2", "type": "string", "in": "query", "description": "New password" } ], "responses": { "200": { "description": "`Success`" } } } }, "\/password\/forgot": { "post": { "tags": [ "Clientarea" ], "summary": "Forgot Password", "description": "forgot password", "operationId": "clientForgotPassword", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "`Success`" } } } }, "\/password\/passreset": { "post": { "tags": [ "Clientarea" ], "summary": "Validate Reset Password", "description": "Validate Reset Password From email link active", "operationId": "clientResetPassword", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "activate", "type": "string", "in": "query", "description": "activate code" } ], "responses": { "200": { "description": "`Success`" } } } }, "\/clientarea": { "get": { "tags": [ "Clientarea" ], "summary": "Summany info", "description": "", "operationId": "getClientarea", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "`Success`" } } } }, "\/clientarea\/statuses": { "get": { "tags": [ "Clientarea" ], "summary": "List status key", "description": "", "operationId": "getStatuses", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "`Success`" } } } }, "\/clientarea\/histories": { "get": { "tags": [ "Clientarea" ], "summary": "List history", "description": "", "operationId": "getHistories", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "`Success`" } } } }, "\/clientarea\/history\/emails": { "get": { "tags": [ "Clientarea" ], "summary": "Emails history", "description": "", "operationId": "getEmails", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "`Success`" } } } }, "\/clientarea\/history\/emails\/{id}": { "get": { "tags": [ "Clientarea" ], "summary": "Email Details", "description": "", "operationId": "getEmailDetails", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Email ID", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/clientarea\/nav\/service": { "get": { "tags": [ "Clientarea" ], "summary": "Service menus", "description": "Get list Categories for Service.", "operationId": "getServiceNav", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "`Success`" } } } }, "\/clientarea\/search\/{query}": { "post": { "tags": [ "Clientarea" ], "summary": "Search Service\/Product", "description": "", "operationId": "searchServices", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "query", "type": "string", "in": "path", "description": "Value to search", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/downloads": { "get": { "tags": [ "Clientarea" ], "summary": "Downloads", "description": "", "operationId": "downloads", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "`Success`" } } } }, "\/download\/{id}": { "get": { "tags": [ "Clientarea" ], "summary": "Download File", "description": "", "operationId": "downloadFile", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/changeowner": { "get": { "tags": [ "Clientarea" ], "summary": "ChangeOwner Service", "description": "S\u1eed d\u1ee5ng: &rel_id=:serviceId&rel_type=:ServiceType&make=(reject|approve) \u0111\u1ec3 x\u00e1c nh\u1eadn hay h\u1ee7y", "operationId": "ChangeOwnerService", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "`Success`" } } } }, "\/contacts": { "get": { "tags": [ "Clientarea" ], "summary": "List contacts", "description": "Return a list of contacts on this account", "operationId": "Clientarea_profiles", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "`Success`" } } } }, "\/clientarea\/settings": { "get": { "tags": [ "Clientarea" ], "summary": "Get Client Settings", "description": "", "operationId": "getClientSettings", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "`Success`" } } }, "post": { "tags": [ "Clientarea" ], "summary": "Update Client Settings", "description": "", "operationId": "postClientSettings", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "configs", "type": "array", "in": "query", "description": "Value to setting: RecordsPerPage, DefaultTimezone, DefaultPaymentModule, CreditAutoApply, ClientNotifications, DefaultNameservers", "items": { "type": "string" } } ], "responses": { "200": { "description": "`Success`" } } } }, "\/verification\/verify": { "post": { "tags": [ "Clientarea" ], "summary": "Account Verification", "description": "", "operationId": "AccountVerification", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "code", "type": "string", "in": "query" }, { "name": "type", "type": "string", "in": "query", "description": "sms\/email" } ], "responses": { "200": { "description": "`Success`" } } } }, "\/verification\/resend": { "post": { "tags": [ "Clientarea" ], "summary": "Resend Verification", "description": "", "operationId": "ResendAccountVerification", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "code", "type": "string", "in": "query" }, { "name": "type", "type": "string", "in": "query", "description": "sms\/email" } ], "responses": { "200": { "description": "`Success`" } } } }, "\/checkemail": { "post": { "tags": [ "Clientarea" ], "summary": "Verify Email Exists", "description": "Return exists email client", "operationId": "checkEmailExists", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "email", "type": "string", "in": "query", "description": "Your acount email address" } ], "responses": { "200": { "description": "`Success`" } } } }, "\/signup": { "post": { "tags": [ "Clientarea" ], "summary": "Sign up", "description": "Create new account", "operationId": "postSignup", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "email", "type": "string", "in": "query", "description": "Email Address" }, { "name": "password", "type": "string", "in": "query", "description": "Password" }, { "name": "firstname", "type": "string", "in": "query", "description": "First Name" }, { "name": "lastname", "type": "string", "in": "query", "description": "Last Name" }, { "name": "companyname", "type": "string", "in": "query", "description": "Organization" }, { "name": "address1", "type": "string", "in": "query", "description": "Address 1" }, { "name": "city", "type": "string", "in": "query", "description": "City" }, { "name": "state", "type": "string", "in": "query", "description": "State" }, { "name": "country", "type": "string", "in": "query", "description": "Country" }, { "name": "phonenumber", "type": "string", "in": "query", "description": "Phone" }, { "name": "type", "type": "string", "in": "query", "description": "Account Type", "enum": [ "Private", "Company" ] }, { "name": "currency", "type": "string", "in": "query", "description": "Currency", "enum": [ "VND" ] } ], "responses": { "200": { "description": "`Success`" } } } }, "\/submit_contactform": { "post": { "tags": [ "Clientarea" ], "summary": "submit contact form", "description": "ok", "operationId": "submitContactFoem", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "cfmName", "type": "string", "in": "query", "description": "Your acount email address" }, { "name": "cfmPhone", "type": "string", "in": "query", "description": "Your acount email address" }, { "name": "cfmEmail", "type": "string", "in": "query", "description": "Your acount email address" }, { "name": "cfmMessage", "type": "string", "in": "query", "description": "Your acount email address" } ], "responses": { "200": { "description": "`Success`" } } } }, "\/status": { "get": { "tags": [ "Clientarea" ], "summary": "status server api", "description": "Return only new portal notifications.", "operationId": "sv_status", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "`Success`" } } } }, "\/balance": { "get": { "tags": [ "Billing" ], "summary": "Account balance", "description": "Get current account balance(unpaid invoices total), account credit", "operationId": "getBalance", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "```json\n\r{\n {\n \"success\": true,\n \"details\": {\n \"currency\": \"USD\",\n \"acc_balance\": \"123456.55\",\n \"acc_credit\": \"0.00\"\n }\n }\n}" } } } }, "\/invoice": { "get": { "tags": [ "Billing" ], "summary": "List Invoices", "description": "List all invoices under my account", "operationId": "getInvoices", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "```json\n\r{\n \"invoices\": [\n {\n \"id\": \"308976\",\n \"date\": \"2016-12-30\",\n \"dateorig\": \"2016-12-30\",\n \"duedate\": \"2017-01-06\",\n \"paybefore\": \"2017-01-06\",\n \"total\": \"19.65\",\n \"datepaid\": \"2016-12-30 12:40:47\",\n \"status\": \"Paid\",\n \"merge_id\": null,\n \"number\": \"2016\\\/12\\\/1\",\n \"currency\": \"USD\"\n }\n ]\n}" } } } }, "\/invoice\/{id}": { "get": { "tags": [ "Billing" ], "summary": "Invoice Details", "description": "Get invoice details", "operationId": "getInvoiceDetails", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "string", "in": "path", "required": true } ], "responses": { "200": { "description": "```json\n\r{\n \"invoice\": {\n \"id\": \"308976\",\n \"status\": \"Paid\",\n \"date\": \"2016-12-30\",\n \"duedate\": \"2017-01-06\",\n \"paybefore\": \"2017-01-06\",\n \"datepaid\": \"2016-12-30 12:40:47\",\n \"subtotal\": 16.24,\n \"credit\": 0,\n \"tax\": 3.41,\n \"taxrate\": 21,\n \"tax2\": 0,\n \"taxrate2\": 0,\n \"taxexempt\": \"0\",\n \"total\": 19.65,\n \"rate\": 1,\n \"rate2\": 0,\n \"rate3\": 1,\n \"notes\": \"\",\n \"items\": [\n {\n \"id\": \"12305\",\n \"invoice_id\": \"308976\",\n \"type\": \"Other\",\n \"item_id\": \"0\",\n \"description\": \"Example Service\",\n \"amount\": \"15.00\",\n \"taxed\": \"1\",\n \"qty\": \"1.00\",\n \"linetotal\": \"15.00\"\n },\n {\n \"id\": \"12309\",\n \"invoice_id\": \"308976\",\n \"type\": \"Other\",\n \"item_id\": \"-2\",\n \"description\": \"PayPal Payment Fee\",\n \"amount\": \"1.24\",\n \"taxed\": \"1\",\n \"qty\": \"1.00\",\n \"linetotal\": \"1.24\"\n }\n ],\n \"client\": {\n \"id\": \"26\",\n \"email\": \"api@example.com\",\n \"firstname\": \"Joe\",\n \"lastname\": \"Doe\",\n \"companyname\": \"\",\n \"address1\": \"Pretty View Lane\",\n \"address2\": \"3194\",\n \"city\": \"Santa Rosa\",\n \"state\": \"California\",\n \"postcode\": \"95401\",\n \"country\": \"US\",\n \"phonenumber\": \"+1.24123123\"\n },\n \"number\": \"2016\\\/12\\\/1\",\n \"currency\": \"USD\"\n }\n}" } } }, "delete": { "tags": [ "Billing" ], "summary": "Delete Invoice", "description": "", "operationId": "delInvoice", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Invoice id", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/invoice\/{id}\/credit": { "post": { "tags": [ "Billing" ], "summary": "Apply Credit", "description": "Calculate order cost and recurring prices for selected items.\nUse the same parameters as for `POST \/order`", "operationId": "applyCreditToInvoice", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Payment method ID", "required": true }, { "name": "amount", "type": "string", "in": "query" } ], "responses": { "200": { "description": "`Success`" } } } }, "\/invoice\/{id}\/pdf": { "post": { "tags": [ "Billing" ], "summary": "Invoice PDF", "description": "Get specific invoice PDF", "operationId": "getInvoicePdf", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "string", "in": "path", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/currencies": { "get": { "tags": [ "Billing" ], "summary": "Currencies List", "description": "Return currencies details", "operationId": "getCurrencies", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "`Success`" } } } }, "\/billing\/creditlogs": { "get": { "tags": [ "Billing" ], "summary": "Credit logs", "description": "", "operationId": "getCreditLogs", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "`Success`" } } } }, "\/billing\/creditvoucher": { "post": { "tags": [ "Billing" ], "summary": "Redeem a voucher", "description": "Using Redeem a voucher", "operationId": "addCreditVoucher", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "code", "type": "string", "in": "query", "description": "Voucher Code" } ], "responses": { "200": { "description": "`Success`" } } } }, "\/billing\/addfunds": { "post": { "tags": [ "Billing" ], "summary": "Add Funds", "description": "Create Invoice Add Credits", "operationId": "addFunds", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "funds", "type": "integer", "in": "query", "description": "Amount of money" }, { "name": "gateway", "type": "integer", "in": "query", "description": "Payment Method" } ], "responses": { "200": { "description": "`Success`" } } } }, "\/invoices": { "get": { "tags": [ "Billing" ], "summary": "List Invoices", "description": "List all invoices under my account
Using: &page=&perpage= for pagination. page start 0.
filter[service_status]= search invoice by service status, filter[service]= search invoice by service id", "operationId": "Billing_getInvoices", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "`Success`" } } } }, "\/invoices\/due": { "get": { "tags": [ "Billing" ], "summary": "List Invoices Due", "description": "List all invoices due under my account
Using: &page=&perpage= for pagination. page start 0", "operationId": "getInvoicesDue", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "`Success`" } } } }, "\/invoices\/payall": { "post": { "tags": [ "Billing" ], "summary": "Payall Invoice", "description": "", "operationId": "payall", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "selected", "type": "array", "in": "query", "description": "selected invoice id", "items": { "type": "string" } } ], "responses": { "200": { "description": "`Success`" } } } }, "\/estimates": { "get": { "tags": [ "Billing" ], "summary": "List Estimates", "description": "List all estimates under my account
Using: &page=&perpage= for pagination. page start 0.
filter[service_status]= search invoice by service status, filter[service]= search invoice by service id", "operationId": "getEstimates", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "`Success`" } } } }, "\/estimates\/{id}": { "get": { "tags": [ "Billing" ], "summary": "Estimates Details", "description": "", "operationId": "getEstimatesDetail", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "string", "in": "path", "description": "Estimates id", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/estimate\/{id}\/pdf": { "get": { "tags": [ "Billing" ], "summary": "Download Invoice Pdf", "description": "", "operationId": "pdfEstimate", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/billing\/{invoice_id}\/pay\/{gateway_id}": { "get": { "tags": [ "Billing" ], "summary": "Payment link", "description": "Get Payment link from Gateways.", "operationId": "getPaymentMethod", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "invoice_id", "type": "integer", "in": "path", "description": "Invoice ID", "required": true }, { "name": "gateway_id", "type": "integer", "in": "path", "description": "Gateway ID", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/payment": { "get": { "tags": [ "Billing" ], "summary": "Payment Methods", "description": "List available payment methods", "operationId": "paymethod", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "`Success`" } } } }, "\/payment\/fees": { "get": { "tags": [ "Billing" ], "summary": "Payment Methods Fees", "description": "List available payment methods with fees", "operationId": "paymethod_fee", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "`Success`" } } } }, "\/tickets": { "get": { "tags": [ "Support" ], "summary": "List Tickets", "description": "List support tickets under my account", "operationId": "getTickets", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "`Success`" } } }, "post": { "tags": [ "Support" ], "summary": "Create Ticket", "description": "Submit new ticket", "operationId": "createTicket", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "dept_id", "type": "integer", "in": "query", "description": "Department id " }, { "name": "subject", "type": "string", "in": "query", "description": "Ticket subject " }, { "name": "body", "type": "string", "in": "query", "description": "Ticket message " } ], "responses": { "200": { "description": "`Success`" } } } }, "\/tickets\/{number}": { "get": { "tags": [ "Support" ], "summary": "Ticket details", "description": "Get ticket details, including all replies", "operationId": "getTicketDetails", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "number", "type": "integer", "in": "path", "description": "Ticket number", "required": true } ], "responses": { "200": { "description": "```json\n\r{\n \"ticket\": {\n \"date\": \"2016-12-30 12:48:13\",\n \"ticket_number\": \"736633\",\n \"name\": \"Joe Doe\",\n \"email\": \"api@example.com\",\n \"subject\": \"Lore Ipsum\",\n \"body\": \"Donec sollicitudin molestie malesuada. \\r\\nSed porttitor lectus nibh. Vivamus magna justo, \\r\\nlacinia eget consectetur sed, convallis at tellus.\",\n \"status\": \"Answered\",\n \"client_read\": \"1\",\n \"deptname\": \"Billing\"\n },\n \"replies\": [\n {\n \"id\": \"929\",\n \"name\": \"Suppport Staff\",\n \"date\": \"2016-12-30 12:51:04\",\n \"body\": \"Vestibulum ac diam sit amet quam \\r\\nvehicula elementum sed sit amet dui. \\r\\nPraesent sapien massa\\r\\n\\r\\n-- Maecenas efficitur elit est --\",\n \"status\": \"Sent\",\n \"type\": \"Admin\"\n }\n ]\n}" } } }, "post": { "tags": [ "Support" ], "summary": "Create Reply", "description": "Reply to ticket", "operationId": "createTicketReply", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "number", "type": "integer", "in": "path", "description": "Ticket number", "required": true }, { "name": "body", "type": "string", "in": "query", "description": "Reply message " } ], "responses": { "200": { "description": "`Success`" } } } }, "\/ticket\/attachment\/{file}": { "get": { "tags": [ "Support" ], "summary": "Ticket attachment", "description": "Get ticket attachment", "operationId": "getTicketAttachment", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "number", "type": "integer", "in": "query", "description": "Ticket number" }, { "name": "file", "type": "string", "in": "path", "description": "Attachment id", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/tickets\/{number}\/open": { "put": { "tags": [ "Support" ], "summary": "Re-open ticket", "description": "Try to re-open closed ticket", "operationId": "reopenTicket", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "number", "type": "integer", "in": "path", "description": "Ticket number", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/tickets\/{number}\/close": { "put": { "tags": [ "Support" ], "summary": "Close ticket", "description": "Send request to close a ticket", "operationId": "closeTicket", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "number", "type": "integer", "in": "path", "description": "Ticket number", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/ticket\/departments": { "get": { "tags": [ "Support" ], "summary": "List ticket departments", "description": "Get the list of ticket departments", "operationId": "listTicketDepartments", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "`Success`" } } } }, "\/news": { "get": { "tags": [ "Support" ], "summary": "List News", "description": "List News", "operationId": "getNews", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "`Success`" } } } }, "\/news\/{news_id}": { "get": { "tags": [ "Support" ], "summary": "Get news item", "description": "Returns details of the news item", "operationId": "getNewsItem", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "news_id", "type": "string", "in": "path", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/knowledgebase": { "get": { "tags": [ "Support" ], "summary": "List all knowledgebase categories", "description": "Returns list all knowledgebase categories", "operationId": "getKnowledgebaseCategories", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "`Success`" } } } }, "\/knowledgebase\/{category_id}": { "get": { "tags": [ "Support" ], "summary": "Get knowledgebase category details", "description": "Returns subcategories and articles of the knowledgebase category", "operationId": "getKnowledgebaseCategoryDetails", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "category_id", "type": "string", "in": "path", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/knowledgebase\/article\/{article_id}": { "get": { "tags": [ "Support" ], "summary": "Get knowledgebase article", "description": "Returns an article details", "operationId": "getKnowledgebaseArticleDetails", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "article_id", "type": "string", "in": "path", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/domain": { "get": { "tags": [ "Domains" ], "summary": "List Domains", "description": "List domains under your account", "operationId": "domain", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "```json\n\r{\n \"domains\": [\n {\n \"id\": \"47\",\n \"name\": \"testname.com\",\n \"expires\": \"2017-12-30\",\n \"recurring_amount\": \"15.00\",\n \"date_created\": \"2016-12-30\",\n \"status\": \"Active\",\n \"period\": \"1\",\n \"autorenew\": \"1\",\n \"daytoexpire\": \"365\"\n }\n ]\n}" } } } }, "\/domain\/{id}": { "get": { "tags": [ "Domains" ], "summary": "Domain details", "description": "Get domain details", "operationId": "domainDetails", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Domain id", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/domain\/name\/{name}": { "get": { "tags": [ "Domains" ], "summary": "Domain details by name", "description": "Get domain details by name", "operationId": "domainNameDetails", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "name", "type": "string", "in": "path", "description": "Domain name", "required": true } ], "responses": { "200": { "description": "```json\n\r{\n \"details\": [\n {\n \"id\": \"47\",\n \"name\": \"testname.com\",\n \"date_created\": \"2016-12-30\",\n \"firstpayment\": \"10.00\",\n \"recurring_amount\": \"15.00\",\n \"period\": \"1\",\n \"expires\": \"2017-12-30\",\n \"status\": \"Active\",\n \"next_due\": \"2017-12-30\",\n \"next_invoice\": \"2017-11-30\",\n \"idprotection\": \"0\",\n \"nameservers\": [\n \"ns1.example.com\",\n \"ns2.example.com\",\n \"ns3.example.com\",\n \"ns4.example.com\"\n ],\n \"autorenew\": \"1\"\n },\n {\n \"id\": \"48\",\n \"name\": \"testname.com\",\n \"date_created\": \"2016-05-30\",\n \"firstpayment\": \"10.00\",\n \"recurring_amount\": \"15.00\",\n \"period\": \"1\",\n \"expires\": \"2017-05-30\",\n \"status\": \"Expired\",\n \"next_due\": \"2017-05-30\",\n \"next_invoice\": \"2017-04-30\",\n \"idprotection\": \"0\",\n \"nameservers\": [\n \"ns1.example.com\",\n \"ns2.example.com\",\n \"ns3.example.com\",\n \"ns4.example.com\"\n ],\n \"autorenew\": \"1\"\n },\n ]\n}" } } } }, "\/domain\/{id}\/ns": { "get": { "tags": [ "Domains" ], "summary": "Get domain nameservers", "description": "", "operationId": "domain_ns_get", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Domain id", "required": true } ], "responses": { "200": { "description": "`Success`" } } }, "put": { "tags": [ "Domains" ], "summary": "Update domain nameservers", "description": "Change domain nameservers, if `$nameservers` is left empty, default namesevers will be used", "operationId": "domain_ns", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Domain id", "required": true }, { "name": "nameservers", "type": "array", "in": "query", "description": "List of nameservers to use", "items": { "type": "string" } } ], "responses": { "200": { "description": "`Success`" } } } }, "\/domain\/{id}\/reg": { "post": { "tags": [ "Domains" ], "summary": "Register domain nameservers", "description": "", "operationId": "domain_ns_reg", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Domain id", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/domain\/{id}\/dns": { "get": { "tags": [ "Domains" ], "summary": "DNS Records\nDNS Records", "description": "List DNS records", "operationId": "domain_dns", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Domain id", "required": true } ], "responses": { "200": { "description": "```json\n\r{\n \"records\": [\n {\n \"id\": 1,\n \"name\": \"test\",\n \"ttl\": 0,\n \"priority\": 0,\n \"type\": \"A\",\n \"content\": \"100.100.10.1\"\n }\n ]\n}" } } }, "post": { "tags": [ "Domains" ], "summary": "Create DNS Records", "description": "Add a new DNS record", "operationId": "domain_dns_add", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Domain id", "required": true }, { "name": "name", "type": "string", "in": "query", "description": "Reord name" }, { "name": "type", "type": "string", "in": "query", "description": "Reord type" }, { "name": "priority", "type": "string", "in": "query", "description": "Reord priority" }, { "name": "content", "type": "string", "in": "query", "description": "Reord content eg. IP addres for A records" } ], "responses": { "200": { "description": "`Success`" } } } }, "\/domain\/{id}\/dns\/{index}": { "put": { "tags": [ "Domains" ], "summary": "Update DNS Records", "description": "Change a DNS record", "operationId": "domain_dns_upd", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Domain id", "required": true }, { "name": "record_id", "type": "integer", "in": "query", "description": "Recod index" }, { "name": "name", "type": "string", "in": "query", "description": "Record name" }, { "name": "type", "type": "string", "in": "query", "description": "Record type" }, { "name": "priority", "type": "string", "in": "query", "description": "Record priority" }, { "name": "content", "type": "string", "in": "query", "description": "Record content eg. IP address for A records" }, { "name": "index", "type": "string", "in": "path", "required": true } ], "responses": { "200": { "description": "`Success`" } } }, "delete": { "tags": [ "Domains" ], "summary": "Remove DNS Records", "description": "Remove a DNS record", "operationId": "domain_dns_del", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Domain id", "required": true }, { "name": "record_id", "type": "integer", "in": "query", "description": "Recod index" }, { "name": "index", "type": "string", "in": "path", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/domain\/{id}\/dns\/types": { "get": { "tags": [ "Domains" ], "summary": "DNS Records Types", "description": "List supported records type", "operationId": "domain_dns_suported", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Domain id", "required": true } ], "responses": { "200": { "description": "```json\n\r{\n \"types\": [\n \"A\",\n \"CNAME\",\n \"URL\",\n \"FRAME\",\n \"MX\",\n \"MXE\",\n \"TXT\"\n ]\n}" } } } }, "\/domain\/{id}\/epp": { "get": { "tags": [ "Domains" ], "summary": "Get domain EPP Code", "description": "", "operationId": "domain_eppcode", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Domain id", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/domain\/{id}\/sync": { "get": { "tags": [ "Domains" ], "summary": "Synchronize domain", "description": "", "operationId": "domain_sync", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Domain id", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/domain\/{id}\/reglock": { "get": { "tags": [ "Domains" ], "summary": "Get domain lock", "description": "", "operationId": "domain_reglock", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Domain id", "required": true } ], "responses": { "200": { "description": "`Success`" } } }, "put": { "tags": [ "Domains" ], "summary": "Update domain lock", "description": "", "operationId": "domain_reglock_update", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Domain id", "required": true }, { "name": "switch", "type": "boolean", "in": "query", "description": "Enable or disable domain lock, use true to enable. " } ], "responses": { "200": { "description": "`Success`" } } } }, "\/domain\/{id}\/idprotection": { "put": { "tags": [ "Domains" ], "summary": "Update domain ID Protection", "description": "", "operationId": "domain_idprotection_update", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Domain id", "required": true }, { "name": "switch", "type": "boolean", "in": "query", "description": "Enable or disable ID orotection, use true to enable. " } ], "responses": { "200": { "description": "`Success`" } } } }, "\/domain\/{id}\/contact": { "get": { "tags": [ "Domains" ], "summary": "Get domain contact info", "description": "", "operationId": "domain_contact_get", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Domain id", "required": true } ], "responses": { "200": { "description": "```json\n\r{\n \"success\": true,\n \"domain_id\": \"428\",\n \"contact_info\": {\n \"registrant\": {\n \"firstname\": \"\",\n \"lastname\": \"\",\n \"companyname\": \"\",\n \"email\": \"\",\n \"phonenumber\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postcode\": \"\",\n \"country\": \"\"\n },\n \"tech\": {\n \"firstname\": \"\",\n \"lastname\": \"\",\n \"companyname\": \"\",\n \"email\": \"\",\n \"phonenumber\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postcode\": \"\",\n \"country\": \"\"\n },\n \"admin\": {\n \"firstname\": \"\",\n \"lastname\": \"\",\n \"companyname\": \"\",\n \"email\": \"\",\n \"phonenumber\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postcode\": \"\",\n \"country\": \"\"\n },\n \"billing\": {\n \"firstname\": \"\",\n \"lastname\": \"\",\n \"companyname\": \"\",\n \"email\": \"\",\n \"phonenumber\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postcode\": \"\",\n \"country\": \"\"\n }\n }\n}" } } }, "put": { "tags": [ "Domains" ], "summary": "Update domain contact info", "description": "", "operationId": "domain_contact_update", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Domain id", "required": true }, { "name": "contact_info", "type": "array", "in": "query", "items": { "type": "string" } } ], "responses": { "200": { "description": "`Success`" } } } }, "\/domain\/{id}\/emforwarding": { "get": { "tags": [ "Domains" ], "summary": "Get email forwarding", "description": "", "operationId": "domain_email_forwarding", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Domain id", "required": true } ], "responses": { "200": { "description": "`Success`" } } }, "put": { "tags": [ "Domains" ], "summary": "Update email forwarding", "description": "", "operationId": "domain_email_forwarding_update", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Domain id", "required": true }, { "name": "from", "type": "string", "in": "query", "description": "Email address that you want to forward " }, { "name": "to", "type": "string", "in": "query", "description": "Email address that will receive forwarded emails " } ], "responses": { "200": { "description": "`Success`" } } } }, "\/domain\/{id}\/forwarding": { "put": { "tags": [ "Domains" ], "summary": "Update domain forwarding", "description": "", "operationId": "domain_forwarding_update", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Domain id", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/domain\/{id}\/autorenew": { "get": { "tags": [ "Domains" ], "summary": "Get domain autorenew", "description": "", "operationId": "domain_autorenew", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Domain id", "required": true } ], "responses": { "200": { "description": "`Success`" } } }, "put": { "tags": [ "Domains" ], "summary": "Enable\/disable domain autorenew", "description": "", "operationId": "domain_autorenew_update", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Domain id", "required": true }, { "name": "autorenew", "type": "boolean", "in": "query" } ], "responses": { "200": { "description": "`Success`" } } } }, "\/domain\/{id}\/dnssec\/flags": { "get": { "tags": [ "Domains" ], "summary": "Returns the available flags", "description": "", "operationId": "domain_dnssec_get_flags", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Domain id", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/domain\/{id}\/dnssec": { "get": { "tags": [ "Domains" ], "summary": "Returns the list of DNSSEC keys", "description": "", "operationId": "domain_dnssec_get", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Domain id", "required": true } ], "responses": { "200": { "description": "`Success`" } } }, "put": { "tags": [ "Domains" ], "summary": "Adds the DNSSEC key", "description": "", "operationId": "domain_dnssec_add", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Domain id", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/domain\/{id}\/dnssec\/{key}": { "delete": { "tags": [ "Domains" ], "summary": "", "description": "", "operationId": "domain_dnssec_remove", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Domain id", "required": true }, { "name": "key", "type": "string", "in": "path", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/domain\/lookup": { "post": { "tags": [ "Domains" ], "summary": "Domain availability", "description": "Check if domain is available for registration. Returns status: \"ok\" if domain is available, empty response otherwise", "operationId": "tn_domain_lookup", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "name", "type": "string", "in": "query", "description": "Domain name, ie. example.com" } ], "responses": { "200": { "description": "`Success`" } } } }, "\/domain\/order": { "get": { "tags": [ "Domains" ], "summary": "Available TLDs", "description": "List TLDs available for registration and transfer", "operationId": "domain_tlds", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "```json\n\r{\n \"tlds\": [\n {\n \"id\": \"6\",\n \"tld\": \".com\",\n \"periods\": [\n {\n \"period\": \"1\",\n \"register\": \"10.00\",\n \"transfer\": \"0.00\",\n \"renew\": \"15.00\",\n \"redemption\": \"40.00\"\n },\n {\n \"period\": \"2\",\n \"register\": \"20.00\",\n \"transfer\": \"20.00\",\n \"renew\": \"30.00\",\n \"redemption\": \"80.00\"\n }\n ]\n },\n (...)\n ]\n}" } } }, "post": { "tags": [ "Domains" ], "summary": "Order new domain", "description": "Create new order for a domain, please check if requested domain is available first,\notherwise your order may get cancelled.", "operationId": "tino_domain_order", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "name", "type": "string", "in": "query", "description": "Domain name " }, { "name": "years", "type": "string", "in": "query", "description": "Number of years" }, { "name": "action", "type": "string", "in": "query", "description": "register|transfer" }, { "name": "tld_id", "type": "string", "in": "query", "description": "TLD id" }, { "name": "pay_method", "type": "integer", "in": "query", "description": "Payment method ID" }, { "name": "epp", "type": "string", "in": "query", "description": "EPP Transfer code, required when transfering some domains" }, { "name": "nameservers", "type": "array", "in": "query", "description": "Optional array with 2 - 4 nameservers that you want to use", "items": { "type": "string" } }, { "name": "registrant", "type": "integer", "in": "query", "description": "Optional contact ID to use for registrant contact this domain" }, { "name": "admin", "type": "integer", "in": "query", "description": "Optional contact ID to use for admin contact this domain" }, { "name": "tech", "type": "integer", "in": "query", "description": "Optional contact ID to use for tech contact this domain" }, { "name": "billing", "type": "integer", "in": "query", "description": "Optional contact ID to use for billing contact this domain" }, { "name": "data", "type": "array", "in": "query", "description": "Addditional data required for some TLDs", "items": { "type": "string" } } ], "responses": { "200": { "description": "`Success`" } } } }, "\/domain\/order\/{id}\/form": { "get": { "tags": [ "Domains" ], "summary": "Additinal data for TLD", "description": "Get additional forms required for some TLDs", "operationId": "domain_tld_froms", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "tld_id", "type": "integer", "in": "query", "description": "TLD ID" }, { "name": "id", "type": "string", "in": "path", "required": true } ], "responses": { "200": { "description": "```json\n\r{\n \"forms\": [\n {\n \"type\": \"domaindnssupport\",\n \"title\": \"DNS Management\",\n \"id\": \"1424\",\n \"firstItemId\": 9067,\n \"description\": \"\",\n \"name\": \"custom[1424][9067]\",\n \"required\": false,\n \"multiple\": false,\n \"config\": {\n \"enableddefault\": 0\n },\n \"value\": [],\n \"textvalue\": [],\n \"price\": 0,\n \"recurring_price\": 0,\n \"setup\": 0,\n \"prorata_date\": null,\n \"items\": [\n {\n \"title\": \"\",\n \"value\": 1,\n \"id\": 9067,\n \"price\": 4,\n \"setup\": 0,\n \"selected\": false\n }\n ]\n },\n {\n \"type\": \"select\",\n \"title\": \"Language\",\n \"id\": \"1755\",\n \"firstItemId\": 10952,\n \"description\": \"\",\n \"name\": \"custom[1755]\",\n \"required\": false,\n \"multiple\": false,\n \"config\": {\n \"conditionals\": []\n },\n \"value\": [],\n \"textvalue\": [],\n \"price\": 0,\n \"recurring_price\": 0,\n \"setup\": 0,\n \"prorata_date\": null,\n \"items\": [\n {\n \"title\": \"AFR\",\n \"value\": 1,\n \"id\": 10952,\n \"price\": 0,\n \"setup\": 0,\n \"selected\": false\n },\n {\n \"title\": \"ALB\",\n \"value\": 1,\n \"id\": 10953,\n \"price\": 0,\n \"setup\": 0,\n \"selected\": false\n },\n (...)\n ]\n }\n ]\n}" } } } }, "\/domain\/{id}\/renew": { "post": { "tags": [ "Domains" ], "summary": "Renew domain", "description": "Create new renew order for a domain, please check if requested domain is available first, otherwise your order may get cancelled.", "operationId": "domain_renew", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "years", "type": "string", "in": "query", "description": "Number of years" }, { "name": "pay_method", "type": "integer", "in": "query", "description": "Payment method ID" }, { "name": "id", "type": "string", "in": "path", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/domains": { "get": { "tags": [ "Domains" ], "summary": "List Domains", "description": "List domains under your account
Using: &page=&perpage= for pagination. page start 0", "operationId": "getMyDomain", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "`Success`" } } } }, "\/whois\/{domain}": { "get": { "tags": [ "Domains" ], "summary": "Whois Domain", "description": "Whois Domain", "operationId": "whoisDomain", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "domain", "type": "string", "in": "path", "description": "Domain", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/domain\/{id}\/invoices": { "get": { "tags": [ "Domains" ], "summary": "Domain Invoice Related", "description": "Returns details of the DNS zone", "operationId": "domain_related_invoices", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Domain ID", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/certificate": { "get": { "tags": [ "SSL Certificates" ], "summary": "List SSL Certificates", "description": "List all ssl services under your account", "operationId": "certificate", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "```json\n\r{\n \"sslservices\": [\n {\n \"id\": \"300\",\n \"domain\": \"examplename.com\",\n \"total\": \"27.85\",\n \"status\": \"Pending\",\n \"billingcycle\": \"Annually\",\n \"next_due\": \"2017-12-30\",\n \"category\": \"GoGetSSL\",\n \"category_url\": \"gogetssl\",\n \"name\": \"Comodo InstantSSL\",\n \"cert_email\": \"admin@example.com\",\n \"cert_status\": \"\",\n \"cert_expires\": \"2017-12-30 13:43:12\"\n }\n ]\n}" } } } }, "\/certificate\/{id}": { "get": { "tags": [ "SSL Certificates" ], "summary": "Certificate details", "description": "Return details for certificate `@id`", "operationId": "certificate_details", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Service id", "required": true } ], "responses": { "200": { "description": "```json\n\r{\n \"service\": {\n \"id\": \"300\",\n \"date_created\": \"2016-12-30\",\n \"domain\": \"examplename.com\",\n \"firstpayment\": \"27.85\",\n \"total\": \"27.85\",\n \"billingcycle\": \"Annually\",\n \"next_due\": \"2017-12-30\",\n \"next_invoice\": \"2017-10-31\",\n \"status\": \"Pending\",\n \"label\": \"\",\n \"name\": \"Comodo InstantSSL\",\n \"cert_status\": \"\",\n \"cert_expires\": \"2017-12-30 13:43:12\",\n \"csr\": \"-----BEGIN CERTIFICATE REQUEST----- ...\",\n \"contacts\": {\n \"admin\": {\n \"FName\": \"Mary\",\n \"LName\": \"Sue\",\n \"City\": \"Santa Rosa\",\n \"State\": \"California\",\n \"PostalCode\": \"95401\",\n \"EmailAddress\": \"mary@example.com\",\n \"Country\": \"US\",\n \"Address1\": \"Pretty View Lane\",\n \"Address2\": \"3194\",\n \"Phone\": 24123223,\n \"OrgName\": \"n\\\/a\",\n \"PreFix\": 1,\n \"JobTitle\": \"n\\\/a\"\n },\n \"billing\": {\n (...)\n },\n \"tech\": {\n (...)\n }\n },\n \"organization\": {\n \"state\": \"Texas\",\n \"country\": \"US\",\n \"name\": \"My Org name\",\n \"unit\": \"Dev\",\n \"locality\": \"SanAntonio\",\n \"postalcode\": \"n\\\/a\",\n \"address2\": \"n\\\/a\",\n \"address1\": \"n\\\/a\",\n },\n \"cert_email\": \"admin@example.com\",\n \"software\": \"1\"\n }\n}" } } } }, "\/certificate\/{id}\/crt": { "get": { "tags": [ "SSL Certificates" ], "summary": "Download certificate", "description": "Return X.509 certificate data", "operationId": "certificate_crt", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Service id", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/certificate\/order": { "get": { "tags": [ "SSL Certificates" ], "summary": "List available certificates", "description": "Return a list with certificate available for purchase", "operationId": "certificate_products", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "```json\n\r{\n \"products\": [\n {\n \"id\": \"25\",\n \"name\": \"InstantSSL\",\n \"description\": \"\",\n \"periods\": [\n {\n \"years\": 1,\n \"price\": 27.85,\n \"renew\": 27.85\n },\n {\n \"years\": 2,\n \"price\": 48.75,\n \"renew\": 48.75\n }\n ],\n \"category\": \"SSL Certificates\",\n \"category_url\": \"sslcertificates\"\n },\n (...)\n ]\n}" } } }, "post": { "tags": [ "SSL Certificates" ], "summary": "Order new certificates", "description": "Create new order for a certificate", "operationId": "certificate_order", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "product_id", "type": "integer", "in": "query", "description": "Certificate product ID" }, { "name": "csr", "type": "string", "in": "query", "description": "Domain name " }, { "name": "years", "type": "integer", "in": "query", "description": "Number of years" }, { "name": "pay_method", "type": "integer", "in": "query", "description": "Payment method ID" }, { "name": "approver_email", "type": "string", "in": "query", "description": "Email addres used in domain validation" }, { "name": "admin", "type": "integer", "in": "query", "description": "Admin contact ID" }, { "name": "tech", "type": "integer", "in": "query", "description": "Tech contact ID" }, { "name": "billing", "type": "integer", "in": "query", "description": "Billing contact ID" }, { "name": "organization", "type": "array", "in": "query", "description": "Organization details", "items": { "type": "string" } }, { "name": "software", "type": "integer", "in": "query", "description": "Server\/Software ID" }, { "name": "data", "type": "array", "in": "query", "description": "Addditional data required for some products", "items": { "type": "string" } } ], "responses": { "200": { "description": "`Success`" } } } }, "\/certificate\/order\/{product_id}\/software": { "get": { "tags": [ "SSL Certificates" ], "summary": "List server software for certificates", "description": "Return a list with software IDs required or certificate", "operationId": "certificate_software", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "product_id", "type": "integer", "in": "path", "description": "Certificate product ID", "required": true } ], "responses": { "200": { "description": "```json\n\r{\n \"software\": [\n {\n \"id\": 0,\n \"name\": \"AOL\"\n },\n {\n \"id\": 1,\n \"name\": \"Apache-SSL (Ben-SSL, not Stronghold)\"\n },\n (...)\n ]\n}" } } } }, "\/certificates": { "get": { "tags": [ "SSL Certificates" ], "summary": "List SSL Certificates", "description": "List all ssl services under your account", "operationId": "SSL Certificates_certificate", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "`Success`" } } } }, "\/service": { "get": { "tags": [ "Services" ], "summary": "List services", "description": "List all services under your account", "operationId": "getServices", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{id}": { "get": { "tags": [ "Services" ], "summary": "Service details", "description": "Return details for service `@id`", "operationId": "serviceDetails", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Service id", "required": true } ], "responses": { "200": { "description": "```json\n\r{\n \"service\": {\n \"id\": \"301\",\n \"date_created\": \"2016-12-30\",\n \"domain\": \"examplename.com\",\n \"firstpayment\": \"9.99\",\n \"total\": \"9.99\",\n \"billingcycle\": \"Monthly\",\n \"next_due\": \"2017-12-30\",\n \"next_invoice\": \"2017-01-27\",\n \"status\": \"Active\",\n \"label\": \"\",\n \"username\": \"examplen\",\n \"password\": \"pdtzc\",\n \"name\": \"Starter Hosting\"\n }\n}" } } } }, "\/service\/{id}\/methods": { "get": { "tags": [ "Services" ], "summary": "List service methods", "description": "List methods available for service", "operationId": "serviceMethods", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "string", "in": "path", "required": true } ], "responses": { "200": { "description": "```json\n\r{\n \"methods\": [\n {\n \"name\": \"Upgrade Request\",\n \"method\": \"POST\",\n \"route\": \"\\\/service\\\/@id\\\/upgrade\"\n },\n {\n \"name\": \"Upgrade Options\",\n \"method\": \"GET\",\n \"route\": \"\\\/service\\\/@id\\\/upgrade\"\n },\n {\n \"name\": \"Change service label\",\n \"method\": \"POST\",\n \"route\": \"\\\/service\\\/@id\\\/label\"\n },\n {\n \"name\": \"Service label\",\n \"method\": \"GET\",\n \"route\": \"\\\/service\\\/@id\\\/label\"\n },\n {\n \"name\": \"Cancel Service\",\n \"method\": \"POST\",\n \"route\": \"\\\/service\\\/@id\\\/cancel\"\n }\n ]\n}" } } } }, "\/service\/{id}\/upgrade": { "get": { "tags": [ "Services" ], "summary": "Upgrade Options", "description": "List upgrade options", "operationId": "upgrade", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "string", "in": "path", "required": true } ], "responses": { "200": { "description": "```json\n\r{\n \"resources\": [\n {\n \"id\": 1557,\n \"name\": \"Bandwidth\",\n \"type\": \"select\",\n \"items\": [\n {\n \"id\": \"9953\",\n \"name\": \"100 GB\",\n \"price\": 1,\n \"setup_price\": 0,\n \"selected\": true\n },\n {\n \"id\": \"10103\",\n \"name\": \"500 GB\",\n \"price\": 5,\n \"setup_price\": 0,\n \"selected\": false\n },\n {\n \"id\": \"10104\",\n \"name\": \"1 TB\",\n \"price\": 10,\n \"setup_price\": 0,\n \"selected\": false\n }\n ]\n }\n ],\n \"package\": []\n}" } } }, "post": { "tags": [ "Services" ], "summary": "Upgrade Request", "description": "Estimate or request upgrade\n\n```json\n\/\/ Format of ''resources'' paremeter\n{\n \"resource_id\" : \"qty_value\", \/\/ sliders & qty fields\n \"resource_id\" : \"item_id\", \/\/ dropdown & radio fields\n \"resource_id\" : {\n \"item_id\": \"qty_value\" \/\/ dropdown with qty field\n }\n}\n```", "operationId": "upgrade_test", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Service id", "required": true }, { "name": "resources", "type": "array", "in": "query", "description": "array with resource values", "items": { "type": "string" } }, { "name": "package", "type": "integer", "in": "query", "description": "New package id, optonal when upgrading resources" }, { "name": "cycle", "type": "string", "in": "query", "description": "New billing cycle, optonal when upgrading resources" }, { "name": "send", "type": "boolean", "in": "query", "description": "Set to true when you want to send your upgrade request" } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{id}\/cancel": { "post": { "tags": [ "Services" ], "summary": "Cancel Service", "description": "Request service cancellation", "operationId": "service_cancel", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Service id", "required": true }, { "name": "immediate", "type": "string", "in": "query", "description": "set to false<\/code> to terminate service at the end of billing date, true<\/code> - terminate immediately" }, { "name": "reason", "type": "string", "in": "query", "description": "Reason for this request" } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{id}\/label": { "get": { "tags": [ "Services" ], "summary": "Service label", "description": "Show current service label", "operationId": "service_get_label", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Service id", "required": true } ], "responses": { "200": { "description": "```json\n\r{\n \"label\": \"example\"\n}" } } }, "post": { "tags": [ "Services" ], "summary": "Change service label", "description": "Set new custom label to identify this service", "operationId": "service_set_label", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Service id", "required": true }, { "name": "label", "type": "string", "in": "query", "description": "New label" } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{id}\/renew": { "post": { "tags": [ "Services" ], "summary": "Manual Service Renew", "description": "Generate an invoice to renew the service.", "operationId": "service_renew", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Service id", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{id}\/cycle": { "get": { "tags": [ "Services" ], "summary": "List Billing Cycle", "description": "Get recurring billing cycle options", "operationId": "service_cycle", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Service id", "required": true } ], "responses": { "200": { "description": "```json\n\r{\n \"current\": \"m\",\n \"cycles\": {\n \"m\": \"14.95\",\n \"a\": \"179.40\",\n \"b\": \"358.80\"\n }\n}" } } }, "post": { "tags": [ "Services" ], "summary": "Change Billing Cycle", "description": "Change recurring billing cycle for the service", "operationId": "service_cycle_set", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Service id", "required": true }, { "name": "cycle", "type": "string", "in": "query", "description": "New billing cycle" } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{id}\/vms": { "get": { "tags": [ "Services" ], "summary": "List VMs", "description": "List virtual servers", "operationId": "vms", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "string", "in": "path", "required": true } ], "responses": { "200": { "description": "`Success`" } } }, "post": { "tags": [ "Services" ], "summary": "Create VM", "description": "Add new virtual server", "operationId": "vms_create", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "label", "type": "string", "in": "query", "description": "VM label" }, { "name": "template", "type": "string", "in": "query", "description": "Template ID" }, { "name": "memory", "type": "string", "in": "query", "description": "Amount of RAM memory in MB" }, { "name": "cpu", "type": "string", "in": "query", "description": "Amount of CPU cores" }, { "name": "disk", "type": "string", "in": "query", "description": "Disk Space in GB" }, { "name": "interface", "type": "array", "in": "query", "description": "Interface configuration", "items": { "type": "string" } }, { "name": "id", "type": "string", "in": "path", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{id}\/vms\/{vmid}": { "get": { "tags": [ "Services" ], "summary": "Get VM Details", "description": "Get the details of a particular virtual server", "operationId": "vms_get", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "vmid", "type": "string", "in": "path", "description": "Virtual server id", "required": true }, { "name": "id", "type": "string", "in": "path", "required": true } ], "responses": { "200": { "description": "`Success`" } } }, "delete": { "tags": [ "Services" ], "summary": "Destroy VM", "description": "Remove virtual server", "operationId": "vms_delete", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "vmid", "type": "string", "in": "path", "description": "Virtual server id", "required": true }, { "name": "id", "type": "string", "in": "path", "required": true } ], "responses": { "200": { "description": "`Success`" } } }, "put": { "tags": [ "Services" ], "summary": "Resize VM", "description": "Edit a virtual server", "operationId": "vms_edit", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "vmid", "type": "string", "in": "path", "description": "Virtual server id", "required": true }, { "name": "memory", "type": "string", "in": "query", "description": "Amount of RAM in MB" }, { "name": "cpu", "type": "string", "in": "query", "description": "Amount of CPU cores" }, { "name": "id", "type": "string", "in": "path", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{id}\/vms\/{vmid}\/stop": { "post": { "tags": [ "Services" ], "summary": "Stop VM", "description": "Stop virtual server", "operationId": "vms_stop", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "vmid", "type": "string", "in": "path", "description": "Virtual server id", "required": true }, { "name": "id", "type": "string", "in": "path", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{id}\/vms\/{vmid}\/start": { "post": { "tags": [ "Services" ], "summary": "Start VM", "description": "Start virtual server", "operationId": "vms_start", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "vmid", "type": "string", "in": "path", "description": "Virtual server id", "required": true }, { "name": "id", "type": "string", "in": "path", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{id}\/vms\/{vmid}\/shutdown": { "post": { "tags": [ "Services" ], "summary": "Shutdown VM", "description": "Perform graceful shutdown", "operationId": "vms_shutdown", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "vmid", "type": "string", "in": "path", "description": "Virtual server id", "required": true }, { "name": "id", "type": "string", "in": "path", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{id}\/vms\/{vmid}\/reboot": { "post": { "tags": [ "Services" ], "summary": "Reboot VM", "description": "Reboot virtual server", "operationId": "vms_reboot", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "vmid", "type": "string", "in": "path", "description": "Virtual server id", "required": true }, { "name": "id", "type": "string", "in": "path", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{id}\/vms\/{vmid}\/reset": { "post": { "tags": [ "Services" ], "summary": "Reset VM", "description": "Reset virtual server power", "operationId": "vms_reset", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "vmid", "type": "string", "in": "path", "description": "Virtual server id", "required": true }, { "name": "id", "type": "string", "in": "path", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{id}\/vms\/{vmid}\/hostname": { "post": { "tags": [ "Services" ], "summary": "Change VM Hostname", "description": "Update virtual machine hostname", "operationId": "vms_hostname", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "hostname", "type": "string", "in": "query", "description": "New hostname for the VM" }, { "name": "id", "type": "string", "in": "path", "required": true }, { "name": "vmid", "type": "string", "in": "path", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{id}\/vms\/{vmid}\/rebuild": { "post": { "tags": [ "Services" ], "summary": "Rebuild VM", "description": "Rebuild server, you can get list of templates supported by this server\nusing '''\/service\/$id\/templates'''", "operationId": "vms_rebuild", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "template", "type": "string", "in": "query", "description": "Template ID" }, { "name": "id", "type": "string", "in": "path", "required": true }, { "name": "vmid", "type": "string", "in": "path", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{id}\/vms\/{vmid}\/ips": { "get": { "tags": [ "Services" ], "summary": "List IPs", "description": "List virtual machine IPs", "operationId": "vm_interface_list_ip", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "type", "type": "string", "in": "query", "description": "ipv4 or ipv6" }, { "name": "iface", "type": "integer", "in": "query", "description": "Interface number [optional]" }, { "name": "bridge", "type": "string", "in": "query", "description": "Bridge name [optional, ignored if interface provided]" }, { "name": "id", "type": "string", "in": "path", "required": true }, { "name": "vmid", "type": "string", "in": "path", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{id}\/vms\/{vmid}\/ippool": { "get": { "tags": [ "Services" ], "summary": "List IP Pools", "description": "List IP pools for a specific interface or network bridge", "operationId": "vm_interface_list_iplist", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "iface", "type": "integer", "in": "query", "description": "Interface number [optional]" }, { "name": "bridge", "type": "string", "in": "query", "description": "Bridge name [optional, ignored if interface provided]" }, { "name": "id", "type": "string", "in": "path", "required": true }, { "name": "vmid", "type": "string", "in": "path", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{id}\/vms\/{vmid}\/ippool\/{pool}": { "post": { "tags": [ "Services" ], "summary": "Allocate IPs", "description": "Allocate new IP for network interface.", "operationId": "vm_interface_allocate_ip", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "pool", "type": "string", "in": "path", "description": "List ID to allocate new IP from", "required": true }, { "name": "type", "type": "string", "in": "query", "description": "ipv4 or ipv6" }, { "name": "iface", "type": "integer", "in": "query", "description": "Interface number" }, { "name": "bridge", "type": "string", "in": "query", "description": "Bridge name [optional, ignored if interface provided]" }, { "name": "number", "type": "integer", "in": "query", "description": "Number of IPs to allocate" }, { "name": "id", "type": "string", "in": "path", "required": true }, { "name": "vmid", "type": "string", "in": "path", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{id}\/networks": { "get": { "tags": [ "Services" ], "summary": "List available networks", "description": "List of networks and IP pools that can be used for VM creation", "operationId": "networks", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "string", "in": "path", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{id}\/vms\/{vmid}\/interfaces": { "get": { "tags": [ "Services" ], "summary": "List VM Network Interfaces", "description": "Get network interfaces assigned to virtual server", "operationId": "vm_interface_list", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "string", "in": "path", "required": true }, { "name": "vmid", "type": "string", "in": "path", "required": true } ], "responses": { "200": { "description": "`Success`" } } }, "post": { "tags": [ "Services" ], "summary": "Add Network Interface", "description": "Add new network interface to VM", "operationId": "vm_interface_create", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "bridge", "type": "string", "in": "query", "description": "Network bridge" }, { "name": "firewall", "type": "integer", "in": "query", "description": "Enable or disable firewall (may require specific permissions)" }, { "name": "ipv4", "type": "array", "in": "query", "description": "List of IP v4 IDs", "items": { "type": "string" } }, { "name": "ipv6", "type": "array", "in": "query", "description": "List of IP v6 IDs", "items": { "type": "string" } }, { "name": "id", "type": "string", "in": "path", "required": true }, { "name": "vmid", "type": "string", "in": "path", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{id}\/vms\/{vmid}\/interfaces\/{iface}": { "get": { "tags": [ "Services" ], "summary": "Get Network Interfaces", "description": "Get network Interface details", "operationId": "vm_interface_details", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "iface", "type": "string", "in": "path", "description": "Interface name or id, ie '0' or 'net0'", "required": true }, { "name": "id", "type": "string", "in": "path", "required": true }, { "name": "vmid", "type": "string", "in": "path", "required": true } ], "responses": { "200": { "description": "`Success`" } } }, "put": { "tags": [ "Services" ], "summary": "Update Network Interface", "description": "Update network interface details", "operationId": "vm_interface_update", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "iface", "type": "integer", "in": "path", "description": "Interface number", "required": true }, { "name": "firewall", "type": "integer", "in": "query", "description": "Enable or disable firewall (may require specific permissions)" }, { "name": "ipv4", "type": "array", "in": "query", "description": "List of IP v4 IDs", "items": { "type": "string" } }, { "name": "ipv6", "type": "array", "in": "query", "description": "List of IP v6 IDs", "items": { "type": "string" } }, { "name": "id", "type": "string", "in": "path", "required": true }, { "name": "vmid", "type": "string", "in": "path", "required": true } ], "responses": { "200": { "description": "`Success`" } } }, "delete": { "tags": [ "Services" ], "summary": "Remove Network Interface", "description": "Remove network interface from VM", "operationId": "vm_interface_remove", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "iface", "type": "string", "in": "path", "description": "Interface name or id to remove", "required": true }, { "name": "id", "type": "string", "in": "path", "required": true }, { "name": "vmid", "type": "string", "in": "path", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{id}\/templates": { "get": { "tags": [ "Services" ], "summary": "List OS templates", "description": "List templates that can be used to create virtual server", "operationId": "templates", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "string", "in": "path", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{id}\/resources": { "get": { "tags": [ "Services" ], "summary": "Resources", "description": "Show available and used resources", "operationId": "resources", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "string", "in": "path", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/services\/active": { "get": { "tags": [ "Services" ], "summary": "Get list services active", "description": "Get list services active", "operationId": "tngGetServiceActive", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "`Success`" } } } }, "\/services\/{cid}": { "get": { "tags": [ "Services" ], "summary": "List services by category", "description": "List all services under your account by Category id.
filter[hide_terminated]=1 filter[hide_cancelled]=1 filter[hide_suspended]=1 filter[hide_fraud]=1 filter[status]=Active", "operationId": "getServiceByCategory", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "cid", "type": "integer", "in": "path", "description": "Category id, 0 to get all", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{id}\/widgets": { "get": { "tags": [ "Services" ], "summary": "List services widgets", "description": "List all services widgets", "operationId": "serviceWidgets", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Service id", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{id}\/vms\/{vmid}\/traffic": { "get": { "tags": [ "Services" ], "summary": "Get VM Traffic", "description": "Get the details of a particular virtual server", "operationId": "vms_get_traffic", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "required": true }, { "name": "vmid", "type": "string", "in": "path", "description": "Virtual server id", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{id}\/emails": { "get": { "tags": [ "Services" ], "summary": "Get Emails Account", "description": "Get the details of a particular virtual server", "operationId": "cpanel2_getEmailAccounts", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Service ID", "required": true }, { "name": "module", "type": "string", "in": "path", "description": "Service type module (Cpanel2|DirectAdmin2|Zimbra|Wilduck)", "required": true } ], "responses": { "200": { "description": "`Success`" } } }, "post": { "tags": [ "Services" ], "summary": "Create Emails Account", "description": "Get the details of a particular virtual server", "operationId": "cpanel2_createEmailAccount", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Service ID", "required": true }, { "name": "module", "type": "string", "in": "path", "description": "Service type module (Cpanel2|DirectAdmin2|Zimbra|Wilduck)", "required": true }, { "name": "name", "type": "string", "in": "path", "description": "Email account without domain", "required": true }, { "name": "passmain", "type": "string", "in": "path", "description": "Password for email account", "required": true }, { "name": "passcheck", "type": "string", "in": "path", "description": "Password confirm for email account", "required": true }, { "name": "quota", "type": "integer", "in": "path", "description": "Email Quote (Megabytes)", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{id}\/emails\/change": { "post": { "tags": [ "Services" ], "summary": "Update Emails Account", "description": "Get the details of a particular virtual server", "operationId": "cpanel2_changeEmailAccount", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Service ID", "required": true }, { "name": "module", "type": "string", "in": "path", "description": "Service type module (Cpanel2|DirectAdmin2|Zimbra|Wilduck)", "required": true }, { "name": "change", "type": "Array", "in": "path", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{id}\/emails\/delete": { "post": { "tags": [ "Services" ], "summary": "Delete Email Account", "description": "Get the details of a particular virtual server", "operationId": "cpanel2_deleteEmailAccount", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Service ID", "required": true }, { "name": "module", "type": "string", "in": "path", "description": "Service type module (Cpanel2|DirectAdmin2|Zimbra|Wilduck)", "required": true }, { "name": "deluser", "type": "string", "in": "path", "description": "Email account", "required": true }, { "name": "domain", "type": "string", "in": "path", "description": "Password for email account", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/cpanel2\/{id}\/backup": { "get": { "tags": [ "Services" ], "summary": "Get cPanel Backup", "description": "Get the details of a particular virtual server", "operationId": "cpanel2_get_backup", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/cpanel2\/{id}\/login": { "get": { "tags": [ "Services" ], "summary": "Get cPanel link login", "description": "Get the details of a particular virtual server", "operationId": "cpanel2_autologin", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/cpanel2\/{id}\/phpmyadminlogin": { "get": { "tags": [ "Services" ], "summary": "Get cPanel phpmyadmin login", "description": "Get the details of a particular virtual server", "operationId": "cpanel2_phpmyadmin_login", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/cpanel2\/{id}\/statistics": { "get": { "tags": [ "Services" ], "summary": "Get cPanel statistics", "description": "Get the details of a particular virtual server", "operationId": "cpanel2_statistics", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/cpanel2\/{id}\/unblock": { "post": { "tags": [ "Services" ], "summary": "Get cPanel unblock ip", "description": "Get the details of a particular virtual server", "operationId": "cpanel2_unblock", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/cpanel2\/{id}\/changepasss": { "get": { "tags": [ "Services" ], "summary": "Change Passs cPanel", "description": "Get the details of a particular virtual server", "operationId": "cpanel2_changepasss", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/cpanel2\/{id}\/resetacount": { "post": { "tags": [ "Services" ], "summary": "Reset Acount cPanel", "description": "", "operationId": "cpanel2_resetacount", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/cpanel2\/{id}\/changedomain": { "post": { "tags": [ "Services" ], "summary": "Change Domain cPanel", "description": "", "operationId": "cpanel2_primarydomain", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "required": true }, { "name": "domain", "type": "string", "in": "path", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{id}\/manualrenew": { "post": { "tags": [ "Services" ], "summary": "Manual renew Service", "description": "Check if domain is available for registration. Returns status: \"ok\" if domain is available, empty response otherwise", "operationId": "manualrenew", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "string", "in": "path", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{id}\/invoices": { "get": { "tags": [ "Services" ], "summary": "Service Invoice Related", "description": "Returns details of the DNS zone", "operationId": "service_related_invoices", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Service ID", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/dns": { "get": { "tags": [ "DNS" ], "summary": "List DNS", "description": "Returns a list of all DNS", "operationId": "dns_get", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "```json\n\r{\n \"service_ids\": [\n \"10\",\n \"20\"\n ],\n \"zones\": [\n {\n \"domain_id\": \"60\",\n \"name\": \"qwerty.com\",\n \"service_id\": \"10\"\n },\n {\n \"domain_id\": \"61\",\n \"name\": \"bgg12ooble.com\",\n \"service_id\": \"20\"\n }\n ]\n}" } } } }, "\/service\/{service_id}\/dns": { "post": { "tags": [ "DNS" ], "summary": "Add DNS Zone", "description": "Creates a new DNS zone", "operationId": "dns_add_zone", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "service_id", "type": "integer", "in": "path", "description": "Service ID", "required": true }, { "name": "name", "type": "string", "in": "query", "description": "Zone name " } ], "responses": { "200": { "description": "`Success`" } } }, "get": { "tags": [ "DNS" ], "summary": "List DNS for service", "description": "Returns a list of DNS zones under the service", "operationId": "dns_list_zones", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "service_id", "type": "integer", "in": "path", "description": "Service ID", "required": true } ], "responses": { "200": { "description": "```json\n\r{\n \"error\": [\n \"invalid method\"\n ]\n}" } } } }, "\/service\/{service_id}\/dns\/{zone_id}": { "get": { "tags": [ "DNS" ], "summary": "Get DNS details", "description": "Returns details of the DNS zone", "operationId": "dns_get_zone", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "service_id", "type": "integer", "in": "path", "description": "Service ID", "required": true }, { "name": "zone_id", "type": "integer", "in": "path", "description": "Zone ID", "required": true } ], "responses": { "200": { "description": "```json\n\r{\n \"service_id\": 10,\n \"name\": \"qwerty.com\",\n \"records\": [\n {\n \"id\":\"10\",\n \"name\":\"qwerty\",\n \"ttl\":1800,\n \"priority\":0,\n \"content\":\"127.0.0.1\",\n \"type\":\"A\"\n },\n {\n \"id\":\"11\",\n \"name\":\"qwerty\",\n \"ttl\":1800,\n \"priority\":0,\n \"content\":\"ns1.qwerty.com\",\n \"type\":\"NS\"\n }\n ]\n}" } } }, "delete": { "tags": [ "DNS" ], "summary": "Remove DNS zone", "description": "Deletes the selected DNS zone", "operationId": "dns_delete_zone", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "service_id", "type": "integer", "in": "path", "description": "Service ID", "required": true }, { "name": "zone_id", "type": "integer", "in": "path", "description": "Zone ID", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{service_id}\/dns\/{zone_id}\/records": { "post": { "tags": [ "DNS" ], "summary": "Add DNS Record", "description": "Creates a new record in the DNS zone", "operationId": "dns_add_record", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "service_id", "type": "integer", "in": "path", "description": "Service ID", "required": true }, { "name": "zone_id", "type": "integer", "in": "path", "description": "Zone ID", "required": true }, { "name": "name", "type": "string", "in": "query", "description": "Record name " }, { "name": "ttl", "type": "integer", "in": "query", "description": "Record ttl " }, { "name": "priority", "type": "integer", "in": "query", "description": "Priority of the record " }, { "name": "type", "type": "string", "in": "query", "description": "Record type " }, { "name": "content", "type": "string", "in": "query", "description": "Contents of the record " } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{service_id}\/dns\/{zone_id}\/records\/{record_id}": { "put": { "tags": [ "DNS" ], "summary": "Edit DNS Record", "description": "Edits the selected DNS zone record", "operationId": "dns_edit_record", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "service_id", "type": "integer", "in": "path", "description": "Service ID", "required": true }, { "name": "zone_id", "type": "integer", "in": "path", "description": "Zone ID", "required": true }, { "name": "record_id", "type": "integer", "in": "path", "description": "Record ID", "required": true }, { "name": "name", "type": "string", "in": "query", "description": "Record name " }, { "name": "ttl", "type": "integer", "in": "query", "description": "Record ttl " }, { "name": "priority", "type": "integer", "in": "query", "description": "Priority of the record " }, { "name": "type", "type": "string", "in": "query", "description": "Record type " }, { "name": "content", "type": "string", "in": "query", "description": "Contents of the record " } ], "responses": { "200": { "description": "`Success`" } } }, "delete": { "tags": [ "DNS" ], "summary": "Remove DNS Record", "description": "Removes the selected DNS zone record", "operationId": "dns_delete_record", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "service_id", "type": "integer", "in": "path", "description": "Service ID", "required": true }, { "name": "zone_id", "type": "integer", "in": "path", "description": "Zone ID", "required": true }, { "name": "record_id", "type": "integer", "in": "path", "description": "Record ID", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{service_id}\/dns\/{zone_id}\/dnssec": { "get": { "tags": [ "DNS" ], "summary": "Get DNS DNSSEC", "description": "Returns details of the DNS DNSSEC", "operationId": "dns_get_dnssec", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "service_id", "type": "integer", "in": "path", "description": "Service ID", "required": true }, { "name": "zone_id", "type": "integer", "in": "path", "description": "Zone ID", "required": true } ], "responses": { "200": { "description": "`Success`" } } }, "put": { "tags": [ "DNS" ], "summary": "UPDATE DNS DNSSEC", "description": "Returns details of the DNS DNSSEC", "operationId": "dns_action_dnssec", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "service_id", "type": "integer", "in": "path", "description": "Service ID", "required": true }, { "name": "zone_id", "type": "integer", "in": "path", "description": "Zone ID", "required": true }, { "name": "widgetdo", "type": "string", "in": "path", "description": "widgetdo action", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/dns\/templates": { "get": { "tags": [ "DNS" ], "summary": "DNS Templates", "description": "Returns details of the DNS zone", "operationId": "dns_get_template", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{service_id}\/dns\/{zone_id}\/password": { "get": { "tags": [ "DNS" ], "summary": "Change Zone DNS", "description": "Returns details of the DNS zone", "operationId": "reset_zone_password", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "service_id", "type": "integer", "in": "path", "description": "Service ID", "required": true }, { "name": "zone_id", "type": "integer", "in": "path", "description": "Zone ID", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/languages": { "get": { "tags": [ "Language" ], "summary": "List language", "description": "Return languages details", "operationId": "getLanguages", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "`Success`" } } } }, "\/languages\/\translate": { "get": { "tags": [ "Language" ], "summary": "Translate language", "description": "Return languages translate", "operationId": "translateLang", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "key", "type": "string", "in": "path", "description": "lang keyword", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/languages\/file\/{langname}": { "get": { "tags": [ "Language" ], "summary": "Get Language File", "description": "List support tickets under my account", "operationId": "exportLangFile", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "langname", "type": "string", "in": "path", "description": "lang name", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/affiliate\/active": { "post": { "tags": [ "Affiliate" ], "summary": "Active Affiliate", "description": "", "operationId": "activateAff", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "`Success`" } } } }, "\/affiliate\/plans": { "get": { "tags": [ "Affiliate" ], "summary": "List Commision Plans", "description": "", "operationId": "getAffiliatePlans", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "`Success`" } } } }, "\/affiliates\/plans\/{id}": { "get": { "tags": [ "Affiliate" ], "summary": "View Commision Plan", "description": "", "operationId": "viewAffiliatePlan", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Plan ID", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/affiliates\/addvoucher": { "post": { "tags": [ "Affiliate" ], "summary": "Add Vouchers", "description": "", "operationId": "addAffiliateVouchers", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "plan", "type": "integer", "in": "query", "description": "Plan ID
Requested<\/b>" }, { "name": "cycle", "type": "string", "in": "query", "description": "Voucher cycle
Requested<\/b>", "enum": [ "once", "recurring" ] }, { "name": "audience", "type": "string", "in": "query", "description": "Voucher audience", "enum": [ "new", "all", "existing" ] }, { "name": "max_usage_limit", "type": "boolean", "in": "query", "description": "max_usage_limit" }, { "name": "max_usage", "type": "string", "in": "query", "description": "max_usage" }, { "name": "expires", "type": "string", "in": "query", "description": "Expires Date" }, { "name": "discount", "type": "string", "in": "query", "description": "Discount value", "enum": [ "Min: 1", "Max: Commission Rate" ] } ], "responses": { "200": { "description": "`Success`" } } } }, "\/affiliates\/vouchers\/{id}\/remove": { "delete": { "tags": [ "Affiliate" ], "summary": "Affiliate Delete Vouchers", "description": "", "operationId": "removeAffiliateVouchers", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Plan ID, Empty if get list plans", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/security": { "get": { "tags": [ "Security" ], "summary": "List security", "description": "", "operationId": "getSecurity", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "`Success`" } } } }, "\/security\/ipaccess": { "post": { "tags": [ "Security" ], "summary": "Add IP access", "description": "all - keyword matching all
IPs xxx.xxx.xxx.xxx - IP single
xxx.xxx.xxx.xxx\/M - IP with Mask in CIDR format
xxx.xxx.xxx.xxx\/mmm.mmm.mmm.mmm - IP with Mask in dotted quad format", "operationId": "AddIpAccess", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "rule", "type": "string", "in": "query", "description": "Rule Access" } ], "responses": { "200": { "description": "`Success`" } } } }, "\/security\/ipaccess\/{id}": { "delete": { "tags": [ "Security" ], "summary": "Remove IP access", "description": "", "operationId": "RemoveIpAccess", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "Rule id", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/security\/sshkey": { "post": { "tags": [ "Security" ], "summary": "Add SSH Key", "description": "", "operationId": "AddSshKey", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "ssh_key_name", "type": "string", "in": "query", "description": "SSH Name" }, { "name": "ssh_key_key", "type": "string", "in": "query", "description": "SSh Key" } ], "responses": { "200": { "description": "`Success`" } } } }, "\/security\/sshkey\/{id}": { "delete": { "tags": [ "Security" ], "summary": "Remove SSH Key", "description": "\u0110ang test ch\u01b0a xong", "operationId": "RemoveSshKey", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "description": "sshkey id", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/cart\/domain\/tlds": { "get": { "tags": [ "Cart" ], "summary": "Available TLDs", "description": "List TLDs available for registration and transfer", "operationId": "getDomainTlds", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "`Success`" } } } }, "\/v2\/cart\/domain\/tlds": { "get": { "tags": [ "Cart" ], "summary": "V2: Available TLDs", "description": "List TLDs available for registration and transfer", "operationId": "getDomainTldsV2", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "`Success`" } } } }, "\/categories": { "get": { "tags": [ "Cart" ], "summary": "List product categories", "description": "Return a list of product categories.", "operationId": "cart_categories", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "`Success`" } } } }, "\/category\/{category_id}\/product": { "get": { "tags": [ "Cart" ], "summary": "List products in category", "description": "Return a list of product available for purchase under requested category", "operationId": "cart_products", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "category_id", "type": "integer", "in": "path", "description": "Category ID", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/order\/{product_id}": { "get": { "tags": [ "Cart" ], "summary": "Get product configuration details", "description": "Return product details with form configuration, addons and subproducts if available.", "operationId": "cart_product", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "product_id", "type": "integer", "in": "path", "description": "Product ID", "required": true } ], "responses": { "200": { "description": "`Success`" } } }, "post": { "tags": [ "Cart" ], "summary": "Order new service", "description": "Create and submit new order for selected product.\n\nTo get available cycle and configuration options lookup product details\nusing `GET \/order\/@product_id`", "operationId": "tino_cart_order", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "product_id", "type": "integer", "in": "path", "description": "Product ID", "required": true }, { "name": "domain", "type": "string", "in": "query", "description": "Domain name, ie. example.com, may be optional" }, { "name": "cycle", "type": "string", "in": "query", "description": "Billing period symbol" }, { "name": "pay_method", "type": "integer", "in": "query", "description": "Payment method ID" }, { "name": "custom", "type": "array", "in": "query", "description": "Additional options data available for sop products", "items": { "type": "string" } }, { "name": "promocode", "type": "string", "in": "query", "description": "Promotion code" } ], "responses": { "200": { "description": "`Success`" } } } }, "\/cart\/coupon": { "get": { "tags": [ "Cart" ], "summary": "List coupon", "description": "Danh s\u00e1ch m\u00e3 gi\u1ea3m gi\u00e1 \u0111ang c\u00f3", "operationId": "listCoupon", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [], "responses": { "200": { "description": "`Success`" } } } }, "\/order": { "post": { "tags": [ "Cart" ], "summary": "Order multiple services", "description": "Create and submit new order for multiple services\n\nEach item in the `items` array needs to include order `type` and parameters used\nby one of the method listed below:\n
• `POST \/domain\/order` - use `domain` for item type
• `POST \/certificate\/order` - use `certificate` for item type", "operationId": "cart_order_multi", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "pay_method", "type": "integer", "in": "query", "description": "Payment method ID " }, { "name": "ignore_errors", "type": "boolean", "in": "query", "description": "Process order even if some of the items were rejected due to errors " }, { "name": "items", "type": "array", "in": "query", "description": "list with order items", "items": { "type": "string" } } ], "responses": { "200": { "description": "`Success`" } } } }, "\/quote": { "post": { "tags": [ "Cart" ], "summary": "Get order quote", "description": "Calculate order cost and recurring prices for selected items.\nUse the same parameters as for `POST \/order`", "operationId": "cart_order_quote", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "pay_method", "type": "integer", "in": "query", "description": "Payment method ID" }, { "name": "output", "type": "string", "in": "query", "description": "Type of output, default is short. Possible options\n
    \n
  • short<\/code> - Basic details about the item in cart<\/li>\n
  • config<\/code>- Basic details and form components<\/li>\n
  • full<\/code> - All details available in cart<\/li>\n<\/ul> " }, { "name": "items", "type": "array", "in": "query", "description": "list with order items", "items": { "type": "string" } } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{id}\/vms\/{vmid}\/usage": { "get": { "tags": [ "Cloud Instance" ], "summary": "Get VM usage", "description": "Get the details of a particular virtual server", "operationId": "vms_usage", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "required": true }, { "name": "vmid", "type": "string", "in": "path", "description": "Virtual server id", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{id}\/vms\/{vmid}\/console": { "post": { "tags": [ "Cloud Instance" ], "summary": "console VM", "description": "", "operationId": "vms_console", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "required": true }, { "name": "vmid", "type": "string", "in": "path", "description": "Virtual server id", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{id}\/vms\/{vmid}\/resetpwd": { "post": { "tags": [ "Cloud Instance" ], "summary": "Reset Root Password VM", "description": "", "operationId": "vms_reset_password", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "required": true }, { "name": "vmid", "type": "string", "in": "path", "description": "Virtual server id", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{id}\/vms\/{vmid}\/addsshkey": { "post": { "tags": [ "Cloud Instance" ], "summary": "Change SSHKEY ", "description": "Get the details of a particular virtual server", "operationId": "vms_addsshkey", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "required": true }, { "name": "vmid", "type": "string", "in": "path", "description": "Virtual server id", "required": true }, { "name": "keys", "type": "array", "in": "path", "description": "SSK Key ID", "required": true, "items": { "type": "string" } } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{id}\/vms\/{vmid}\/backups": { "get": { "tags": [ "Cloud Instance" ], "summary": "VM List Backup ", "description": "", "operationId": "vms_backup_list", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "required": true }, { "name": "vmid", "type": "string", "in": "path", "description": "Virtual server id", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{id}\/vms\/{vmid}\/backup\/{backup_id}\/delete": { "delete": { "tags": [ "Cloud Instance" ], "summary": "VM Delete Backup ", "description": "", "operationId": "vms_backup_delete", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "required": true }, { "name": "vmid", "type": "string", "in": "path", "description": "Virtual server id", "required": true }, { "name": "backup_id", "type": "integer", "in": "path", "description": "Backup VM id", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{id}\/vms\/{vmid}\/backups\/{backup_id}\/restore": { "post": { "tags": [ "Cloud Instance" ], "summary": "VM Restore Backup ", "description": "", "operationId": "vms_backup_restore", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "required": true }, { "name": "vmid", "type": "string", "in": "path", "description": "Virtual server id", "required": true }, { "name": "backup_id", "type": "integer", "in": "path", "description": "Backup VM id", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{id}\/vms\/{vmid}\/backups\/create": { "post": { "tags": [ "Cloud Instance" ], "summary": "VM Create Backup ", "description": "", "operationId": "vms_backup_create", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "required": true }, { "name": "vmid", "type": "string", "in": "path", "description": "Virtual server id", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{id}\/vms\/{vmid}\/snapshots": { "get": { "tags": [ "Cloud Instance" ], "summary": "VM List Snapshot ", "description": "", "operationId": "vms_snapshot_list", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "required": true }, { "name": "vmid", "type": "string", "in": "path", "description": "Virtual server id", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{id}\/vms\/{vmid}\/snapshots\/{snapshot_name}\/delete": { "delete": { "tags": [ "Cloud Instance" ], "summary": "VM Delete Snapshot ", "description": "", "operationId": "vms_snapshot_delete", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "required": true }, { "name": "vmid", "type": "string", "in": "path", "description": "Virtual server id", "required": true }, { "name": "snapshot_name", "type": "string", "in": "path", "description": "Snapshot VM id", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{id}\/vms\/{vmid}\/snapshots\/{snapshot_id}\/restore": { "post": { "tags": [ "Cloud Instance" ], "summary": "VM Restore Snapshot ", "description": "", "operationId": "vms_snapshot_restore", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "required": true }, { "name": "vmid", "type": "string", "in": "path", "description": "Virtual server id", "required": true }, { "name": "snapshot_id", "type": "integer", "in": "path", "description": "Snapshot VM id", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{id}\/vms\/{vmid}\/snapshots\/create": { "post": { "tags": [ "Cloud Instance" ], "summary": "VM Create Snapshot ", "description": "", "operationId": "vms_snapshot_create", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "required": true }, { "name": "vmid", "type": "string", "in": "path", "description": "Virtual server id", "required": true }, { "name": "description", "type": "string", "in": "path", "description": "description", "required": true }, { "name": "vmstate", "type": "integer", "in": "path", "description": "vmstate", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{id}\/vms\/{vmid}\/snapshotschedule": { "get": { "tags": [ "Cloud Instance" ], "summary": "VM snapshot schedule ", "description": "", "operationId": "vms_snapshotschedule", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "required": true }, { "name": "vmid", "type": "string", "in": "path", "description": "Virtual server id", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{id}\/vms\/{vmid}\/snapshotschedule\/create": { "post": { "tags": [ "Cloud Instance" ], "summary": "VM snapshot schedule Create ", "description": "", "operationId": "vms_snapshotschedule_create", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "required": true }, { "name": "vmid", "type": "string", "in": "path", "description": "Virtual server id", "required": true }, { "name": "dow", "type": "string", "in": "path", "description": "Array th\u1ee9", "required": true }, { "name": "hour", "type": "string", "in": "path", "description": "Gi\u1edd", "required": true }, { "name": "min", "type": "string", "in": "path", "description": "Ph\u00fat", "required": true }, { "name": "vmstate", "type": "integer", "in": "path", "description": "vmstate", "required": true } ], "responses": { "200": { "description": "`Success`" } } } }, "\/service\/{id}\/vms\/{vmid}\/snapshotschedule\/{schedule_id}\/delete": { "delete": { "tags": [ "Cloud Instance" ], "summary": "VM snapshot schedule delete", "description": "", "operationId": "vms_snapshotschedule_delete", "consumes": [ "application\/json" ], "produces": [ "application\/json" ], "parameters": [ { "name": "id", "type": "integer", "in": "path", "required": true }, { "name": "vmid", "type": "string", "in": "path", "description": "Virtual server id", "required": true }, { "name": "schedule_id", "type": "string", "in": "path", "required": true } ], "responses": { "200": { "description": "`Success`" } } } } }, "securityDefinitions": { "http": { "type": "basic" } }, "definitions": { "Clientarea": { "type": "object", "properties": { "refresh_token": { "type": "string" }, "email": { "type": "string", "description": "Email Address" }, "password": { "type": "string", "description": "Password" }, "privileges": { "type": "array", "items": { "type": "string" }, "description": "Array with privileges that you want to enable. Formatted the same way as output from GET \/contact\/privileges<\/code>" }, "firstname": { "type": "string", "description": "First Name" }, "lastname": { "type": "string", "description": "Last Name" }, "companyname": { "type": "string", "description": "Organization" }, "address1": { "type": "string", "description": "Address 1" }, "city": { "type": "string", "description": "City" }, "state": { "type": "string", "description": "State" }, "country": { "type": "string", "description": "Country" }, "phonenumber": { "type": "string", "description": "Phone" }, "type": { "type": "string", "description": "Account Type" }, "id": { "type": "integer" }, "rel_type": { "type": "string", "description": "Optional, return only by relation type" }, "rel_id": { "type": "string", "description": "Optional, return only by relation id" }, "username": { "type": "string", "description": "Your acount email address" }, "remember": { "type": "boolean", "description": "Remember login session with 360 day" }, "oldpassword": { "type": "string", "description": "old password" }, "password2": { "type": "string", "description": "New password" }, "activate": { "type": "string", "description": "activate code" }, "query": { "type": "string", "description": "Value to search" }, "configs": { "type": "array", "items": { "type": "string" }, "description": "Value to setting: RecordsPerPage, DefaultTimezone, DefaultPaymentModule, CreditAutoApply, ClientNotifications, DefaultNameservers" }, "code": { "type": "string" }, "currency": { "type": "string", "description": "Currency" }, "cfmName": { "type": "string", "description": "Your acount email address" }, "cfmPhone": { "type": "string", "description": "Your acount email address" }, "cfmEmail": { "type": "string", "description": "Your acount email address" }, "cfmMessage": { "type": "string", "description": "Your acount email address" } } }, "Billing": { "type": "object", "properties": { "id": { "type": "integer" }, "amount": { "type": "string" }, "code": { "type": "string", "description": "Voucher Code" }, "funds": { "type": "integer", "description": "Amount of money" }, "gateway": { "type": "integer", "description": "Payment Method" }, "selected": { "type": "array", "items": { "type": "string" }, "description": "selected invoice id" }, "invoice_id": { "type": "integer", "description": "Invoice ID" }, "gateway_id": { "type": "integer", "description": "Gateway ID" } } }, "Support": { "type": "object", "properties": { "number": { "type": "integer", "description": "Ticket number" }, "file": { "type": "string", "description": "Attachment id" }, "dept_id": { "type": "integer", "description": "Department id " }, "subject": { "type": "string", "description": "Ticket subject " }, "body": { "type": "string", "description": "Reply message " } } }, "Domains": { "type": "object", "properties": { "id": { "type": "integer", "description": "Domain ID" }, "name": { "type": "string", "description": "Domain name " }, "nameservers": { "type": "array", "items": { "type": "string" }, "description": "Optional array with 2 - 4 nameservers that you want to use" }, "type": { "type": "string", "description": "Record type" }, "priority": { "type": "string", "description": "Record priority" }, "content": { "type": "string", "description": "Record content eg. IP address for A records" }, "record_id": { "type": "integer", "description": "Recod index" }, "switch": { "type": "boolean", "description": "Enable or disable ID orotection, use true to enable. " }, "contact_info": { "type": "array", "items": { "type": "string" } }, "from": { "type": "string", "description": "Email address that you want to forward " }, "to": { "type": "string", "description": "Email address that will receive forwarded emails " }, "autorenew": { "type": "boolean" }, "tld_id": { "type": "string", "description": "TLD id" }, "years": { "type": "string", "description": "Number of years" }, "action": { "type": "string", "description": "register|transfer" }, "pay_method": { "type": "integer", "description": "Payment method ID" }, "epp": { "type": "string", "description": "EPP Transfer code, required when transfering some domains" }, "registrant": { "type": "integer", "description": "Optional contact ID to use for registrant contact this domain" }, "admin": { "type": "integer", "description": "Optional contact ID to use for admin contact this domain" }, "tech": { "type": "integer", "description": "Optional contact ID to use for tech contact this domain" }, "billing": { "type": "integer", "description": "Optional contact ID to use for billing contact this domain" }, "data": { "type": "array", "items": { "type": "string" }, "description": "Addditional data required for some TLDs" }, "domain": { "type": "string", "description": "Domain" } } }, "SSL Certificates": { "type": "object", "properties": { "id": { "type": "integer", "description": "Service id" }, "product_id": { "type": "integer", "description": "Certificate product ID" }, "csr": { "type": "string", "description": "Domain name " }, "years": { "type": "integer", "description": "Number of years" }, "pay_method": { "type": "integer", "description": "Payment method ID" }, "approver_email": { "type": "string", "description": "Email addres used in domain validation" }, "admin": { "type": "integer", "description": "Admin contact ID" }, "tech": { "type": "integer", "description": "Tech contact ID" }, "billing": { "type": "integer", "description": "Billing contact ID" }, "organization": { "type": "array", "items": { "type": "string" }, "description": "Organization details" }, "software": { "type": "integer", "description": "Server\/Software ID" }, "data": { "type": "array", "items": { "type": "string" }, "description": "Addditional data required for some products" } } }, "Services": { "type": "object", "properties": { "id": { "type": "integer", "description": "Service ID" }, "resources": { "type": "array", "items": { "type": "string" }, "description": "array with resource values" }, "package": { "type": "integer", "description": "New package id, optonal when upgrading resources" }, "cycle": { "type": "string", "description": "New billing cycle" }, "send": { "type": "boolean", "description": "Set to true when you want to send your upgrade request" }, "immediate": { "type": "string", "description": "set to false<\/code> to terminate service at the end of billing date, true<\/code> - terminate immediately" }, "reason": { "type": "string", "description": "Reason for this request" }, "label": { "type": "string", "description": "VM label" }, "vmid": { "type": "string", "description": "Virtual server id" }, "template": { "type": "string", "description": "Template ID" }, "memory": { "type": "string", "description": "Amount of RAM in MB" }, "cpu": { "type": "string", "description": "Amount of CPU cores" }, "disk": { "type": "string", "description": "Disk Space in GB" }, "interface": { "type": "array", "items": { "type": "string" }, "description": "Interface configuration" }, "hostname": { "type": "string", "description": "New hostname for the VM" }, "type": { "type": "string", "description": "ipv4 or ipv6" }, "iface": { "type": "string", "description": "Interface name or id to remove" }, "bridge": { "type": "string", "description": "Network bridge" }, "pool": { "type": "string", "description": "List ID to allocate new IP from" }, "number": { "type": "integer", "description": "Number of IPs to allocate" }, "firewall": { "type": "integer", "description": "Enable or disable firewall (may require specific permissions)" }, "ipv4": { "type": "array", "items": { "type": "string" }, "description": "List of IP v4 IDs" }, "ipv6": { "type": "array", "items": { "type": "string" }, "description": "List of IP v6 IDs" }, "cid": { "type": "integer", "description": "Category id, 0 to get all" }, "module": { "type": "string", "description": "Service type module (Cpanel2|DirectAdmin2|Zimbra|Wilduck)" }, "name": { "type": "string", "description": "Email account without domain" }, "passmain": { "type": "string", "description": "Password for email account" }, "passcheck": { "type": "string", "description": "Password confirm for email account" }, "quota": { "type": "integer", "description": "Email Quote (Megabytes)" }, "change": { "type": "Array" }, "deluser": { "type": "string", "description": "Email account" }, "domain": { "type": "string" } } }, "DNS": { "type": "object", "properties": { "service_id": { "type": "integer", "description": "Service ID" }, "name": { "type": "string", "description": "Record name " }, "zone_id": { "type": "integer", "description": "Zone ID" }, "ttl": { "type": "integer", "description": "Record ttl " }, "priority": { "type": "integer", "description": "Priority of the record " }, "type": { "type": "string", "description": "Record type " }, "content": { "type": "string", "description": "Contents of the record " }, "record_id": { "type": "integer", "description": "Record ID" }, "widgetdo": { "type": "string", "description": "widgetdo action" } } }, "Language": { "type": "object", "properties": { "key": { "type": "string", "description": "lang keyword" }, "langname": { "type": "string", "description": "lang name" } } }, "Affiliate": { "type": "object", "properties": { "id": { "type": "integer", "description": "Plan ID, Empty if get list plans" }, "plan": { "type": "integer", "description": "Plan ID
    Requested<\/b>" }, "cycle": { "type": "string", "description": "Voucher cycle
    Requested<\/b>" }, "audience": { "type": "string", "description": "Voucher audience" }, "max_usage_limit": { "type": "boolean", "description": "max_usage_limit" }, "max_usage": { "type": "string", "description": "max_usage" }, "expires": { "type": "string", "description": "Expires Date" }, "discount": { "type": "string", "description": "Discount value" } } }, "Security": { "type": "object", "properties": { "rule": { "type": "string", "description": "Rule Access" }, "id": { "type": "integer", "description": "sshkey id" }, "ssh_key_name": { "type": "string", "description": "SSH Name" }, "ssh_key_key": { "type": "string", "description": "SSh Key" } } }, "Cart": { "type": "object", "properties": { "category_id": { "type": "integer", "description": "Category ID" }, "product_id": { "type": "integer", "description": "Product ID" }, "pay_method": { "type": "integer", "description": "Payment method ID" }, "ignore_errors": { "type": "boolean", "description": "Process order even if some of the items were rejected due to errors " }, "items": { "type": "array", "items": { "type": "string" }, "description": "list with order items" }, "output": { "type": "string", "description": "Type of output, default is short. Possible options\n
      \n
    • short<\/code> - Basic details about the item in cart<\/li>\n
    • config<\/code>- Basic details and form components<\/li>\n
    • full<\/code> - All details available in cart<\/li>\n<\/ul> " }, "domain": { "type": "string", "description": "Domain name, ie. example.com, may be optional" }, "cycle": { "type": "string", "description": "Billing period symbol" }, "custom": { "type": "array", "items": { "type": "string" }, "description": "Additional options data available for sop products" }, "promocode": { "type": "string", "description": "Promotion code" } } }, "Cloud Instance": { "type": "object", "properties": { "id": { "type": "integer" }, "vmid": { "type": "string", "description": "Virtual server id" }, "keys": { "type": "array", "items": { "type": "string" }, "description": "SSK Key ID" }, "backup_id": { "type": "integer", "description": "Backup VM id" }, "snapshot_name": { "type": "string", "description": "Snapshot VM id" }, "snapshot_id": { "type": "integer", "description": "Snapshot VM id" }, "description": { "type": "string", "description": "description" }, "vmstate": { "type": "integer", "description": "vmstate" }, "dow": { "type": "string", "description": "Array th\u1ee9" }, "hour": { "type": "string", "description": "Gi\u1edd" }, "min": { "type": "string", "description": "Ph\u00fat" } } } }, "externalDocs": { "description": "Find out more about UserAPI", "url": "https:\/\/ote.tino.org\/?cmd=userapi" } }