{ "openapi": "3.0.0", "info": { "title": "API Documentation", "version": "1.1" }, "servers": [ { "url": "/", "description": "Server" } ], "paths": { "/permissions": { "get": { "tags": [ "API Key Management" ], "summary": "Get permissions", "description": "Returns a list of permissions for your API key", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true, "data": { "clients_read": true, "clients_write": false, "domains_read": true, "domains_write": false, "hosting_read": true, "hosting_write": false, "ssl_read": true, "ssl_write": false, "invoices_read": true, "invoices_write": false, "tld_read": false, "tld_write": false, "contacts_read": false, "contacts_write": false, "logs_read": true } } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "API TOKEN missing" } } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] } }, "/clients": { "get": { "tags": [ "Client Management" ], "summary": "Get a list of all your clients", "description": "Returns list of your clients, if applicable.", "parameters": [ { "name": "limit", "in": "query", "description": "Database limit", "required": false, "schema": { "type": "integer" }, "example": 100 }, { "name": "offset", "in": "query", "description": "Database offset", "required": false, "schema": { "type": "integer" }, "example": 0 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true, "data": [ { "id": 1, "firstname": "John", "lastname": "Doe", "companyname": "MG", "email": "john@doe.com", "address1": "2446 Marie Street", "address2": "", "city": "Baltimore", "postcode": "MD 21223", "country": "US", "phonenumber": "+1.410-947-6416", "currency": 1, "defaultgateway": "", "groupid": 0, "gatewayid": "", "lastlogin": "0000-00-00 00:00:00", "status": "Active", "language": "", "email_verified": 0 } ] } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": "Resource not found" } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] }, "post": { "tags": [ "Client Management" ], "summary": "Adds a new client to your account", "requestBody": { "content": { "application/json": { "schema": { "example": { "firstname": "John", "lastname": "Doe", "email": "john.doe@sqr.nl", "address1": "Straat 123", "city": "Alkmaar", "state": "Noord-Holland", "postcode": "1817BH", "country": "NL", "phonenumber": "072-751-340" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "Information about the success", "type": "string" } }, "type": "object", "example": { "success": true, "data": [ "Client added to reseller" ] } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": "Resource not found" } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] } }, "/clients/{id}": { "get": { "tags": [ "Client Management" ], "summary": "Get the details for a specific client", "description": "Returns the specific details of a client", "parameters": [ { "name": "id", "in": "path", "description": "Client ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true, "data": { "id": 1, "firstname": "John", "lastname": "Doe", "companyname": "MG", "email": "john@doe.com", "address1": "2446 Marie Street", "address2": "", "city": "Baltimore", "postcode": "MD 21223", "country": "US", "phonenumber": "+1.410-947-6416", "currency": 1, "defaultgateway": "", "groupid": 0, "gatewayid": "", "lastlogin": "0000-00-00 00:00:00", "status": "Active", "language": "", "email_verified": 0 } } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": "Resource not found" } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] }, "put": { "tags": [ "Client Management" ], "summary": "Updates an existing client", "parameters": [ { "name": "id", "in": "path", "description": "Client ID", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "example": { "firstname": "John", "lastname": "Doe", "email": "john.doe@sqr.nl", "address1": "Straat 123", "city": "Alkmaar", "state": "Noord-Holland", "postcode": "1817BH" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true, "data": { "clientid": "1" } } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": "Resource not found" } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] } }, "/clients/{id}/invoices": { "get": { "tags": [ "Client Management" ], "summary": "Get invoices details", "description": "Returns invoice details by client id", "parameters": [ { "name": "id", "in": "path", "description": "Client ID", "required": true, "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "description": "Database limit", "required": false, "schema": { "type": "integer" }, "example": 100 }, { "name": "offset", "in": "query", "description": "Database offset", "required": false, "schema": { "type": "integer" }, "example": 0 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true, "data": [ { "id": 1, "userid": 1, "invoicenum": "", "date": "2022-12-13", "duedate": "2022-12-13", "datepaid": "0000-00-00 00:00:00", "last_capture_attempt": "0000-00-00 00:00:00", "date_refunded": "0000-00-00 00:00:00", "date_cancelled": "0000-00-00 00:00:00", "subtotal": "10.00", "credit": "0.00", "tax": "0.00", "tax2": "0.00", "total": "10.00", "taxrate": "0.000", "taxrate2": "0.000", "status": "Unpaid", "paymentmethod": "banktransfer", "created_at": "2022-12-13 07:36:02", "updated_at": "2022-12-13 07:36:02" } ] } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": "Resource not found" } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] } }, "/clients/{id}/domain": { "get": { "tags": [ "Client Management" ], "summary": "Get your clients domains", "description": "Returns list of client domains", "parameters": [ { "name": "id", "in": "path", "description": "Client ID", "required": true, "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "description": "Database limit", "required": false, "schema": { "type": "integer" }, "example": 100 }, { "name": "offset", "in": "query", "description": "Database offset", "required": false, "schema": { "type": "integer" }, "example": 0 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true, "data": [ { "id": 1, "userid": 1, "orderid": 1, "type": "Register", "registrationdate": "2022-12-13", "domain": "testjohn001.com", "firstpaymentamount": "10.00", "recurringamount": "10.00", "registrationperiod": 1, "expirydate": "0000-00-00", "status": "Active", "nextduedate": "2022-12-13", "paymentmethod": "banktransfer", "dnsmanagement": 0, "idprotection": 0, "is_premium": 0, "donotrenew": 0, "created_at": "-0001-11-30 00:00:00", "updated_at": "-0001-11-30 00:00:00" } ] } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": "Resource not found" } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] } }, "/clients/{id}/webhosting": { "get": { "tags": [ "Client Management" ], "summary": "Get client hosting package details", "description": "Returns hosting details", "parameters": [ { "name": "id", "in": "path", "description": "Client ID", "required": true, "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "description": "Database limit", "required": false, "schema": { "type": "integer" }, "example": 100 }, { "name": "offset", "in": "query", "description": "Database offset", "required": false, "schema": { "type": "integer" }, "example": 0 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true, "data": [ { "id": 1, "userid": 1, "orderid": 4, "packageid": 1, "server": 0, "regdate": "2023-03-17", "domain": "testdom1.com", "paymentmethod": "banktransfer", "qty": 1, "firstpaymentamount": "11.00", "amount": "10.00", "billingcycle": "Monthly", "nextduedate": "2023-03-17", "nextinvoicedate": "2023-03-17", "termination_date": "0000-00-00", "domainstatus": "Active", "promoid": 0, "promocount": 0, "overideautosuspend": 0, "overidesuspenduntil": "0000-00-00", "dedicatedip": "", "assignedips": "", "ns1": "", "ns2": "", "lastupdate": "0000-00-00 00:00:00", "created_at": "-0001-11-30 00:00:00", "updated_at": "2023-03-17 13:31:44" } ] } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": "Resource not found" } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] } }, "/clients/{id}/ssl": { "get": { "tags": [ "Client Management" ], "summary": "Get client SSL certificate details", "description": "Returns certificate details", "parameters": [ { "name": "id", "in": "path", "description": "Client ID", "required": true, "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "description": "Database limit", "required": false, "schema": { "type": "integer" }, "example": 100 }, { "name": "offset", "in": "query", "description": "Database offset", "required": false, "schema": { "type": "integer" }, "example": 0 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true, "data": [ { "id": 1234, "userid": 123, "packageid": 1, "paymentmethod": "sepaincasso", "amount": "43.21", "billingcycle": "Annually", "nextduedate": "2025-01-01", "nextinvoicedate": "2026-01-01", "subscription_status": "Active", "commonname": "example.com", "certificate_status": "SUSPENDED", "expirydate": null, "certificate_type": "MULTI_DOMAIN", "validation_type": "SINGLE_DOMAIN", "dcv_method": "DNS", "brand": "PERFECTSSL", "san": [ "example2.nl", "example4.nl", "example3.nl", "example5.nl" ] } ] } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": "Resource not found" } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] } }, "/clients/{id}/contacts": { "get": { "tags": [ "Client Management" ], "summary": "Get client Contacts", "description": "Returns all client contacts", "parameters": [ { "name": "id", "in": "path", "description": "Client ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true, "data": [ { "id": 2, "userid": 1, "firstname": "Test", "lastname": "Test", "companyname": "Test", "email": "test@test.com", "address1": "test addr123", "address2": "", "city": "Somecity", "state": "California", "postcode": "22222", "country": "US", "phonenumber": "+1.555-698-7452", "tax_id": "", "subaccount": 0, "permissions": "", "domainemails": 1, "generalemails": 1, "invoiceemails": 1, "productemails": 1, "supportemails": 1, "affiliateemails": 1, "created_at": "-0001-11-30 00:00:00", "updated_at": "-0001-11-30 00:00:00" } ] } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": "Resource not found" } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] } }, "/contacts/{id}": { "get": { "tags": [ "Contact Management" ], "summary": "Get contact details", "description": "Returns details of contact by contact id", "parameters": [ { "name": "id", "in": "path", "description": "Contact ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true, "data": { "id": 2, "userid": 1, "firstname": "Test", "lastname": "Test", "companyname": "Test", "email": "test@test.com", "address1": "test addr123", "address2": "", "city": "Somecity", "state": "California", "postcode": "22222", "country": "US", "phonenumber": "+1.555-698-7452", "tax_id": "", "subaccount": 0, "permissions": "", "domainemails": 1, "generalemails": 1, "invoiceemails": 1, "productemails": 1, "supportemails": 1, "affiliateemails": 1, "created_at": "-0001-11-30 00:00:00", "updated_at": "-0001-11-30 00:00:00" } } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": "Resource not found" } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] }, "put": { "tags": [ "Contact Management" ], "summary": "Updates an existing contact.", "parameters": [ { "name": "id", "in": "path", "description": "Contact ID", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "example": { "companyname": "Jansen B.V.", "firstname": "Jan", "lastname": "Jansen", "email": "j.jansen@sqr.nl", "address1": "Wognumsebuurt 3", "city": "Alkmaar", "state": "Noord-Holland", "postcode": "1817BH", "country": "NL", "phonenumber": "072-751-3401" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true, "data": { "contactid": "1" } } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": "Resource not found" } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] }, "delete": { "tags": [ "Contact Management" ], "summary": "Deletes a contact", "description": "Delete contact by contact id", "parameters": [ { "name": "id", "in": "path", "description": "Contact ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true, "data": { "contactid": "1" } } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": "Resource not found" } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] } }, "/contacts": { "post": { "tags": [ "Contact Management" ], "summary": "Add a new contact.", "requestBody": { "content": { "application/json": { "schema": { "example": { "clientid": "1", "companyname": "Jansen B.V.", "firstname": "Jan", "lastname": "Jansen", "email": "j.jansen@sqr.nl", "address1": "Wognumsebuurt 3", "city": "Alkmaar", "state": "Noord-Holland", "postcode": "1817BH", "country": "NL", "phonenumber": "072-751-3401" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true, "data": { "contactid": "1" } } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": "Resource not found" } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] } }, "/domains": { "get": { "tags": [ "Domain Management" ], "summary": "Get a list of all domains", "description": "Returns a list of all domains in your account(s)", "parameters": [ { "name": "limit", "in": "query", "description": "Database limit", "required": false, "schema": { "type": "integer" }, "example": 100 }, { "name": "offset", "in": "query", "description": "Database offset", "required": false, "schema": { "type": "integer" }, "example": 0 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true, "data": [ { "id": 1, "userid": 1, "orderid": 1, "type": "Register", "registrationdate": "2022-12-13", "domain": "testjohn001.com", "firstpaymentamount": "10.00", "recurringamount": "10.00", "registrationperiod": 1, "expirydate": "0000-00-00", "status": "Active", "nextduedate": "2022-12-13", "paymentmethod": "banktransfer", "dnsmanagement": 0, "idprotection": 0, "is_premium": 0, "donotrenew": 0, "created_at": "-0001-11-30 00:00:00", "updated_at": "-0001-11-30 00:00:00" } ] } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": "Resource not found" } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] } }, "/domains/register": { "post": { "tags": [ "Domain Management" ], "summary": "Register a new domain. If you provide the clientid parameter equal to 0 the order will be placed in your own account", "requestBody": { "content": { "application/json": { "schema": { "example": { "clientid": "6", "domain": "example.com", "registrantContactID": "6", "adminContactID": "7", "billingContactID": "8", "techContactID": "9" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true, "data": { "orderid": "1", "serviceids": "1", "addonids": "1", "domainids": "1", "invoiceid": "1" } } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": "Resource not found" } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] } }, "/domains/transfer": { "post": { "tags": [ "Domain Management" ], "summary": "Transfers a domain. If you provide the clientid parameter equal to 0 the order will be placed in your own account.", "requestBody": { "content": { "application/json": { "schema": { "example": { "clientid": "6", "domain": "example.com", "eppcode": "youreppcode", "registrantContactID": "6", "adminContactID": "7", "billingContactID": "8", "techContactID": "9" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true, "data": { "orderid": "1", "serviceids": "1", "addonids": "1", "domainids": "1", "invoiceid": "1" } } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": "Resource not found" } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] } }, "/domains/{domain}": { "get": { "tags": [ "Domain Management" ], "summary": "Get details for a specific domain", "description": "Returns all domain details for a specific domain", "parameters": [ { "name": "domain", "in": "path", "description": "Domain Name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true, "data": [ { "id": 1, "userid": 1, "orderid": 1, "type": "Register", "registrationdate": "2022-12-13", "domain": "testjohn001.com", "firstpaymentamount": "10.00", "recurringamount": "10.00", "registrationperiod": 1, "expirydate": "0000-00-00", "status": "Active", "nextduedate": "2022-12-13", "paymentmethod": "banktransfer", "dnsmanagement": 0, "idprotection": 0, "is_premium": 0, "donotrenew": 0, "created_at": "-0001-11-30 00:00:00", "updated_at": "-0001-11-30 00:00:00" } ] } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": "Resource not found" } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] } }, "/domains/{id}": { "put": { "tags": [ "Domain Management" ], "summary": "Updates an existing domain.", "parameters": [ { "name": "id", "in": "path", "description": "Domain ID", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "example": { "status": "Terminated", "registrantContactID": "6", "adminContactID": "7", "billingContactID": "8", "techContactID": "9" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true, "data": { "domainid": "1" } } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": "Resource not found" } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] } }, "/domains/{domain}/getepp": { "get": { "tags": [ "Domain Management" ], "summary": "Get EPP Code for a domain", "description": "Returns the domain EPP Code by domainname", "parameters": [ { "name": "domain", "in": "path", "description": "Domain Name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true, "data": { "eppcode": "theeppcode" } } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": "Resource not found" } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] } }, "/domains/{domain}/available": { "get": { "tags": [ "Domain Management" ], "summary": "Check domain availability", "description": "Returns the domains status", "parameters": [ { "name": "domain", "in": "path", "description": "Domain Name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true, "data": { "status": "unavailable", "whois": "xxx" } } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": "Resource not found" } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] } }, "/domains/{domain}/nameservers": { "get": { "tags": [ "Domain Management" ], "summary": "Get nameservers for a domain", "description": "Returns a list of nameservers for the domain", "parameters": [ { "name": "domain", "in": "path", "description": "Domain Name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true, "data": { "ns1": "ns1.sqr.nl", "ns2": "ns2.sqr.domains", "ns3": "ns3.sqr.cloud" } } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": "Resource not found" } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] }, "put": { "tags": [ "Domain Management" ], "summary": "Update nameservers for a domain", "description": "Update the nameservers for the given domain. ns1 and ns2 are required. The parameters ns3, ns4 and ns5 are optional.", "parameters": [ { "name": "domain", "in": "path", "description": "Domain Name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "example": { "ns1": "ns1.sqr.nl", "ns2": "ns2.sqr.domains", "ns3": "ns3.sqr.cloud" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": "Resource not found" } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] } }, "/domains/{domain}/dns": { "get": { "tags": [ "Domain Management" ], "summary": "Retrieve the DNS zone", "description": "Returns the DNS zone", "parameters": [ { "name": "domain", "in": "path", "description": "Domain Name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true, "data": [ { "id": "2315", "type": "A", "content": "192.168.2.1", "name": "example.com", "prio": "0", "ttl": "3600" } ] } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": "Resource not found" } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] }, "put": { "tags": [ "Domain Management" ], "summary": "Update a DNS record", "parameters": [ { "name": "domain", "in": "path", "description": "Domain Name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "example": [ { "id": 34, "name": "example.com", "type": "A", "content": "192.168.2.1", "ttl": 3600, "prio": 0 } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true, "data": [ { "id": 34, "name": "example.com", "type": "A", "content": "192.168.2.1", "ttl": 3600, "prio": 0 } ] } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": "Resource not found" } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] }, "post": { "tags": [ "Domain Management" ], "summary": "Add a DNS record to a DNS zone", "parameters": [ { "name": "domain", "in": "path", "description": "Domain Name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "example": [ { "name": "example.com", "type": "A", "content": "192.168.2.1", "ttl": "3600", "prio": "0" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true, "data": [ { "id": "2315", "name": "example.com", "type": "A", "content": "192.168.2.1", "ttl": "3600", "prio": "0" } ] } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": "Resource not found" } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] }, "delete": { "tags": [ "Domain Management" ], "summary": "Delete DNS records", "parameters": [ { "name": "domain", "in": "path", "description": "Domain Name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "example": [ { "id": 14 }, { "id": 26 } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true, "data": [ { "id": "34" } ] } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": "Resource not found" } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] } }, "/domains/{domain}/dns/logs": { "get": { "tags": [ "Domain Management" ], "summary": "Retrieve the DNS zone audit logs", "description": "Returns the DNS zone audit logs", "parameters": [ { "name": "domain", "in": "path", "description": "Domain Name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true, "data": [ { "id": 1, "env": "admin", "action": "Records::add", "data": { "success": [ { "id": "123", "type": "A", "content": "127.0.0.1", "name": "local.hosting.nl", "prio": 0, "ttl": 3600 } ] }, "time": 1740000000 } ] } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": "Resource not found" } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] } }, "/domains/{domain}/dnssec": { "get": { "tags": [ "Domain Management" ], "summary": "Get DNSSEC entries for a domain", "description": "Returns a list of DNSSEC entries for the domain", "parameters": [ { "name": "domain", "in": "path", "description": "Domain Name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true, "data": [ { "flags": 257, "algorithm": 13, "public_key": "public-key-value" } ] } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": "Resource not found" } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] }, "put": { "tags": [ "Domain Management" ], "summary": "Update DNSSEC entries for a domain", "description": "Replace all DNSSEC entries for the domain, this only applies to domains that use custom nameservers", "parameters": [ { "name": "domain", "in": "path", "description": "Domain Name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "example": [ { "flags": 257, "algorithm": 13, "public_key": "public-key-value" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true, "data": [ { "flags": 257, "algorithm": 13, "public_key": "public-key-value" } ] } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": "Resource not found" } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] }, "post": { "tags": [ "Domain Management" ], "summary": "Enable DNSSEC for a domain", "description": "Enable DNSSEC for the domain using our nameservers and keys", "parameters": [ { "name": "domain", "in": "path", "description": "Domain Name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true, "data": [ { "flags": 257, "algorithm": 13, "public_key": "public-key-value" } ] } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": "Resource not found" } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] }, "delete": { "tags": [ "Domain Management" ], "summary": "Disable DNSSEC for a domain", "description": "Disable DNSSEC for the domain, Delete all DNSSEC entries", "parameters": [ { "name": "domain", "in": "path", "description": "Domain Name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true, "data": [] } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": "Resource not found" } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] } }, "/invoices": { "get": { "tags": [ "Invoices Management" ], "summary": "Get all invoices", "description": "Returns a list of invoices in your account(s)", "parameters": [ { "name": "limit", "in": "query", "description": "Database limit", "required": false, "schema": { "type": "integer" }, "example": 100 }, { "name": "offset", "in": "query", "description": "Database offset", "required": false, "schema": { "type": "integer" }, "example": 0 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true, "data": [ { "id": 1, "userid": 1, "invoicenum": "", "date": "2022-12-13", "duedate": "2022-12-13", "datepaid": "0000-00-00 00:00:00", "last_capture_attempt": "0000-00-00 00:00:00", "date_refunded": "0000-00-00 00:00:00", "date_cancelled": "0000-00-00 00:00:00", "subtotal": "10.00", "credit": "0.00", "tax": "0.00", "tax2": "0.00", "total": "10.00", "taxrate": "0.000", "taxrate2": "0.000", "status": "Unpaid", "paymentmethod": "banktransfer", "created_at": "2022-12-13 07:36:02", "updated_at": "2022-12-13 07:36:02" } ] } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": "Resource not found" } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] } }, "/invoices/{id}": { "get": { "tags": [ "Invoices Management" ], "summary": "Get invoice details", "description": "Returns invoice details by invoice ID", "parameters": [ { "name": "id", "in": "path", "description": "Invoice ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true, "data": { "id": 1, "userid": 1, "invoicenum": "", "date": "2022-12-13", "duedate": "2022-12-13", "datepaid": "0000-00-00 00:00:00", "last_capture_attempt": "0000-00-00 00:00:00", "date_refunded": "0000-00-00 00:00:00", "date_cancelled": "0000-00-00 00:00:00", "subtotal": "10.00", "credit": "0.00", "tax": "0.00", "tax2": "0.00", "total": "10.00", "taxrate": "0.000", "taxrate2": "0.000", "status": "Unpaid", "paymentmethod": "banktransfer", "created_at": "2022-12-13 07:36:02", "updated_at": "2022-12-13 07:36:02" } } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": "Resource not found" } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] } }, "/logs": { "get": { "tags": [ "Log Management" ], "summary": "Get all logs", "description": "Returns a list of logs in your account(s)", "parameters": [ { "name": "limit", "in": "query", "description": "Database limit", "required": false, "schema": { "type": "integer" }, "example": 100 }, { "name": "offset", "in": "query", "description": "Database offset", "required": false, "schema": { "type": "integer" }, "example": 0 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true, "data": { "success": true, "data": [ { "id": 123, "ip_address": "127.0.0.1", "ip_address_fwd": "", "status": "INFO", "message": "Command Completed Successfully", "request": "/logs?limit=100&offset=0", "response": "---", "date": "2025-01-01 12:00:00" } ] } } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": { "message": "Your API Key has no permissions to run this action!" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": { "message": "No logs found" } } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] } }, "/logs/{id}": { "get": { "tags": [ "Log Management" ], "summary": "Get a single log by ID", "description": "Returns log details by log ID", "parameters": [ { "name": "id", "in": "path", "description": "Log ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true, "data": { "success": true, "data": { "id": 123, "ip_address": "127.0.0.1", "ip_address_fwd": "", "status": "INFO", "message": "Command Completed Successfully", "request": "/logs?limit=100&offset=0", "response": "---", "date": "2025-01-01 12:00:00" } } } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": { "message": "Your API Key has no permissions to run this action!" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": { "message": "Log not found" } } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] } }, "/ssl": { "get": { "tags": [ "SSL Certificates Management" ], "summary": "Get all SSL certificates in your account(s)", "description": "Returns list of clients SSL certificates", "parameters": [ { "name": "limit", "in": "query", "description": "Database limit", "required": false, "schema": { "type": "integer" }, "example": 100 }, { "name": "offset", "in": "query", "description": "Database offset", "required": false, "schema": { "type": "integer" }, "example": 0 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true, "data": [ { "id": 1234, "userid": 123, "packageid": 1, "paymentmethod": "sepaincasso", "amount": "43.21", "billingcycle": "Annually", "nextduedate": "2025-01-01", "nextinvoicedate": "2026-01-01", "subscription_status": "Active", "commonname": "example.com", "certificate_status": "SUSPENDED", "expirydate": null, "certificate_type": "MULTI_DOMAIN", "validation_type": "SINGLE_DOMAIN", "dcv_method": "DNS", "brand": "PERFECTSSL", "san": [ "example2.nl", "example4.nl", "example3.nl", "example5.nl" ] } ] } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": "Resource not found" } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] } }, "/ssl/{id}": { "get": { "tags": [ "SSL Certificates Management" ], "summary": "Get all SSL certificate details", "description": "Returns SSL certificate details by ID", "parameters": [ { "name": "id", "in": "path", "description": "SSL certificate ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true, "data": { "id": 1234, "userid": 123, "packageid": 1, "paymentmethod": "sepaincasso", "amount": "43.21", "billingcycle": "Annually", "nextduedate": "2025-01-01", "nextinvoicedate": "2026-01-01", "subscription_status": "Active", "commonname": "example.com", "certificate_status": "SUSPENDED", "expirydate": null, "certificate_type": "MULTI_DOMAIN", "validation_type": "SINGLE_DOMAIN", "dcv_method": "DNS", "brand": "PERFECTSSL", "san": [ "example2.nl", "example4.nl", "example3.nl", "example5.nl" ] } } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": "Resource not found" } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] } }, "/ssl/{id}/validation": { "get": { "tags": [ "SSL Certificates Management" ], "summary": "Get SSL validation status for a certificate", "description": "Returns the validation records for pending validation process", "parameters": [ { "name": "id", "in": "path", "description": "SSL certificate ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true, "data": { "id": 1234, "userid": 123, "packageid": 1, "paymentmethod": "sepaincasso", "amount": "43.21", "billingcycle": "Annually", "nextduedate": "2025-01-01", "nextinvoicedate": "2026-01-01", "subscription_status": "Active", "commonname": "example.nl", "certificate_status": "SUSPENDED", "expirydate": null, "certificate_type": "MULTI_DOMAIN", "validation_type": "SINGLE_DOMAIN", "dcv_method": "DNS", "brand": "PERFECTSSL", "san": [ "example1.nl", "example2.nl" ], "validations": { "organization": null, "docs": null, "voice": null, "whois": null, "dcv": { "entities": [ { "commonName": "example.nl", "type": "DNS", "status": "WAITING", "email": "admin@example.nl", "dnsRecord": "_dnsauth.example.nl", "dnsType": "CNAME", "dnsContents": "g72t2phivcc89xyr.dcv.digicert.com", "fileLocation": "example.nl/.well-known/pki-validation/fileauth.txt", "fileContents": "g72t2phivcc89xyr" }, { "commonName": "example1.nl", "type": "DNS", "status": "WAITING", "email": "admin@example1.nl", "dnsRecord": "_dnsauth.example1.nl", "dnsType": "CNAME", "dnsContents": "g72t2phivcc89xyr.dcv.digicert.com", "fileLocation": "example1.nl/.well-known/pki-validation/fileauth.txt", "fileContents": "g72t2phivcc89xyr" }, { "commonName": "example2.nl", "type": "DNS", "status": "WAITING", "email": "admin@example2.nl", "dnsRecord": "_dnsauth.example2.nl", "dnsType": "CNAME", "dnsContents": "g72t2phivcc89xyr.dcv.digicert.com", "fileLocation": "example2.nl/.well-known/pki-validation/fileauth.txt", "fileContents": "g72t2phivcc89xyr" } ] } } } } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": "Resource not found" } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] } }, "/ssl/{id}/download": { "get": { "tags": [ "SSL Certificates Management" ], "summary": "Download SSL certificate", "description": "Download latest SSL certificate by subscription ID. Please check the expiry_date to ensure you have downloaded the right certificate. If the certificate has not been renewed yet the current certificate is returned.", "parameters": [ { "name": "id", "in": "path", "description": "SSL certificate ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true, "data": { "id": 1234, "userid": 123, "packageid": 1, "paymentmethod": "sepaincasso", "amount": "123.00", "billingcycle": "Annually", "nextduedate": "2025-01-01", "nextinvoicedate": "2026-01-01", "subscription_status": "Active", "commonname": "example.nl", "certificate_status": "ACTIVE", "expirydate": "2026-08-01T12:00:00+00:00", "certificate_type": "MULTI_DOMAIN", "validation_type": "ORGANISATION_VALIDATION", "dcv_method": "DNS", "brand": "PERFECTSSL", "san": [ "example1.nl", "example2.nl", "example3.nl", "example4.nl" ], "cert": { "domain": "example.nl", "validation_type": "ORGANIZATION_VALIDATION", "certificate_type": "MULTI_DOMAIN", "organization": "Hosting.NL", "department": "", "address": [ "street 123" ], "city": "Alkmaar", "state": "Noord-Holland", "postal_code": "1000AA", "country": "NL", "coc": "", "san": [ "example1.nl", "example2.nl", "example3.nl", "example4.nl" ], "status": "ACTIVE", "start_date": "2025-08-01T12:00:00+00:00", "expiry_date": "2026-08-01T12:00:00+00:00", "key": "-----BEGIN PRIVATE KEY-----", "crt": "-----BEGIN CERTIFICATE-----", "ca_bundle": "-----BEGIN CERTIFICATE-----" } } } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": "Resource not found" } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] } }, "/ssl/{id}/dcv": { "put": { "tags": [ "SSL Certificates Management" ], "summary": "Change or resend DCV method", "description": "Change the DCV method, this also triggers a revalidation of the DCV.", "parameters": [ { "name": "id", "in": "path", "description": "SSL certificate ID", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "example": { "dcv": [ { "commonName": "example.com", "type": "EMAIL", "email": "admin@example.com" }, { "commonName": "www.example.com", "type": "DNS" }, { "commonName": "mail.example.com", "type": "FILE" } ] } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": "Resource not found" } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] } }, "/tlds": { "get": { "tags": [ "TLD's Management" ], "summary": "Get all TLD's - Reseller only", "description": "Returns a list of all TLD's available", "parameters": [ { "name": "limit", "in": "query", "description": "Database limit", "required": false, "schema": { "type": "integer" }, "example": 100 }, { "name": "offset", "in": "query", "description": "Database offset", "required": false, "schema": { "type": "integer" }, "example": 0 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true, "data": [ { "tld": "nl", "currency": "EUR", "billingcycles": [ { "years": "1", "domainregister": "7.99", "domaintransfer": "8.99", "domainrenew": "9.99" } ] } ] } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": "Resource not found" } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] } }, "/tlds/{tld}": { "get": { "tags": [ "TLD's Management" ], "summary": "Get TLD Details - Reseller only", "description": "Returns informations about the given TLD", "parameters": [ { "name": "tld", "in": "path", "description": "TLD", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true, "data": { "tld": "nl", "currency": "EUR", "billingcycles": [ { "years": "1", "domainregister": "7.99", "domaintransfer": "8.99", "domainrenew": "9.99" } ] } } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": "Resource not found" } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] } }, "/webhosting": { "get": { "tags": [ "Hosting Management" ], "summary": "Get all hosting subscriptions", "description": "Returns list of all hosting subscriptions", "parameters": [ { "name": "limit", "in": "query", "description": "Database limit", "required": false, "schema": { "type": "integer" }, "example": 100 }, { "name": "offset", "in": "query", "description": "Database offset", "required": false, "schema": { "type": "integer" }, "example": 0 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true, "data": [ { "id": 1, "userid": 1, "orderid": 4, "packageid": 1, "server": 0, "regdate": "2023-03-17", "domain": "testdom1.com", "paymentmethod": "banktransfer", "qty": 1, "firstpaymentamount": "11.00", "amount": "10.00", "billingcycle": "Monthly", "nextduedate": "2023-03-17", "nextinvoicedate": "2023-03-17", "termination_date": "0000-00-00", "domainstatus": "Active", "promoid": 0, "promocount": 0, "overideautosuspend": 0, "overidesuspenduntil": "0000-00-00", "dedicatedip": "", "assignedips": "", "ns1": "", "ns2": "", "lastupdate": "0000-00-00 00:00:00", "created_at": "-0001-11-30 00:00:00", "updated_at": "2023-03-17 13:31:44" } ] } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": "Resource not found" } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] }, "post": { "tags": [ "Hosting Management" ], "summary": "Adds an order for a new hosting subscription", "requestBody": { "content": { "application/json": { "schema": { "example": { "clientid": "7", "paymentmethod": "banktransfer", "pid": 4, "domain": "janjansen.nl" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true, "data": { "orderid": "1", "serviceids": "1", "addonids": "1", "domainids": "1", "invoiceid": "1" } } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": "Resource not found" } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] } }, "/webhosting/{id}": { "get": { "tags": [ "Hosting Management" ], "summary": "Get hosting details", "description": "Returns hosting details by hosting ID", "parameters": [ { "name": "id", "in": "path", "description": "Webhosting ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true, "data": { "id": 1, "userid": 1, "orderid": 4, "packageid": 1, "server": 0, "regdate": "2023-03-17", "domain": "testdom1.com", "paymentmethod": "banktransfer", "qty": 1, "firstpaymentamount": "11.00", "amount": "10.00", "billingcycle": "Monthly", "nextduedate": "2023-03-17", "nextinvoicedate": "2023-03-17", "termination_date": "0000-00-00", "domainstatus": "Active", "promoid": 0, "promocount": 0, "overideautosuspend": 0, "overidesuspenduntil": "0000-00-00", "dedicatedip": "", "assignedips": "", "ns1": "", "ns2": "", "lastupdate": "0000-00-00 00:00:00", "created_at": "-0001-11-30 00:00:00", "updated_at": "2023-03-17 13:31:44" } } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": "Resource not found" } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] }, "put": { "tags": [ "Hosting Management" ], "summary": "Update an existing hosting subscription", "parameters": [ { "name": "id", "in": "path", "description": "Webhosting ID", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "example": { "status": "Terminated", "notes": "Some reason" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true, "data": { "serviceid": "1" } } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": "Resource not found" } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] } }, "/webhosting/all": { "get": { "tags": [ "Hosting Management" ], "summary": "Retrieve a list of all hosting products", "description": "Returns a list of all hosting products that are available to order", "parameters": [ { "name": "limit", "in": "query", "description": "Database limit", "required": false, "schema": { "type": "integer" }, "example": 100 }, { "name": "offset", "in": "query", "description": "Database offset", "required": false, "schema": { "type": "integer" }, "example": 0 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "success": { "description": "Response returned if request was processed correctly", "type": "boolean" }, "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} }, "data": { "description": "The response data", "type": "array", "items": {} } }, "type": "object", "example": { "success": true, "data": [ { "pid": 1, "gid": 1, "type": "hostingaccount", "name": "Best Hosting Plan", "slug": "best-hosting-plan", "product-url": "url", "description": "This is our best hosting plan, with all the bells and whistles.", "module": "cpanel", "paytype": "recurring" } ] } } } } }, "401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Error Message" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "error": "Resource not found" } } } } }, "500": { "description": "General Error", "content": { "application/json": { "schema": { "properties": { "errors": { "description": "Response returned in case of some errors during the request", "type": "array", "items": {} } }, "type": "object", "example": { "errors": { "message": "Something went wrong" } } } } } } }, "security": [ { "API-TOKEN": [] } ] } } }, "components": { "securitySchemes": { "API-TOKEN": { "type": "apiKey", "name": "API-TOKEN", "in": "header" } } }, "tags": [ { "name": "Domain Management", "description": "Manage all domains in your account(s)" }, { "name": "Hosting Management", "description": "Retrieve information for hosting subscriptions and place orders for new hosting products" }, { "name": "SSL Certificates Management", "description": "Manage your SSL portfolio" }, { "name": "Invoices Management", "description": "Manage your clients invoices" }, { "name": "TLD's Management", "description": "Retrieve all information related to TLD's, only applicable for partners" }, { "name": "Contact Management", "description": "Manage contacts - also to be used for Domain Management" }, { "name": "Client Management", "description": "Manage your clients, only applicable for partners" }, { "name": "Log Management", "description": "Retrief API log details" }, { "name": "API Key Management", "description": "Retrief API key details" } ] }