{ "consumes": [ "application/json" ], "produces": [ "application/json" ], "schemes": [ "https" ], "swagger": "2.0", "info": { "title": "REST API", "version": "1.0.0-beta" }, "host": "api.openprovider.eu", "paths": { "/v1beta/auth/login": { "post": { "tags": [ "Auth" ], "summary": "Login with username and password", "operationId": "Login", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/authLoginRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/authLoginResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/contacts": { "get": { "tags": [ "ContactService" ], "summary": "List contacts", "operationId": "ListContacts", "parameters": [ { "type": "integer", "format": "int32", "description": "Output limit.", "name": "limit", "in": "query" }, { "type": "integer", "format": "int32", "description": "Output offset.", "name": "offset", "in": "query" }, { "type": "string", "description": "Output ordering pattern. ASC / DESC.", "name": "order", "in": "query" }, { "type": "string", "description": "Order output by field (i.e. first_name).", "name": "order_by", "in": "query" }, { "type": "string", "description": "Full or partial email address. Wildcard (*) can be used.", "name": "email_pattern", "in": "query" }, { "type": "string", "description": "Full or partial last name. Wildcard (*) can be used.", "name": "last_name_pattern", "in": "query" }, { "type": "string", "description": "Full or partial company name. Wildcard (*) can be used.", "name": "company_name_pattern", "in": "query" }, { "type": "string", "description": "The username pattern.", "name": "username_pattern", "in": "query" }, { "type": "string", "description": "Contact's role.", "name": "role", "in": "query" }, { "type": "boolean", "format": "boolean", "description": "Retrieves objects with (1) or without (0) additional data.", "name": "with_additional_data", "in": "query" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/contactListContactsResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } }, "post": { "tags": [ "ContactService" ], "summary": "Create contact", "operationId": "CreateContact", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/contactCreateContactRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/contactCreateContactResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/contacts/{id}": { "get": { "tags": [ "ContactService" ], "summary": "Get contact", "operationId": "GetContact", "parameters": [ { "type": "integer", "format": "int32", "description": "Object ID", "name": "id", "in": "path", "required": true }, { "type": "boolean", "format": "boolean", "description": "Retrieves objects with (1) or without (0) additional data.", "name": "with_additional_data", "in": "query" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/contactGetContactResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } }, "put": { "tags": [ "ContactService" ], "summary": "Update contact", "operationId": "UpdateContact", "parameters": [ { "type": "integer", "format": "int32", "description": "Object ID", "name": "id", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/contactUpdateContactRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/contactUpdateContactResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } }, "delete": { "tags": [ "ContactService" ], "summary": "Delete contact", "operationId": "DeleteContact", "parameters": [ { "type": "integer", "format": "int32", "description": "Object ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/contactDeleteContactResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/customers": { "get": { "tags": [ "Customer" ], "summary": "List customers", "externalDocs": { "description": "For more detailed information on this method check our guide", "url": "https://openprovider.zendesk.com/knowledge/articles/360024737413" }, "operationId": "ListCustomers", "parameters": [ { "type": "integer", "format": "int32", "description": "Your reseller id is used by default. Other values not accepted.", "name": "reseller_id", "in": "query" }, { "type": "integer", "format": "int32", "description": "Output limit.", "name": "limit", "in": "query" }, { "type": "integer", "format": "int32", "description": "Output offset.", "name": "offset", "in": "query" }, { "type": "string", "description": "Output ordering pattern. ASC / DESC.", "name": "order", "in": "query" }, { "type": "string", "description": "Order output by field (i.e. first_name).", "name": "order_by", "in": "query" }, { "type": "string", "description": "Full or partial email address. Wildcard (*) can be used.", "name": "email_pattern", "in": "query" }, { "type": "string", "description": "Full or partial company name. Wildcard (*) can be used.", "name": "company_name_pattern", "in": "query" }, { "type": "string", "description": "Full or partial last name. Wildcard (*) can be used.", "name": "last_name_pattern", "in": "query" }, { "type": "string", "description": "Full or partial first name. Wildcard (*) can be used.", "name": "first_name_pattern", "in": "query" }, { "type": "string", "description": "Full or partial comment value. Wildcard (*) can be used.", "name": "comment_pattern", "in": "query" }, { "type": "string", "description": "Full or partial handle name. Wildcard (*) can be used.", "name": "handle_pattern", "in": "query" }, { "type": "string", "description": "ull or partial first name or last name or company name or handle. Wildcard (*) can be used.", "name": "pattern", "in": "query" }, { "type": "boolean", "format": "boolean", "description": "Retrieves objects with (1) or without (0) additional data.", "name": "with_additional_data", "in": "query" }, { "type": "string", "description": "Customer type: 'company' or 'individual'. If customer has not empty 'companyName' than type is 'company', otherwise 'individual'.", "name": "type", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "\u0421olumns to retrieve. Possible values: 'firstName', 'prefix', 'initials', 'lastName', 'companyName', 'email', 'handle', 'id', 'fullName'.", "name": "columns", "in": "query" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/customerListCustomersResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } }, "post": { "tags": [ "Customer" ], "summary": "Create customer", "externalDocs": { "description": "For more detailed information on this method check our guide", "url": "https://openprovider.zendesk.com/knowledge/articles/360024622893" }, "operationId": "CreateCustomer", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/customerCreateCustomerRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/customerCreateCustomerResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/customers/verifications/emails/domains": { "get": { "tags": [ "EmailVerification" ], "summary": "List domain email verifications", "operationId": "ListDomainEmailVerifications", "parameters": [ { "type": "integer", "format": "int32", "description": "The domain id.", "name": "domain_id", "in": "query" }, { "type": "string", "description": "The domain.", "name": "domain", "in": "query" }, { "type": "string", "description": "The email.", "name": "email", "in": "query" }, { "type": "string", "description": "The handle.", "name": "handle", "in": "query" }, { "type": "string", "description": "The status.", "name": "status", "in": "query" }, { "type": "string", "description": "The description.", "name": "description", "in": "query" }, { "type": "boolean", "format": "boolean", "description": "Is suspended.", "name": "is_suspended", "in": "query" }, { "type": "string", "description": "The type.", "name": "response.type", "in": "query" }, { "type": "string", "description": "The to.", "name": "response.to", "in": "query" }, { "type": "integer", "format": "int32", "description": "The limit.", "name": "limit", "in": "query" }, { "type": "integer", "format": "int32", "description": "The offset.", "name": "offset", "in": "query" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/emailListDomainVerificationsResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/customers/verifications/emails/restart": { "post": { "tags": [ "EmailVerification" ], "summary": "Restart email verification", "operationId": "RestartEmailVerification", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/emailRestartEmailVerificationRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/emailRestartEmailVerificationResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/customers/verifications/emails/start": { "post": { "tags": [ "EmailVerification" ], "summary": "Start email verification", "operationId": "StartEmailVerification", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/emailStartEmailVerificationRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/emailStartEmailVerificationResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/customers/{handle}": { "get": { "tags": [ "Customer" ], "summary": "Get customer", "externalDocs": { "description": "For more detailed information on this method check our guide", "url": "https://openprovider.zendesk.com/knowledge/articles/360024737413" }, "operationId": "GetCustomer", "parameters": [ { "type": "string", "description": "Customer unique identifier or handle, which can be created via CreateCustomer API method", "name": "handle", "in": "path", "required": true }, { "type": "boolean", "format": "boolean", "description": "Retrieves objects with (1) or without (0) additional data.", "name": "with_additional_data", "in": "query" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/customerGetCustomerResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } }, "put": { "tags": [ "Customer" ], "summary": "Update customer", "externalDocs": { "description": "For more detailed information on this method check our guide", "url": "https://openprovider.zendesk.com/knowledge/articles/360024591034" }, "operationId": "UpdateCustomer", "parameters": [ { "type": "string", "description": "Customer unique identifier or handle, which can be created via CreateCustomer API method", "name": "handle", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/customerUpdateCustomerRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/customerUpdateCustomerResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } }, "delete": { "tags": [ "Customer" ], "summary": "Delete customer", "externalDocs": { "description": "For more detailed information on this method check our guide", "url": "https://openprovider.zendesk.com/knowledge/articles/360024591294" }, "operationId": "DeleteCustomer", "parameters": [ { "type": "string", "description": "Customer unique identifier or handle, which can be created via CreateCustomer API method", "name": "handle", "in": "path", "required": true } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/customerDeleteCustomerResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/dns/domain-token": { "post": { "tags": [ "DomainToken" ], "summary": "Create token", "operationId": "CreateToken", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/domain_tokenCreateTokenRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/domain_tokenCreateTokenResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/dns/nameservers": { "get": { "tags": [ "NameserverService" ], "summary": "List nameservers", "operationId": "ListNameservers", "parameters": [ { "type": "string", "description": "Nameserver name.", "name": "name", "in": "query" }, { "type": "string", "description": "Nameserver IP.", "name": "ip", "in": "query" }, { "type": "string", "description": "Nameserver IPv6.", "name": "ip6", "in": "query" }, { "type": "string", "description": "Nameserver name search pattern. Wildcatd (*) can be used.", "name": "pattern", "in": "query" }, { "type": "integer", "format": "int32", "default": 100, "description": "Limits the number of objects in the output.", "name": "limit", "in": "query" }, { "type": "string", "description": "Used to retrieve all objects from a certain offset up to the limit.", "name": "offset", "in": "query" }, { "type": "string", "default": "asc", "description": "Sorting type (asc/desc).", "name": "order", "in": "query" }, { "type": "string", "default": "name", "description": "Field for sorting output. Possible values: id, name.", "name": "order_by", "in": "query" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/nameserverListNameserversResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } }, "post": { "tags": [ "NameserverService" ], "summary": "Create nameserver", "operationId": "CreateNameserver", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/nameserverNameserver" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/nameserverCreateNameserverResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/dns/nameservers/groups": { "get": { "tags": [ "NsGroupService" ], "summary": "List groups", "operationId": "ListGroups", "parameters": [ { "type": "integer", "format": "int32", "default": 100, "description": "Limits the number of objects in the output.", "name": "limit", "in": "query" }, { "type": "integer", "format": "int32", "description": "Used to retrieve all objects from a certain offset up to the limit. (default value: 0).", "name": "offset", "in": "query" }, { "type": "string", "default": "asc", "description": "Sorting type (asc/desc).", "name": "order_by.ns_group", "in": "query" }, { "type": "string", "description": "Sorting type (asc/desc).", "name": "order_by.domain_count", "in": "query" }, { "type": "string", "description": "Sorting type (asc/desc).", "name": "order_by.ns_count", "in": "query" }, { "type": "boolean", "format": "boolean", "description": "Indicates if number of domains associated with the NS group should be returned.", "name": "with_domain_count", "in": "query" }, { "type": "boolean", "format": "boolean", "description": "Indicates if number of nameservers associated with the NS group should be returned.", "name": "with_ns_count", "in": "query" }, { "type": "string", "description": "NS group name pattern. Wildcard (*) can be used.", "name": "ns_group_pattern", "in": "query" }, { "type": "string", "description": "Nameserver name pattern. Wildcard (*) can be used.", "name": "ns_name_pattern", "in": "query" }, { "type": "string", "description": "Nameserver IP address pattern. Wildcard (*) can be used.", "name": "ns_ip_pattern", "in": "query" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/ns_groupListGroupsResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } }, "post": { "tags": [ "NsGroupService" ], "summary": "Create group", "operationId": "CreateGroup", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ns_groupCreateGroupRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/ns_groupCreateGroupResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/dns/nameservers/groups/{ns_group}": { "get": { "tags": [ "NsGroupService" ], "summary": "Get group", "operationId": "GetGroup", "parameters": [ { "type": "string", "description": "Plain text name of the nameserver group, which can consist of several nameservers with attached IPs. Once created in Openprovider reseller account, nameserver group can be reused for operations with domains.", "name": "ns_group", "in": "path", "required": true }, { "type": "integer", "format": "int32", "description": "Nameserver group ID.", "name": "id", "in": "query" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/ns_groupGetGroupResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } }, "put": { "tags": [ "NsGroupService" ], "summary": "Update group", "operationId": "UpdateGroup", "parameters": [ { "type": "string", "description": "Plain text name of the nameserver group, which can consist of several nameservers with attached IPs. Once created in Openprovider reseller account, nameserver group can be reused for operations with domains.", "name": "ns_group", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ns_groupUpdateGroupRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/ns_groupGroupBoolResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } }, "delete": { "tags": [ "NsGroupService" ], "summary": "Delete group", "operationId": "DeleteGroup", "parameters": [ { "type": "string", "description": "Plain text name of the nameserver group, which can consist of several nameservers with attached IPs. Once created in Openprovider reseller account, nameserver group can be reused for operations with domains.", "name": "ns_group", "in": "path", "required": true } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/ns_groupGroupBoolResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/dns/nameservers/{name}": { "get": { "tags": [ "NameserverService" ], "summary": "Get nameserver", "operationId": "GetNameserver", "parameters": [ { "type": "string", "description": "Nameserver name", "name": "name", "in": "path", "required": true } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/nameserverGetNameserverResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } }, "put": { "tags": [ "NameserverService" ], "summary": "Update nameserver", "operationId": "UpdateNameserver", "parameters": [ { "type": "string", "description": "Nameserver name", "name": "name", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/nameserverNameserver" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/nameserverNameserverBoolResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } }, "delete": { "tags": [ "NameserverService" ], "summary": "Delete nameserver", "operationId": "DeleteNameserver", "parameters": [ { "type": "string", "description": "Nameserver name", "name": "name", "in": "path", "required": true } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/nameserverNameserverBoolResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/dns/templates": { "get": { "tags": [ "TemplateService" ], "summary": "List templates", "operationId": "ListTemplates", "parameters": [ { "type": "integer", "format": "int32", "default": 100, "description": "Limits the number of objects in the output.", "name": "limit", "in": "query" }, { "type": "string", "description": "Used to retrieve all objects from a certain offset up to the limit.", "name": "offset", "in": "query" }, { "type": "string", "default": "asc", "description": "Sorting type (asc/desc).", "name": "order", "in": "query" }, { "type": "string", "default": "name", "description": "Field for sorting output. Possible value: name.", "name": "order_by", "in": "query" }, { "type": "boolean", "format": "boolean", "default": false, "description": "Indicates if DNS records should be retrieved.", "name": "with_records", "in": "query" }, { "type": "string", "description": "Template name pattern. Wildcard (*)can be used.", "name": "name_pattern", "in": "query" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/templateListTemplatesResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } }, "post": { "tags": [ "TemplateService" ], "summary": "Create template", "operationId": "CreateTemplate", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/templateCreateTemplateRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/templateCreateTemplateResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/dns/templates/{id}": { "get": { "tags": [ "TemplateService" ], "summary": "Get template", "operationId": "GetTemplate", "parameters": [ { "type": "integer", "format": "int32", "description": "Template ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/templateGetTemplateResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } }, "delete": { "tags": [ "TemplateService" ], "summary": "Delete template", "operationId": "DeleteTemplate", "parameters": [ { "type": "integer", "format": "int32", "description": "Template ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/templateTemplateBoolResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/dns/zones": { "get": { "tags": [ "ZoneService" ], "summary": "List zones", "externalDocs": { "description": "For more detailed information on this method check our guide", "url": "https://support.openprovider.eu/hc/en-us/articles/360024168694" }, "operationId": "ListZones", "parameters": [ { "type": "integer", "format": "int32", "default": 100, "description": "Limits the number of objects in the output. (default value: 100, maximum value: 500).", "name": "limit", "in": "query" }, { "type": "integer", "format": "int32", "description": "Used to retrieve all objects from a certain offset up to the. (default value: 0).", "name": "offset", "in": "query" }, { "type": "string", "default": "desc", "description": "Sorting type (asc/desc).", "name": "order_by.creation_date", "in": "query" }, { "type": "string", "description": "Sorting type (asc/desc).", "name": "order_by.modification_date", "in": "query" }, { "type": "string", "description": "Sorting type (asc/desc).", "name": "order_by.name", "in": "query" }, { "type": "string", "description": "DNS zone type (master or slave).", "name": "type", "in": "query" }, { "type": "string", "description": "DNS zone name pattern. Wildcard (*) can be used.", "name": "name_pattern", "in": "query" }, { "type": "boolean", "format": "boolean", "description": "Indicates, whether DNS records should be displayed in output.", "name": "with_records", "in": "query" }, { "type": "boolean", "format": "boolean", "description": "Indicates, whether DNS zone history should be displayed in output.", "name": "with_history", "in": "query" }, { "type": "boolean", "format": "boolean", "description": "Indicates, whether DNSSEC keys should be displayed in output.", "name": "with_dnskey", "in": "query" }, { "type": "string", "description": "Name of the DNS provider. Set provider=sectigo in case of only sectigo premium DNS zone should be retrieved.", "name": "provider", "in": "query" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/zoneListZonesResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } }, "post": { "tags": [ "ZoneService" ], "summary": "Create zone", "externalDocs": { "description": "For more detailed information on this method check our guide", "url": "https://support.openprovider.eu/hc/en-us/articles/360023491794" }, "operationId": "CreateZone", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/zoneCreateZoneRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/zoneZoneBoolResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/dns/zones/{name}": { "get": { "tags": [ "ZoneService" ], "summary": "Get zone", "externalDocs": { "description": "For more detailed information on this method check our guide", "url": "https://support.openprovider.eu/hc/en-us/articles/360024168694" }, "operationId": "GetZone", "parameters": [ { "type": "string", "description": "Name of the domain to which DNS zone corresponds", "name": "name", "in": "path", "required": true }, { "type": "string", "description": "DNS zone ID.", "name": "id", "in": "query" }, { "type": "boolean", "format": "boolean", "default": false, "description": "Indicates, whether DNS records should be displayed in output.", "name": "with_records", "in": "query" }, { "type": "boolean", "format": "boolean", "default": false, "description": "Indicates, whether DNS zone history should be displayed in output.", "name": "with_history", "in": "query" }, { "type": "boolean", "format": "boolean", "description": "Indicates, whether DNSSEC keys should be displayed in output.", "name": "with_dnskey", "in": "query" }, { "type": "string", "description": "Name of the DNS provider. Set provider=sectigo in case of only sectigo premium DNS zone should be retrieved.", "name": "provider", "in": "query" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/zoneGetZoneResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } }, "put": { "tags": [ "ZoneService" ], "summary": "Update zone", "externalDocs": { "description": "For more detailed information on this method check our guide", "url": "https://support.openprovider.eu/hc/en-us/articles/360024342733" }, "operationId": "UpdateZone", "parameters": [ { "type": "string", "description": "Name of the domain to which DNS zone corresponds", "name": "name", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/zoneUpdateZoneRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/zoneZoneBoolResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } }, "delete": { "tags": [ "ZoneService" ], "summary": "Delete zone", "externalDocs": { "description": "For more detailed information on this method check our guide", "url": "https://support.openprovider.eu/hc/en-us/articles/360024231654" }, "operationId": "DeleteZone", "parameters": [ { "type": "string", "description": "Name of the domain to which DNS zone corresponds", "name": "name", "in": "path", "required": true }, { "type": "integer", "format": "int32", "description": "DNS zone ID.", "name": "id", "in": "query" }, { "type": "string", "description": "Domain name without extension.", "name": "domain.name", "in": "query" }, { "type": "string", "description": "Domain extension.", "name": "domain.extension", "in": "query" }, { "type": "string", "description": "Name of the DNS provider. Set provider=sectigo in case of sectigo premium DNS zone should be deleted.", "name": "provider", "in": "query" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/zoneZoneBoolResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/dns/zones/{name}/records": { "get": { "tags": [ "ZoneRecordService" ], "summary": "List zone records", "operationId": "ListZoneRecords", "parameters": [ { "type": "string", "description": "DNS record name", "name": "name", "in": "path", "required": true }, { "type": "integer", "format": "int32", "description": "DNS zone ID.", "name": "zone_id", "in": "query" }, { "type": "integer", "format": "int32", "default": 100, "description": "How many records to retrieve (default: 100, max 500).", "name": "limit", "in": "query" }, { "type": "integer", "format": "int32", "description": "From which record to retrieve (default: 0).", "name": "offset", "in": "query" }, { "type": "string", "default": "asc", "description": "Sorting type (asc/desc).", "name": "order_by.type", "in": "query" }, { "type": "string", "default": "asc", "description": "Sorting type (asc/desc).", "name": "order_by.name", "in": "query" }, { "type": "string", "description": "Sorting type (asc/desc).", "name": "order_by.value", "in": "query" }, { "type": "string", "description": "Sorting type (asc/desc).", "name": "order_by.ttl", "in": "query" }, { "type": "string", "description": "Sorting type (asc/desc).", "name": "order_by.prio", "in": "query" }, { "type": "string", "description": "DNS record name pattern. Wildcard (*) can be used.", "name": "record_name_pattern", "in": "query" }, { "type": "string", "description": "DNS record value pattern. Wildcard (*) can be used.", "name": "value_pattern", "in": "query" }, { "type": "string", "description": "DNS record type.", "name": "type", "in": "query" }, { "type": "integer", "format": "int32", "description": "DNS record priority.", "name": "prio", "in": "query" }, { "type": "integer", "format": "int32", "description": "DNS record TTL.", "name": "ttl", "in": "query" }, { "type": "string", "description": "Name of the DNS provider. Set zone_provider=sectigo in case of only sectigo premium DNS zone records should be retrieved.", "name": "zone_provider", "in": "query" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/recordListZoneRecordsResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/domains": { "get": { "tags": [ "DomainService" ], "summary": "List domains", "operationId": "ListDomains", "parameters": [ { "type": "string", "description": "Domain id number.", "name": "order_by.id", "in": "query" }, { "type": "string", "description": "The domain name.", "name": "order_by.domain_name", "in": "query" }, { "type": "string", "description": "Domain extension.", "name": "order_by.domain_extension", "in": "query" }, { "type": "string", "description": "The order date.", "name": "order_by.order_date", "in": "query" }, { "type": "string", "description": "The active date.", "name": "order_by.active_date", "in": "query" }, { "type": "string", "description": "Domain expiration date.", "name": "order_by.expiration_date", "in": "query" }, { "type": "string", "description": "Date on which domain will be renewed.", "name": "order_by.renewal_date", "in": "query" }, { "type": "string", "description": "Domain status.", "name": "order_by.status", "in": "query" }, { "type": "string", "description": "The transfer date.", "name": "order_by.transfer_date", "in": "query" }, { "type": "integer", "format": "int32", "description": "The limit.", "name": "limit", "in": "query" }, { "type": "integer", "format": "int32", "description": "The offset.", "name": "offset", "in": "query" }, { "type": "integer", "format": "int32", "description": "Domain id number.", "name": "id", "in": "query" }, { "type": "string", "description": "Domain extension.", "name": "extension", "in": "query" }, { "type": "string", "description": "Date on which domain will be renewed.", "name": "renewal_date", "in": "query" }, { "type": "string", "description": "Full name of the domain.", "name": "full_name", "in": "query" }, { "type": "string", "description": "The domain name pattern.", "name": "domain_name_pattern", "in": "query" }, { "type": "string", "description": "Nameserver group name pattern.", "name": "ns_group_pattern", "in": "query" }, { "type": "string", "description": "Domain status.", "name": "status", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Array of domain statuses to exclude.", "name": "status_not_equal", "in": "query" }, { "type": "string", "description": "The queue status.", "name": "queue_status", "in": "query" }, { "type": "string", "description": "Handle to filter by.", "name": "contact_handle", "in": "query" }, { "type": "string", "description": "The comment pattern.", "name": "comment_pattern", "in": "query" }, { "type": "boolean", "format": "boolean", "description": "With history.", "name": "with_history", "in": "query" }, { "type": "boolean", "format": "boolean", "description": "With api history.", "name": "with_api_history", "in": "query" }, { "type": "boolean", "format": "boolean", "description": "With additional data.", "name": "with_additional_data", "in": "query" }, { "type": "string", "description": "When new gTLD is started it gets through several phases before it becomes available for registration to everybody (General availability or GA). There are several phases before GA when it is still possible to apply for a domain, but with some restrictions.", "name": "application_mode", "in": "query" }, { "type": "boolean", "format": "boolean", "description": "Returns information about domain owner email verification status.", "name": "with_verification_email", "in": "query" }, { "type": "boolean", "format": "boolean", "description": "Indicates, if registry EPP statuses should be retrieved.", "name": "with_registry_statuses", "in": "query" }, { "type": "string", "description": "The type.", "name": "response.type", "in": "query" }, { "type": "string", "description": "The to.", "name": "response.to", "in": "query" }, { "type": "boolean", "format": "boolean", "description": "Indicates whether object is deleted.", "name": "is_deleted", "in": "query" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/domainListDomainsResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } }, "post": { "tags": [ "DomainService" ], "summary": "Create domain", "operationId": "CreateDomain", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/domainCreateDomainRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/domainCreateDomainResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/domains/additional-data": { "get": { "tags": [ "AdditionalData" ], "summary": "Get additional data", "operationId": "GetAdditionalData", "parameters": [ { "type": "string", "description": "Domain name without extension.", "name": "domain.name", "in": "query" }, { "type": "string", "description": "Domain extension.", "name": "domain.extension", "in": "query" }, { "type": "string", "description": "The operation.", "name": "operation", "in": "query" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/additional_dataGetAdditionalDataResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/domains/additional-data/customers": { "get": { "tags": [ "CustomerAdditionalData" ], "summary": "Get data", "operationId": "GetData", "parameters": [ { "type": "string", "description": "Domain name without extension.", "name": "domain.name", "in": "query" }, { "type": "string", "description": "Domain extension.", "name": "domain.extension", "in": "query" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/customerGetDataResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/domains/check": { "post": { "tags": [ "DomainService" ], "summary": "Check domain", "operationId": "CheckDomain", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/domainCheckDomainRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/domainCheckDomainResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/domains/prices": { "get": { "tags": [ "DomainPriceService" ], "summary": "Get price", "externalDocs": { "description": "For more detailed information on this method check our guide", "url": "https://support.openprovider.eu/hc/en-us/articles/360023776313" }, "operationId": "GetPrice", "parameters": [ { "type": "string", "description": "Domain name without extension.", "name": "domain.name", "in": "query" }, { "type": "string", "description": "Domain extension.", "name": "domain.extension", "in": "query" }, { "type": "string", "description": "Domain operation.", "name": "operation", "in": "query" }, { "type": "string", "description": "The idn script states what language or character set the domain name is in\nApplicable to: .actor, .ae.org, .airforce, .army, .art, .attorney, .auction, .band, .bar, .best, .br.com, .ceo, .cn.com, .college, .com, .com.de, .com.se, .consulting, .dance, .de.com, .degree, .democrat, .dentist, .design, .engineer, .eu.com, .eus, .feedback, .fm, .forsale, .frl, .fun, .futbol, .gal, .gb.net, .gives, .gr.com, .haus, .hiv, .host, .immobilien, .in.net, .info, .ink, .jp.net, .jpn.com, .kaufen, .kyoto, .lawyer, .love, .market, .me, .mex.com, .moda, .mortgage, .navy, .net, .ninja, .nrw, .online, .ooo, .org, .press, .protection, .pub, .pw, .quebec, .radio.am, .radio.fm, .realty, .rehab, .rent, .republican, .rest, .reviews, .rip, .rocks, .ru.com, .sa.com, .scot, .se.net, .security, .site, .social, .software, .space, .store, .tech, .theatre, .tickets, .top, .uk.com, .uk.net, .us.com, .us.org, .vet, .website, .wiki, .xn--4gbrim, .xn--55qx5d, .xn--5tzm5g, .xn--80asehdb, .xn--80aswg, .xn--c1avg, .xn--czru2d, .xn--i1b6b1a6a2e, .xn--io0a7i, .xn--mk1bu44c, .xn--ngbc5azd, .xn--nqv7f, .xn--t60b56a, .xn--tckwe, .xyz, .za.com.", "name": "additional_data.idn_script", "in": "query" }, { "type": "integer", "format": "int32", "description": "Operation period.", "name": "period", "in": "query" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/priceGetPriceResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/domains/suggest-name": { "post": { "tags": [ "DomainService" ], "summary": "Suggest name domain", "operationId": "SuggestNameDomain", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/domainSuggestNameDomainRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/domainSuggestNameDomainResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/domains/trade": { "post": { "tags": [ "DomainService" ], "summary": "Trade domain", "operationId": "TradeDomain", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/domainTradeDomainRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/domainTradeDomainResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/domains/transfer": { "post": { "tags": [ "DomainService" ], "summary": "Transfer domain", "operationId": "TransferDomain", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/domainTransferDomainRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/domainTransferDomainResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/domains/{id}": { "get": { "tags": [ "DomainService" ], "summary": "Get domain", "operationId": "GetDomain", "parameters": [ { "type": "integer", "format": "int32", "description": "Domain id number", "name": "id", "in": "path", "required": true }, { "type": "string", "description": "Domain name without extension.", "name": "domain.name", "in": "query" }, { "type": "string", "description": "Domain extension.", "name": "domain.extension", "in": "query" }, { "type": "boolean", "format": "boolean", "description": "Returns domain mutations history.", "name": "with_history", "in": "query" }, { "type": "boolean", "format": "boolean", "description": "Returns domain API calls history.", "name": "with_api_history", "in": "query" }, { "type": "boolean", "format": "boolean", "description": "Returns domain additional data.", "name": "with_additional_data", "in": "query" }, { "type": "boolean", "format": "boolean", "description": "Returns information about domain owner email verification status.", "name": "with_verification_email", "in": "query" }, { "type": "boolean", "format": "boolean", "description": "Returns domain abuse details.", "name": "with_abuse_details", "in": "query" }, { "type": "boolean", "format": "boolean", "description": "Returns WPP data.", "name": "with_whois_privacy_data", "in": "query" }, { "type": "boolean", "format": "boolean", "description": "Indicates, if registry EPP statuses should be retrieved.", "name": "with_registry_statuses", "in": "query" }, { "type": "boolean", "format": "boolean", "description": "Indicates whether object is deleted.", "name": "is_deleted", "in": "query" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/domainGetDomainResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } }, "put": { "tags": [ "DomainService" ], "summary": "Update domain", "operationId": "UpdateDomain", "parameters": [ { "type": "integer", "format": "int32", "description": "Domain id number", "name": "id", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/domainUpdateDomainRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/domainUpdateDomainResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } }, "delete": { "tags": [ "DomainService" ], "summary": "Delete domain", "operationId": "DeleteDomain", "parameters": [ { "type": "integer", "format": "int32", "description": "Domain id number", "name": "id", "in": "path", "required": true }, { "type": "string", "description": "Domain name without extension.", "name": "domain.name", "in": "query" }, { "type": "string", "description": "Domain extension.", "name": "domain.extension", "in": "query" }, { "type": "string", "description": "Type of deletion request.", "name": "type", "in": "query" }, { "type": "boolean", "format": "boolean", "description": "Deletes domain, skipping the soft quarantine.", "name": "skip_soft_quarantine", "in": "query" }, { "type": "boolean", "format": "boolean", "description": "Force delete domain even if it has glue records.", "name": "force_delete", "in": "query" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/domainDeleteDomainResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/domains/{id}/authcode": { "get": { "tags": [ "AuthCode" ], "summary": "Get auth code", "operationId": "GetAuthCode", "parameters": [ { "type": "integer", "format": "int32", "description": "Domain id number", "name": "id", "in": "path", "required": true }, { "type": "string", "description": "Domain name without extension.", "name": "domain.name", "in": "query" }, { "type": "string", "description": "Domain extension.", "name": "domain.extension", "in": "query" }, { "type": "string", "description": "Type of transfer authorization code. external (default) or internal (for internal transfers between reseller accounts in Openprovider only).", "name": "auth_code_type", "in": "query" }, { "type": "string", "description": "Indicates how authcode should be provisioned to domain owner. For ru / xn--p1ai domains only. Possible values: sms, email letter.", "name": "sending_type", "in": "query" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/authcodeGetAuthCodeResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/domains/{id}/authcode/reset": { "post": { "tags": [ "AuthCode" ], "summary": "Reset auth code", "operationId": "ResetAuthCode", "parameters": [ { "type": "integer", "format": "int32", "description": "Domain id number", "name": "id", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/authcodeResetAuthCodeRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/authcodeResetAuthCodeResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/domains/{id}/last-operation/restart": { "post": { "tags": [ "DomainService" ], "summary": "Try again last operation", "operationId": "TryAgainLastOperation", "parameters": [ { "type": "integer", "format": "int32", "description": "Domain id number", "name": "id", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/domainTryAgainLastOperationRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/responseBoolResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/domains/{id}/renew": { "post": { "tags": [ "DomainService" ], "summary": "Renew domain", "operationId": "RenewDomain", "parameters": [ { "type": "integer", "format": "int32", "description": "Domain id number", "name": "id", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/domainRenewDomainRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/domainRenewDomainResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/domains/{id}/restore": { "post": { "tags": [ "DomainService" ], "summary": "Restore domain", "operationId": "RestoreDomain", "parameters": [ { "type": "integer", "format": "int32", "description": "Domain id number", "name": "id", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/domainRestoreDomainRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/domainRestoreDomainResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/domains/{id}/transfer/approve": { "post": { "tags": [ "DomainService" ], "summary": "Approve transfer", "operationId": "ApproveTransfer", "parameters": [ { "type": "integer", "format": "int32", "description": "Domain id number", "name": "id", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/domainApproveTransferRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/responseBoolResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/domains/{id}/transfer/send-foa1": { "post": { "tags": [ "DomainService" ], "summary": "Send foa1", "operationId": "SendFoa1", "parameters": [ { "type": "integer", "format": "int32", "description": "Domain id number", "name": "id", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/domainSendFoa1Request" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/responseBoolResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/easydmarcs": { "get": { "tags": [ "EasydmarcOrder" ], "summary": "Get easy dmarc", "operationId": "GetEasyDmarc", "parameters": [ { "type": "string", "description": "Domain name without extension.", "name": "domain.name", "in": "query" }, { "type": "string", "description": "Domain extension.", "name": "domain.extension", "in": "query" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/orderGetEasyDmarcResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } }, "post": { "tags": [ "EasydmarcOrder" ], "summary": "Create easy dmarc", "operationId": "CreateEasyDmarc", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/orderCreateEasyDmarcRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/orderCreateEasyDmarcResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/easydmarcs/list": { "get": { "tags": [ "EasydmarcOrder" ], "summary": "List easy dmarc", "operationId": "ListEasyDmarc", "parameters": [ { "type": "integer", "format": "int32", "default": 100, "description": "Search query limit.", "name": "limit", "in": "query" }, { "type": "integer", "format": "int32", "default": 0, "description": "Search query offset.", "name": "offset", "in": "query" }, { "type": "string", "description": "desc/asc.", "name": "order_by.id", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Array of order statuses.", "name": "status", "in": "query" }, { "type": "string", "description": "Domain name without extension.", "name": "domain.name", "in": "query" }, { "type": "string", "description": "Domain extension.", "name": "domain.extension", "in": "query" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/orderListEasyDmarcResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/easydmarcs/{id}": { "delete": { "tags": [ "EasydmarcOrder" ], "summary": "Delete easy dmarc", "operationId": "DeleteEasyDmarc", "parameters": [ { "type": "integer", "format": "int32", "description": "Easydmarc id (order number)", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/orderDeleteEasyDmarcResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/easydmarcs/{id}/retry": { "post": { "tags": [ "EasydmarcOrder" ], "summary": "Retry easy dmarc", "operationId": "RetryEasyDmarc", "parameters": [ { "type": "integer", "format": "int32", "description": "Easydmarc id (order number)", "name": "id", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/orderRetryEasyDmarcRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/orderRetryEasyDmarcResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/easydmarcs/{id}/sso": { "get": { "tags": [ "EasydmarcOrder" ], "summary": "Get easy dmarc sso", "operationId": "GetEasyDmarcSso", "parameters": [ { "type": "integer", "format": "int32", "description": "Easy Dmarc id (order id)", "name": "id", "in": "path", "required": true }, { "type": "string", "description": "SSO url on behalf of the customer or reseller.", "name": "type", "in": "query" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/orderGetEasyDmarcSsoResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/emails": { "get": { "tags": [ "Email" ], "summary": "List emails", "operationId": "ListEmails", "parameters": [ { "type": "integer", "format": "int32", "description": "Object ID.", "name": "id", "in": "query" }, { "type": "string", "description": "Template name.", "name": "name", "in": "query" }, { "type": "string", "description": "Email template type. There are several types of ICANN emails that can be customized in Openprovider: -errp (Expired Registration Recovery policy emails) -foa (Form of Authorization emails for domain transfers approval rejection) -ive (Information verification emails, such emails used to verify email address of the customer) -tcn (Trademark Claims Notification emails) -wdrp (Whois Data Reminder Policy emails).", "name": "group", "in": "query" }, { "type": "integer", "format": "int32", "description": "Output limit.", "name": "limit", "in": "query" }, { "type": "integer", "format": "int32", "description": "Output offset.", "name": "offset", "in": "query" }, { "type": "boolean", "format": "boolean", "description": "Is system.", "name": "is_system", "in": "query" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/emailListEmailsResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } }, "post": { "tags": [ "Email" ], "summary": "Create email", "operationId": "CreateEmail", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/emailCreateEmailRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/emailCreateEmailResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/emails/{id}": { "put": { "tags": [ "Email" ], "summary": "Update email", "operationId": "UpdateEmail", "parameters": [ { "type": "integer", "format": "int32", "description": "Object ID", "name": "id", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/emailUpdateEmailRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/emailUpdateEmailResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } }, "delete": { "tags": [ "Email" ], "summary": "Delete email", "operationId": "DeleteEmail", "parameters": [ { "type": "integer", "format": "int32", "description": "Object ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/emailDeleteEmailResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/invoices": { "get": { "tags": [ "InvoiceService" ], "summary": "List invoices", "operationId": "ListInvoices", "parameters": [ { "type": "integer", "format": "int32", "description": "The limit.", "name": "limit", "in": "query" }, { "type": "integer", "format": "int32", "description": "The offset.", "name": "offset", "in": "query" }, { "type": "string", "description": "The order.", "name": "order", "in": "query" }, { "type": "string", "description": "The order by.", "name": "order_by", "in": "query" }, { "type": "string", "description": "The start creation date.", "name": "start_creation_date", "in": "query" }, { "type": "string", "description": "The end creation date.", "name": "end_creation_date", "in": "query" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/invoiceListInvoicesResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/licenses": { "get": { "tags": [ "LicenseService" ], "summary": "List licenses with price version", "operationId": "ListLicensesWithPriceVersion", "parameters": [ { "type": "integer", "format": "int32", "description": "Output limit.", "name": "limit", "in": "query" }, { "type": "integer", "format": "int32", "description": "Output offset.", "name": "offset", "in": "query" }, { "type": "string", "description": "Object ID.", "name": "order_by.id", "in": "query" }, { "type": "string", "description": "License key ID.", "name": "order_by.key_id", "in": "query" }, { "type": "string", "description": "Custom license title.", "name": "order_by.title", "in": "query" }, { "type": "string", "description": "Product type (only Plesk is available).", "name": "order_by.product", "in": "query" }, { "type": "string", "description": "License status.", "name": "order_by.status", "in": "query" }, { "type": "string", "description": "License key number.", "name": "order_by.key_number", "in": "query" }, { "type": "string", "description": "License expiration date.", "name": "order_by.expiration_date", "in": "query" }, { "type": "string", "description": "Product type (only Plesk is available).", "name": "product", "in": "query" }, { "type": "string", "description": "License key number.", "name": "key_number", "in": "query" }, { "type": "string", "description": "Custom title pattern. Wildcard (*) can be sued.", "name": "title_pattern", "in": "query" }, { "type": "string", "description": "License key number pattern. Wildcard (*) can be used.", "name": "key_number_pattern", "in": "query" }, { "type": "integer", "format": "int32", "description": "Key ID of the partent license.", "name": "parent_key_id", "in": "query" }, { "type": "string", "description": "License status.", "name": "status", "in": "query" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/licenseListLicensesWithPriceVersionResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/licenses/hwids/reset/{product}/{key_id}": { "post": { "tags": [ "LicenseService" ], "summary": "Reset hwid", "operationId": "ResetHwid", "parameters": [ { "type": "string", "description": "Product type (only Plesk is available)", "name": "product", "in": "path", "required": true }, { "type": "integer", "format": "int32", "description": "License key ID", "name": "key_id", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/licenseResetHwidRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/licenseResetHwidResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/licenses/items": { "get": { "tags": [ "LicenseService" ], "summary": "List items", "operationId": "ListItems", "parameters": [ { "type": "integer", "format": "int32", "description": "Output limit.", "name": "limit", "in": "query" }, { "type": "integer", "format": "int32", "description": "Output offset.", "name": "offset", "in": "query" }, { "type": "string", "description": "Object ID.", "name": "order_by.id", "in": "query" }, { "type": "string", "description": "License key ID.", "name": "order_by.key_id", "in": "query" }, { "type": "string", "description": "Custom license title.", "name": "order_by.title", "in": "query" }, { "type": "string", "description": "Product type (only Plesk is available).", "name": "order_by.product", "in": "query" }, { "type": "string", "description": "License status.", "name": "order_by.status", "in": "query" }, { "type": "string", "description": "License key number.", "name": "order_by.key_number", "in": "query" }, { "type": "string", "description": "License expiration date.", "name": "order_by.expiration_date", "in": "query" }, { "type": "string", "description": "Product type (only Plesk is available).", "name": "product", "in": "query" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/licenseListItemsResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/licenses/plesk": { "get": { "tags": [ "LicenseService" ], "summary": "List plesk licenses", "operationId": "ListPleskLicenses", "parameters": [ { "type": "integer", "format": "int32", "description": "Output limit.", "name": "limit", "in": "query" }, { "type": "integer", "format": "int32", "description": "Output offset.", "name": "offset", "in": "query" }, { "type": "integer", "format": "int32", "description": "License key ID.", "name": "key_id", "in": "query" }, { "type": "string", "description": "License key number.", "name": "key_number", "in": "query" }, { "type": "string", "description": "Custom title pattern. Wildcard (*) can be used.", "name": "title_pattern", "in": "query" }, { "type": "string", "description": "License key number pattern. Wildcard (*) can be used.", "name": "key_number_pattern", "in": "query" }, { "type": "integer", "format": "int32", "description": "Key ID of the partent license.", "name": "parent_key_id", "in": "query" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/licenseListLicensesResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } }, "post": { "tags": [ "LicenseService" ], "summary": "Create plesk license", "operationId": "CreatePleskLicense", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/licenseCreatePleskLicenseRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/licenseCreatePleskLicenseResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/licenses/plesk/key/{key_id}": { "get": { "tags": [ "LicenseService" ], "summary": "Get plesk key", "operationId": "GetPleskKey", "parameters": [ { "type": "integer", "format": "int32", "description": "License key ID", "name": "key_id", "in": "path", "required": true } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/licenseGetLicenseKeyResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/licenses/plesk/{key_id}": { "get": { "tags": [ "LicenseService" ], "summary": "Get plesk license", "operationId": "GetPleskLicense", "parameters": [ { "type": "integer", "format": "int32", "description": "License key ID", "name": "key_id", "in": "path", "required": true } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/licenseGetLicenseResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } }, "put": { "tags": [ "LicenseService" ], "summary": "Update plesk license", "operationId": "UpdatePleskLicense", "parameters": [ { "type": "integer", "format": "int32", "description": "License key ID", "name": "key_id", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/licenseUpdatePleskLicenseRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/licenseUpdateLicenseResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } }, "delete": { "tags": [ "LicenseService" ], "summary": "Delete plesk license", "operationId": "DeletePleskLicense", "parameters": [ { "type": "integer", "format": "int32", "description": "License key ID", "name": "key_id", "in": "path", "required": true } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/licenseDeleteLicenseResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/licenses/virtuozzo": { "get": { "tags": [ "LicenseService" ], "summary": "List virtuozzo licenses", "operationId": "ListVirtuozzoLicenses", "deprecated": true, "parameters": [ { "type": "integer", "format": "int32", "description": "Output limit.", "name": "limit", "in": "query" }, { "type": "integer", "format": "int32", "description": "Output offset.", "name": "offset", "in": "query" }, { "type": "integer", "format": "int32", "description": "License key ID.", "name": "key_id", "in": "query" }, { "type": "string", "description": "License key number.", "name": "key_number", "in": "query" }, { "type": "string", "description": "Custom title pattern. Wildcard (*) can be used.", "name": "title_pattern", "in": "query" }, { "type": "string", "description": "License key number pattern. Wildcard (*) can be used.", "name": "key_number_pattern", "in": "query" }, { "type": "integer", "format": "int32", "description": "Key ID of the partent license.", "name": "parent_key_id", "in": "query" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/licenseListLicensesResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } }, "post": { "tags": [ "LicenseService" ], "summary": "Create virtuozzo license", "operationId": "CreateVirtuozzoLicense", "deprecated": true, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/licenseCreateVirtuozzoLicenseRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/licenseCreateVirtuozzoLicenseResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/licenses/virtuozzo/{key_id}": { "get": { "tags": [ "LicenseService" ], "summary": "Get virtuozzo license", "operationId": "GetVirtuozzoLicense", "deprecated": true, "parameters": [ { "type": "integer", "format": "int32", "description": "License key ID", "name": "key_id", "in": "path", "required": true } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/licenseGetLicenseResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } }, "put": { "tags": [ "LicenseService" ], "summary": "Update virtuozzo license", "operationId": "UpdateVirtuozzoLicense", "deprecated": true, "parameters": [ { "type": "integer", "format": "int32", "description": "License key ID", "name": "key_id", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/licenseUpdateVirtuozzoLicenseRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/licenseUpdateLicenseResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } }, "delete": { "tags": [ "LicenseService" ], "summary": "Delete virtuozzo license", "operationId": "DeleteVirtuozzoLicense", "deprecated": true, "parameters": [ { "type": "integer", "format": "int32", "description": "License key ID", "name": "key_id", "in": "path", "required": true } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/licenseDeleteLicenseResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/licenses/virtuozzo/{key_id}/key": { "get": { "tags": [ "LicenseService" ], "summary": "Get virtuozzo key", "operationId": "GetVirtuozzoKey", "deprecated": true, "parameters": [ { "type": "integer", "format": "int32", "description": "License key ID", "name": "key_id", "in": "path", "required": true } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/licenseGetLicenseKeyResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/payments": { "get": { "tags": [ "Payment" ], "summary": "List payments", "operationId": "ListPayments", "parameters": [ { "type": "integer", "format": "int32", "description": "The limit.", "name": "limit", "in": "query" }, { "type": "integer", "format": "int32", "description": "The offset.", "name": "offset", "in": "query" }, { "type": "string", "description": "The order.", "name": "order", "in": "query" }, { "type": "string", "description": "The order by.", "name": "order_by", "in": "query" }, { "type": "string", "description": "The type.", "name": "type", "in": "query" }, { "type": "string", "description": "The status.", "name": "status", "in": "query" }, { "type": "string", "description": "The start creation date.", "name": "start_creation_date", "in": "query" }, { "type": "string", "description": "The end creation date.", "name": "end_creation_date", "in": "query" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/paymentListPaymentsResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/resellers": { "get": { "tags": [ "ResellerService" ], "summary": "Get reseller", "externalDocs": { "description": "For more detailed information on this method check our guide", "url": "https://doc.openprovider.eu/API_Module_Reseller_retrieveResellerRequest" }, "operationId": "GetReseller", "parameters": [ { "type": "boolean", "format": "boolean", "description": "Retrieves objects with (1) or without (0) additional data.", "name": "with_additional_data", "in": "query" }, { "type": "boolean", "format": "boolean", "description": "Indicates if reseller statistics should be retrieved.", "name": "with_statistics", "in": "query" }, { "type": "boolean", "format": "boolean", "description": "Indicates if reseller settings should be retrieved.", "name": "with_settings", "in": "query" }, { "type": "boolean", "format": "boolean", "description": "Indicates if reseller contacts should be retrieved.", "name": "with_contacts", "in": "query" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/resellerGetResellerResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/resellers/settings": { "get": { "tags": [ "Settings" ], "summary": "Get settings", "operationId": "GetSettings", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/settingsGetSettingsResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/resellers/statistics": { "get": { "tags": [ "Statistics" ], "summary": "Get statistics", "operationId": "GetStatistics", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/statisticsGetStatisticsResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/resellers/{id}": { "put": { "tags": [ "ResellerService" ], "summary": "Update reseller", "operationId": "UpdateReseller", "parameters": [ { "type": "integer", "format": "int32", "description": "Object ID", "name": "id", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/resellerUpdateResellerRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/resellerUpdateResellerResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/spam-expert/domains": { "post": { "tags": [ "SEDomain" ], "summary": "Create domain", "operationId": "CreateDomainMixin8", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/se_domainCreateDomainRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/responseBoolResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/spam-expert/domains/{domain_name}": { "get": { "tags": [ "SEDomain" ], "summary": "Get domain", "operationId": "GetDomainMixin8", "parameters": [ { "type": "string", "description": "Domain full name", "name": "domain_name", "in": "path", "required": true }, { "type": "boolean", "format": "boolean", "default": false, "description": "Indicates, whether records should be displayed in output.", "name": "with_records", "in": "query" }, { "type": "boolean", "format": "boolean", "description": "Indicates if old subscriptions backward compatibility is used.", "name": "bundle", "in": "query" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/se_domainGetDomainResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } }, "put": { "tags": [ "SEDomain" ], "summary": "Update domain", "operationId": "UpdateDomainMixin8", "parameters": [ { "type": "string", "description": "Domain full name", "name": "domain_name", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/se_domainUpdateDomainRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/responseBoolResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } }, "delete": { "tags": [ "SEDomain" ], "summary": "Delete domain", "operationId": "DeleteDomainMixin8", "parameters": [ { "type": "string", "description": "Domain full name", "name": "domain_name", "in": "path", "required": true }, { "type": "boolean", "format": "boolean", "description": "Indicates if old subscriptions backward compatibility is used.", "name": "bundle", "in": "query" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/responseBoolResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/spam-expert/generate-login-url": { "post": { "tags": [ "SpamExpert" ], "summary": "Generate login url", "operationId": "GenerateLoginURL", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/spam_expertGenerateLoginURLRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/spam_expertGenerateLoginURLResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/ssl/approver-emails": { "get": { "tags": [ "ApproverEmail" ], "summary": "List approver emails", "operationId": "ListApproverEmails", "parameters": [ { "type": "integer", "format": "int32", "description": "ID of product order will be created for.", "name": "product_id", "in": "query" }, { "type": "string", "description": "Domain name.", "name": "domain", "in": "query" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/approveremailListApproverEmailsResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/ssl/csr": { "post": { "tags": [ "Csr" ], "summary": "Create csr", "externalDocs": { "description": "For more detailed information on this method check our guide", "url": "https://support.openprovider.eu/hc/en-us/articles/360024155173" }, "operationId": "CreateCsr", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/csrCreateCsrRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/csrCreateCsrResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/ssl/csr/decode": { "post": { "tags": [ "Csr" ], "summary": "Decode csr", "externalDocs": { "description": "For more detailed information on this method check our guide", "url": "https://support.openprovider.eu/hc/en-us/articles/360024176673" }, "operationId": "DecodeCsr", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/csrDecodeCsrRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/csrDecodeCsrResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/ssl/orders": { "get": { "tags": [ "Order" ], "summary": "List orders", "externalDocs": { "description": "For more detailed information on this method check our guide", "url": "https://support.openprovider.eu/hc/en-us/articles/360024399333" }, "operationId": "ListOrders", "parameters": [ { "type": "integer", "format": "int32", "default": 100, "description": "Search query limit.", "name": "limit", "in": "query" }, { "type": "integer", "format": "int32", "description": "Search query offset.", "name": "offset", "in": "query" }, { "type": "string", "description": "desc/asc.", "name": "order_by.common_name", "in": "query" }, { "type": "string", "default": "desc", "description": "desc/asc.", "name": "order_by.order_date", "in": "query" }, { "type": "string", "description": "desc/asc.", "name": "order_by.active_date", "in": "query" }, { "type": "string", "description": "desc/asc.", "name": "order_by.expiration_date", "in": "query" }, { "type": "string", "description": "desc/asc.", "name": "order_by.status", "in": "query" }, { "type": "string", "description": "desc/asc.", "name": "order_by.product_name", "in": "query" }, { "type": "string", "description": "Certificate common name pattern. Wildcard (*) can be used.", "name": "common_name_pattern", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Array of order statuses.", "name": "status", "in": "query" }, { "type": "string", "description": "Contact handle.", "name": "contact_handle", "in": "query" }, { "type": "boolean", "format": "boolean", "description": "Indicates, whether to return only certificates that are expiring within 30 days.", "name": "show_expiring", "in": "query" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/orderListOrdersResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } }, "post": { "tags": [ "Order" ], "summary": "Create order", "externalDocs": { "description": "For more detailed information on this method check our guide", "url": "https://support.openprovider.eu/hc/en-us/articles/360024389393" }, "operationId": "CreateOrder", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/orderCreateOrderRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/orderCreateOrderResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/ssl/orders/{id}": { "get": { "tags": [ "Order" ], "summary": "Get order", "externalDocs": { "description": "For more detailed information on this method check our guide", "url": "https://support.openprovider.eu/hc/en-us/articles/360024389393" }, "operationId": "GetOrder", "parameters": [ { "type": "integer", "format": "int32", "description": "Object id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/orderGetOrderResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } }, "put": { "tags": [ "Order" ], "summary": "Update order", "externalDocs": { "description": "For more detailed information on this method check our guide", "url": "https://support.openprovider.eu/hc/en-us/articles/360024299194" }, "operationId": "UpdateOrder", "parameters": [ { "type": "integer", "format": "int32", "description": "Object id", "name": "id", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/orderUpdateOrderRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/orderUpdateOrderResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/ssl/orders/{id}/approver-email": { "put": { "tags": [ "OrderApproverEmail" ], "summary": "Update approver email address", "operationId": "UpdateApproverEmailAddress", "parameters": [ { "type": "integer", "format": "int32", "description": "Object id", "name": "id", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/approveremailUpdateApproverEmailAddressRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/approveremailUpdateApproverEmailAddressResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/ssl/orders/{id}/approver-email/resend": { "post": { "tags": [ "OrderApproverEmail" ], "summary": "Resend approver email", "operationId": "ResendApproverEmail", "parameters": [ { "type": "integer", "format": "int32", "description": "Object id", "name": "id", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/approveremailResendApproverEmailRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/approveremailResendApproverEmailResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/ssl/orders/{id}/cancel": { "post": { "tags": [ "Order" ], "summary": "Cancel order", "externalDocs": { "description": "For more detailed information on this method check our guide", "url": "https://support.openprovider.eu/hc/en-us/articles/360024469053" }, "operationId": "CancelOrder", "parameters": [ { "type": "integer", "format": "int32", "description": "Object id", "name": "id", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/orderCancelOrderRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/orderCancelOrderResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/ssl/orders/{id}/otp-tokens": { "post": { "tags": [ "OtpToken" ], "summary": "Create otp token", "operationId": "CreateOtpToken", "parameters": [ { "type": "integer", "format": "int32", "description": "Object id", "name": "id", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/otptokenCreateOtpTokenRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/otptokenCreateOtpTokenResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/ssl/orders/{id}/reissue": { "post": { "tags": [ "Order" ], "summary": "Reissue order", "externalDocs": { "description": "For more detailed information on this method check our guide", "url": "https://support.openprovider.eu/hc/en-us/articles/360024304394" }, "operationId": "ReissueOrder", "parameters": [ { "type": "integer", "format": "int32", "description": "Object id", "name": "id", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/orderReissueOrderRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/orderReissueOrderResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/ssl/orders/{id}/renew": { "post": { "tags": [ "Order" ], "summary": "Renew order", "externalDocs": { "description": "For more detailed information on this method check our guide", "url": "https://support.openprovider.eu/hc/en-us/articles/360024468093" }, "operationId": "RenewOrder", "parameters": [ { "type": "integer", "format": "int32", "description": "Object id", "name": "id", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/orderRenewOrderRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/orderRenewOrderResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/ssl/products": { "get": { "tags": [ "Product" ], "summary": "List products", "operationId": "ListProducts", "parameters": [ { "type": "integer", "format": "int32", "description": "Search query limit.", "name": "limit", "in": "query" }, { "type": "integer", "format": "int32", "description": "Search query offset.", "name": "offset", "in": "query" }, { "type": "boolean", "format": "boolean", "description": "Returns product price in the response.", "name": "with_price", "in": "query" }, { "type": "boolean", "format": "boolean", "default": false, "description": "Returns a list of supported software patforms.", "name": "with_supported_software", "in": "query" }, { "type": "boolean", "format": "boolean", "description": "Returns a description for each product, if exists.", "name": "with_description", "in": "query" }, { "type": "string", "description": "Sorting type (asc/desc).", "name": "order_by.name", "in": "query" }, { "type": "string", "description": "Sorting type (asc/desc).", "name": "order_by.brand_name", "in": "query" }, { "type": "string", "description": "Sorting type (asc/desc).", "name": "order_by.category", "in": "query" }, { "type": "string", "description": "Sorting type (asc/desc).", "name": "order_by.sub_category", "in": "query" }, { "type": "string", "description": "Sorting type (asc/desc).", "name": "order_by.brand_seqno", "in": "query" }, { "type": "string", "description": "Sorting type (asc/desc).", "name": "order_by.product_seqno", "in": "query" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/productListProductsResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/ssl/products/{id}": { "get": { "tags": [ "Product" ], "summary": "Get product", "operationId": "GetProduct", "parameters": [ { "type": "integer", "format": "int32", "description": "Object id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/productGetProductResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/tags": { "get": { "tags": [ "TagService" ], "summary": "List tags", "operationId": "ListTags", "parameters": [ { "type": "string", "description": "The key of the tag. Allowed values: 'customer'.", "name": "key", "in": "query" }, { "type": "string", "description": "The value of the tag. I.e.: VIP customer.", "name": "value", "in": "query" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/tagListTagsResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } }, "post": { "tags": [ "TagService" ], "summary": "Create tag", "operationId": "CreateTag", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/helperstagTag" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/tagCreateTagResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } }, "delete": { "tags": [ "TagService" ], "summary": "Delete tag", "operationId": "DeleteTag", "parameters": [ { "type": "string", "description": "The key of the tag. Allowed values: 'customer'.", "name": "key", "in": "query" }, { "type": "string", "description": "The value of the tag. I.e.: VIP customer.", "name": "value", "in": "query" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/tagDeleteTagResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/tlds": { "get": { "tags": [ "TldService" ], "summary": "List tlds", "operationId": "ListTlds", "parameters": [ { "type": "integer", "format": "int32", "description": "Search query limit.", "name": "limit", "in": "query" }, { "type": "integer", "format": "int32", "description": "Search query offset.", "name": "offset", "in": "query" }, { "type": "string", "description": "Sorts output ASC or DESC.", "name": "order", "in": "query" }, { "type": "string", "description": "Sorts output by a field.", "name": "order_by", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Array of extensions.", "name": "extensions", "in": "query" }, { "type": "string", "description": "Extension name pattern. Wildcard (*) can be used.", "name": "name_pattern", "in": "query" }, { "type": "boolean", "format": "boolean", "description": "Returns only extension names in the output.", "name": "only_names", "in": "query" }, { "type": "boolean", "format": "boolean", "description": "Returns additional extension description.", "name": "with_description", "in": "query" }, { "type": "boolean", "format": "boolean", "description": "Returns list of extension restrictions.", "name": "with_restrictions", "in": "query" }, { "type": "boolean", "format": "boolean", "description": "Returns number of domains using specified extension in this account.", "name": "with_usage_count", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Array of extension application modes.", "name": "with_application_mode", "in": "query" }, { "type": "boolean", "format": "boolean", "description": "Returns extension prices.", "name": "with_price", "in": "query" }, { "type": "boolean", "format": "boolean", "description": "Returns extension prices for each Openprovider discount tier.", "name": "with_level_prices", "in": "query" }, { "type": "boolean", "format": "boolean", "description": "Indicates, if extension is active.", "name": "is_active", "in": "query" }, { "type": "boolean", "format": "boolean", "description": "Indicates, if extension is a newGTLD.", "name": "is_new_gtld", "in": "query" }, { "type": "string", "description": "Extension status.", "name": "status", "in": "query" }, { "type": "string", "description": "Pre-registration mode.", "name": "application_mode", "in": "query" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/tldListTldsResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/tlds/{name}": { "get": { "tags": [ "TldService" ], "summary": "Get tld", "operationId": "GetTld", "parameters": [ { "type": "string", "description": "Extension name", "name": "name", "in": "path", "required": true }, { "type": "integer", "format": "int32", "description": "Search query limit.", "name": "limit", "in": "query" }, { "type": "integer", "format": "int32", "description": "Search query offset.", "name": "offset", "in": "query" }, { "type": "boolean", "format": "boolean", "description": "Returns additional extension description.", "name": "with_description", "in": "query" }, { "type": "boolean", "format": "boolean", "description": "Returns list of extension restrictions.", "name": "with_restrictions", "in": "query" }, { "type": "boolean", "format": "boolean", "description": "Returns extension prices.", "name": "with_price", "in": "query" }, { "type": "boolean", "format": "boolean", "description": "Returns extension prices for each Openprovider discount tier.", "name": "with_level_prices", "in": "query" }, { "type": "boolean", "format": "boolean", "description": "Returns number of domains using specified extension in this account.", "name": "with_usage_count", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Extension status.", "name": "status", "in": "query" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/tldGetTldResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } }, "/v1beta/transactions": { "get": { "tags": [ "Transaction" ], "summary": "List transactions", "operationId": "ListTransactions", "parameters": [ { "type": "integer", "format": "int32", "description": "The limit.", "name": "limit", "in": "query" }, { "type": "integer", "format": "int32", "description": "The offset.", "name": "offset", "in": "query" }, { "type": "string", "description": "The order.", "name": "order", "in": "query" }, { "type": "string", "description": "The order by.", "name": "order_by", "in": "query" }, { "type": "string", "description": "The start creation date.", "name": "start_creation_date", "in": "query" }, { "type": "string", "description": "The end creation date.", "name": "end_creation_date", "in": "query" }, { "type": "string", "description": "The filter for subject.", "name": "filter_for_subject", "in": "query" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/transactionListTransactionsResponse" } }, "default": { "description": "(empty)", "schema": { "$ref": "#/definitions/errorError" } } } } } }, "definitions": { "additional_dataGetAdditionalDataResponse": { "type": "object", "title": "GetAdditionalDataResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "type": "array", "title": "Response data", "items": { "$ref": "#/definitions/additional_dataSpecification" } }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if the Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Contains warning responses if any", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": [ { "description": "IDN script states what language or character set the domain name is in", "name": "idnScript", "options": [ { "description": "Norwegian", "value": "no" } ], "required": false, "type": "select" } ], "desc": "" } }, "additional_dataSelectOption": { "type": "object", "title": "SelectOption", "properties": { "description": { "type": "string", "title": "Parameter description" }, "value": { "type": "string", "title": "Option value" } }, "example": { "description": "Norwegian", "value": "no" } }, "additional_dataSpecification": { "type": "object", "title": "Specification", "properties": { "description": { "type": "string", "title": "Parameter description" }, "name": { "type": "string", "title": "Parameter name" }, "options": { "type": "array", "title": "Array of options", "items": { "$ref": "#/definitions/additional_dataSelectOption" } }, "required": { "type": "boolean", "format": "boolean", "title": "Indicates, if specified additional data parameter is mandatory" }, "type": { "type": "string", "title": "Specification type" } }, "example": { "description": "IDN script states what language or character set the domain name is in", "name": "idnScript", "options": [ { "description": "Norwegian", "value": "no" } ], "required": false, "type": "select" } }, "approveremailListApproverEmailsResponse": { "type": "object", "title": "ListApproverEmailsResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/approveremailListApproverEmailsResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "results": [ "admin@example.com" ] }, "desc": "" } }, "approveremailListApproverEmailsResponseData": { "type": "object", "title": "ListApproverEmailsResponseData", "properties": { "results": { "type": "array", "title": "Array of results", "items": { "type": "string" } } }, "example": { "results": [ "admin@example.com" ] } }, "approveremailResendApproverEmailRequest": { "type": "object", "title": "ResendApproverEmailRequest", "properties": { "id": { "type": "integer", "format": "int32", "title": "Object id" } }, "example": { "id": 1 } }, "approveremailResendApproverEmailResponse": { "type": "object", "title": "ResendApproverEmailResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/approveremailResendApproverEmailResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "id": 1 }, "desc": "" } }, "approveremailResendApproverEmailResponseData": { "type": "object", "title": "ResendApproverEmailResponseData", "properties": { "id": { "type": "integer", "format": "int32", "title": "Object id" } }, "example": { "id": 1 } }, "approveremailUpdateApproverEmailAddressRequest": { "type": "object", "title": "UpdateApproverEmailAddressRequest", "properties": { "approver_email": { "description": "Email for domain ownership verification. Should start with well-known generic name like admin@, hostmater@, administrator@, etc.", "type": "string" }, "id": { "type": "integer", "format": "int32", "title": "Object id" } }, "example": { "approver_email": "admin@example.com", "id": 1 } }, "approveremailUpdateApproverEmailAddressResponse": { "type": "object", "title": "UpdateApproverEmailAddressResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/approveremailUpdateApproverEmailAddressResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "id": 1 }, "desc": "" } }, "approveremailUpdateApproverEmailAddressResponseData": { "type": "object", "title": "UpdateApproverEmailAddressResponseData", "properties": { "id": { "type": "integer", "format": "int32", "title": "Object id" } }, "example": { "id": 1 } }, "attributesCompanySize": { "description": "- UNKNOWN_COMPANY_SIZE: Unknown company size, e.g reseller just created account or didn't specified company size\n - BETWEEN_1_AND_10: Company has from 1 to 10 employees\n - BETWEEN_11_AND_50: Company has from 11 to 50 employees\n - BETWEEN_51_AND_200: Company has from 51 to 200 employees\n - BETWEEN_201_AND_500: Company has from 201 to 500 employees\n - BETWEEN_501_AND_1000: Company has from 501 to 1000 employees\n - MORE_THAN_1000: Company more than 1000 employees", "type": "string", "title": "The size of reseller's company", "default": "UNKNOWN_COMPANY_SIZE", "enum": [ "UNKNOWN_COMPANY_SIZE", "BETWEEN_1_AND_10", "BETWEEN_11_AND_50", "BETWEEN_51_AND_200", "BETWEEN_201_AND_500", "BETWEEN_501_AND_1000", "MORE_THAN_1000" ] }, "attributesDesignation": { "description": "- UNKNOWN_DESIGNATION: Designation is not specified\n - OWNER_FOUNDER_CEO: Owner/Founder/CEO\n - IT: IT\n - PRODUCT: Product\n - MARKETING: Marketing\n - PROCUREMENT: Procurement\n - SALES_BDR: Sales/BDR\n - OTHER_DESIGNATION: Other", "type": "string", "title": "The designation of reseller signing up", "default": "UNKNOWN_DESIGNATION", "enum": [ "UNKNOWN_DESIGNATION", "OWNER_FOUNDER_CEO", "IT", "PRODUCT", "MARKETING", "PROCUREMENT", "SALES_BDR", "OTHER_DESIGNATION" ] }, "attributesIndustry": { "description": "- UNKNOWN_INDUSTRY: Industry is not specified\n - DOMAIN_REGISTRAR: Reseller's industry is domain registar\n - CLOUD_SERVICES: Reseller's industry is cloud services\n - MARKETING_AGENCIES: Reseller's industry is marketing agencies\n - NETWORKING_SERVICES: Reseller's industry is networking services\n - WEB_HOSTING: Reseller's industry is web hosting\n - SOFTWARE_DEVELOPMENT: Reseller's industry is software development\n - WEBSITE_BUILDERS: Reseller's industry is website builders\n - SECURITY_SERVICES: Reseller's industry is security services\n - IT_SERVICES: Reseller's industry is IT services\n - FREELANCER: Reseller's industry is freelancing services", "type": "string", "title": "Reseller's industry", "default": "UNKNOWN_INDUSTRY", "enum": [ "UNKNOWN_INDUSTRY", "DOMAIN_REGISTRAR", "CLOUD_SERVICES", "MARKETING_AGENCIES", "NETWORKING_SERVICES", "WEB_HOSTING", "SOFTWARE_DEVELOPMENT", "WEBSITE_BUILDERS", "SECURITY_SERVICES", "IT_SERVICES", "FREELANCER" ] }, "attributesReferralSource": { "description": "- UNKNOWN_REFERRAL_SOURCE: Referral source is not specified\n - SEARCH_ENGINE_RECOMMENDATION: Search Engine Recommendation\n - SOCIAL_MEDIA: Social Media\n - INTERNET_ADS: Internet Ads\n - EMAIL: Email\n - EVENT: Event\n - CUSTOMER_REVIEW_SITES: Customer Review Sites\n - PLATFORM_COMPARISON_SITES: Platform Comparison Sites\n - OTHER_REFERRAL_SOURCE: Other", "type": "string", "title": "The size of reseller's company", "default": "UNKNOWN_REFERRAL_SOURCE", "enum": [ "UNKNOWN_REFERRAL_SOURCE", "SEARCH_ENGINE_RECOMMENDATION", "SOCIAL_MEDIA", "INTERNET_ADS", "EMAIL", "EVENT", "CUSTOMER_REVIEW_SITES", "PLATFORM_COMPARISON_SITES", "OTHER_REFERRAL_SOURCE" ] }, "authLoginRequest": { "type": "object", "title": "LoginRequest", "properties": { "ip": { "type": "string", "title": "The IP address (0.0.0.0 is any IP address)" }, "password": { "type": "string", "title": "The user's password" }, "username": { "type": "string", "title": "The user's name" } }, "example": { "ip": "123.123.123.123", "password": "eivr4ReKoz", "username": "openprovider" } }, "authLoginResponse": { "type": "object", "title": "LoginResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/authLoginResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "reseller_id": 123456, "token": "20d65561c9636d262e59aec8582c20c7" }, "desc": "" } }, "authLoginResponseData": { "type": "object", "title": "LoginResponseData", "properties": { "reseller_id": { "type": "integer", "format": "int32", "title": "The reseller id" }, "token": { "type": "string", "title": "The token" } }, "example": { "reseller_id": 123456, "token": "20d65561c9636d262e59aec8582c20c7" } }, "authcodeAuthInfo": { "type": "object", "title": "AuthInfo", "properties": { "pw": { "type": "string", "title": "The pw" } }, "example": { "pw": "cyF2A7jPp+T#?5j*-G82" } }, "authcodeGetAuthCodeResponse": { "type": "object", "title": "GetAuthCodeResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/authcodeGetAuthCodeResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates that the Openprovider system is temporarily unavailable because of maintenance" }, "warnings": { "type": "array", "title": "Contains warning responses if any", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "auth_code": "12345678", "success": false, "type": "external" }, "desc": "" } }, "authcodeGetAuthCodeResponseData": { "type": "object", "title": "GetAuthCodeResponseData", "properties": { "auth_code": { "type": "string", "title": "Authorization code" }, "success": { "type": "boolean", "format": "boolean", "title": "Indicates if operation is successful" }, "type": { "type": "string", "title": "Authorization code type" } }, "example": { "auth_code": "12345678", "success": false, "type": "external" } }, "authcodeResetAuthCodeRequest": { "type": "object", "title": "ResetAuthCodeRequest", "properties": { "auth_code_type": { "type": "string", "title": "Type of transfer authorization code. external (default) or internal (for internal transfers between reseller accounts in Openprovider only)" }, "domain": { "title": "Domain name and extension", "$ref": "#/definitions/domainDomain" }, "id": { "type": "integer", "format": "int32", "title": "Domain id number" }, "sending_type": { "type": "string", "title": "Indicates how authcode should be provisioned to domain owner. For ru / xn--p1ai domains only. Possible values: sms, email letter" } }, "example": { "auth_code_type": "internal", "domain": { "extension": "london", "name": "test4" }, "id": 0, "sending_type": "" } }, "authcodeResetAuthCodeResponse": { "type": "object", "title": "ResetAuthCodeResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/authcodeResetAuthCodeResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates that the Openprovider system is temporarily unavailable because of maintenance" }, "warnings": { "type": "array", "title": "Contains warning responses if any", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "auth_code": "12345678", "auth_info": { "pw": "cyF2A7jPp+T#?5j*-G82" }, "domain_roid": "", "epp_statuses": [ "" ], "rgp_statuses": { "add_period": "2019-05-23 12:05:48", "auto_renew_period": "2019-05-23 12:05:48" }, "success": false, "type": "internal" }, "desc": "" } }, "authcodeResetAuthCodeResponseData": { "type": "object", "title": "ResetAuthCodeResponseData", "properties": { "auth_code": { "type": "string", "title": "Authorization code" }, "auth_info": { "title": "The auth info", "$ref": "#/definitions/authcodeAuthInfo" }, "domain_roid": { "type": "string", "title": "The domain roid" }, "epp_statuses": { "type": "array", "title": "Array of EPP statuses", "items": { "type": "string" } }, "rgp_statuses": { "title": "The rgp statuses", "$ref": "#/definitions/authcodeRgpStatuses" }, "success": { "type": "boolean", "format": "boolean", "title": "Indicates if operation is successful" }, "type": { "type": "string", "title": "Authorization code type" } }, "example": { "auth_code": "12345678", "auth_info": { "pw": "cyF2A7jPp+T#?5j*-G82" }, "domain_roid": "", "epp_statuses": [ "" ], "rgp_statuses": { "add_period": "2019-05-23 12:05:48", "auto_renew_period": "2019-05-23 12:05:48" }, "success": false, "type": "internal" } }, "authcodeRgpStatuses": { "type": "object", "title": "RgpStatuses", "properties": { "add_period": { "type": "string", "title": "The add period" }, "auto_renew_period": { "type": "string", "title": "The auto renew period" } }, "example": { "add_period": "2019-05-23 12:05:48", "auto_renew_period": "2019-05-23 12:05:48" } }, "contactAdditionalData": { "type": "object", "title": "AdditionalData", "properties": { "birth_city": { "type": "string", "title": "Birth city" }, "birth_date": { "type": "string", "title": "Birth date" }, "social_security_number": { "type": "string", "title": "Social security number" } }, "example": { "birth_city": "Test city", "birth_date": "1969-12-31", "social_security_number": "12326178T" } }, "contactAddress": { "type": "object", "title": "Address", "properties": { "city": { "type": "string", "title": "City" }, "country": { "type": "string", "title": "Country code" }, "number": { "type": "string", "title": "Street number" }, "state": { "type": "string", "title": "State / province" }, "street": { "type": "string", "title": "Street" }, "suffix": { "type": "string", "title": "Address suffix" }, "zipcode": { "type": "string", "title": "Postal code" } }, "example": { "city": "Test city", "country": "NL", "number": "123", "state": "Testprovince", "street": "Test street", "suffix": "A", "zipcode": "1235 XX" } }, "contactClientIpList": { "type": "object", "title": "ClientIpList", "properties": { "allow": { "type": "array", "title": "IP whitelist", "items": { "type": "string" } }, "deny": { "type": "array", "title": "Blacklisted IP addresses", "items": { "type": "string" } } }, "example": { "allow": [ "127.0.0.1" ], "deny": [ "127.0.0.1" ] } }, "contactCreateContactRequest": { "type": "object", "title": "CreateContactRequest", "properties": { "additional_data": { "title": "Collection of data fields that contain additional customer information", "$ref": "#/definitions/contactAdditionalData" }, "address": { "title": "Address", "$ref": "#/definitions/contactAddress" }, "api_access_enabled": { "type": "boolean", "format": "boolean", "title": "Indicates if API access is enabled for the contact" }, "comments": { "type": "string", "title": "Custom notes to the specified handle" }, "company_name": { "type": "string", "title": "Company name" }, "email": { "type": "string", "title": "Email address" }, "inn": { "type": "string", "title": "Customer's individual tax number (for Russian customers only)" }, "is_active": { "type": "boolean", "format": "boolean", "title": "Indicates if contact is active" }, "kpp": { "type": "string", "title": "KPP code. For Russian customers only" }, "locale": { "type": "string", "title": "Customer's language" }, "name": { "title": "Full name", "$ref": "#/definitions/contactName" }, "password": { "type": "string", "title": "The password" }, "phone": { "title": "Phone number", "$ref": "#/definitions/contactPhone" }, "role": { "type": "string", "title": "Contact's role" }, "username": { "type": "string", "title": "Username" }, "vat": { "type": "string", "title": "VAT (value-added tax) number of the customer" } }, "example": { "additional_data": { "birth_city": "Test city", "birth_date": "1969-12-31", "social_security_number": "12326178T" }, "address": { "city": "Test city", "country": "NL", "number": "123", "state": "Testprovince", "street": "Test street", "suffix": "A", "zipcode": "1235 XX" }, "api_access_enabled": false, "comments": "", "company_name": "", "email": "", "inn": "", "is_active": false, "kpp": "", "locale": "", "name": { "first_name": "Test", "full_name": "Test Person", "initials": "T P", "last_name": "Person", "prefix": "Mr" }, "password": "", "phone": { "area_code": "111", "country_code": "+03", "subscriber_number": "123456" }, "role": "tech", "username": "", "vat": "" } }, "contactCreateContactResponse": { "type": "object", "title": "CreateContactResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/contactCreateContactResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "id": 1, "token": "b1fe1g5c8crd8c120426725t756054d9561hly4p" }, "desc": "" } }, "contactCreateContactResponseData": { "type": "object", "title": "CreateContactResponseData", "properties": { "id": { "type": "integer", "format": "int32", "title": "Object ID" }, "token": { "type": "string", "title": "The token" } }, "example": { "id": 1, "token": "b1fe1g5c8crd8c120426725t756054d9561hly4p" } }, "contactDeleteContactResponse": { "type": "object", "title": "DeleteContactResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/contactDeleteContactResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "success": false }, "desc": "" } }, "contactDeleteContactResponseData": { "type": "object", "title": "DeleteContactResponseData", "properties": { "success": { "type": "boolean", "format": "boolean", "title": "Indicates if operation was successful" } }, "example": { "success": false } }, "contactGetContactResponse": { "type": "object", "title": "GetContactResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/personcontactContact" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "additional_data": { "birth_city": "Test city", "birth_date": "1969-12-31", "social_security_number": "12326178T" }, "address": { "city": "Test city", "country": "NL", "number": "123", "state": "Testprovince", "street": "Test street", "suffix": "A", "zipcode": "1235 XX" }, "api_access_enabled": true, "api_client_ip_list": { "allow": [ "127.0.0.1" ], "deny": [ "127.0.0.1" ] }, "auth_type": "simple", "comments": "", "company_name": "Example company", "email": "test@mail.tld", "hash_changed_at": "2019-03-25 10:17:02", "id": 123456789, "is_active": false, "last_api_call_at": "2019-03-25 10:17:01", "last_login_at": "2019-04-12 11:58:39", "locale": "nl_NL", "name": { "first_name": "Test", "full_name": "Test Person", "initials": "T P", "last_name": "Person", "prefix": "Mr" }, "password_change_declined_at": "2019-03-23 12:32:15", "password_changed_at": "2019-03-25 10:17:00", "phone": { "area_code": "111", "country_code": "+03", "subscriber_number": "123456" }, "rcp_client_ip_list": { "allow": [ "127.0.0.1" ], "deny": [ "127.0.0.1" ] }, "reseller_id": 12345, "role": "admin", "secret_key": "SECRETKEYVALUE", "username": "user_name", "vat": "XX123456789X12" }, "desc": "" } }, "contactListContactsResponse": { "type": "object", "title": "ListContactsResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/contactListContactsResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "results": [ { "additional_data": { "birth_city": "Test city", "birth_date": "1969-12-31", "social_security_number": "12326178T" }, "address": { "city": "Test city", "country": "NL", "number": "123", "state": "Testprovince", "street": "Test street", "suffix": "A", "zipcode": "1235 XX" }, "api_access_enabled": true, "api_client_ip_list": { "allow": [ "127.0.0.1" ], "deny": [ "127.0.0.1" ] }, "auth_type": "simple", "comments": "", "company_name": "Example company", "email": "test@mail.tld", "hash_changed_at": "2019-03-25 10:17:02", "id": 123456789, "is_active": false, "last_api_call_at": "2019-03-25 10:17:01", "last_login_at": "2019-04-12 11:58:39", "locale": "nl_NL", "name": { "first_name": "Test", "full_name": "Test Person", "initials": "T P", "last_name": "Person", "prefix": "Mr" }, "password_change_declined_at": "2019-03-23 12:32:15", "password_changed_at": "2019-03-25 10:17:00", "phone": { "area_code": "111", "country_code": "+03", "subscriber_number": "123456" }, "rcp_client_ip_list": { "allow": [ "127.0.0.1" ], "deny": [ "127.0.0.1" ] }, "reseller_id": 12345, "role": "admin", "secret_key": "SECRETKEYVALUE", "username": "user_name", "vat": "XX123456789X12" } ], "total": 999 }, "desc": "" } }, "contactListContactsResponseData": { "type": "object", "title": "ListContactsResponseData", "properties": { "results": { "type": "array", "title": "Array of results", "items": { "$ref": "#/definitions/personcontactContact" } }, "total": { "type": "integer", "format": "int32", "title": "Total number of entities matching search criteria" } }, "example": { "results": [ { "additional_data": { "birth_city": "Test city", "birth_date": "1969-12-31", "social_security_number": "12326178T" }, "address": { "city": "Test city", "country": "NL", "number": "123", "state": "Testprovince", "street": "Test street", "suffix": "A", "zipcode": "1235 XX" }, "api_access_enabled": true, "api_client_ip_list": { "allow": [ "127.0.0.1" ], "deny": [ "127.0.0.1" ] }, "auth_type": "simple", "comments": "", "company_name": "Example company", "email": "test@mail.tld", "hash_changed_at": "2019-03-25 10:17:02", "id": 123456789, "is_active": false, "last_api_call_at": "2019-03-25 10:17:01", "last_login_at": "2019-04-12 11:58:39", "locale": "nl_NL", "name": { "first_name": "Test", "full_name": "Test Person", "initials": "T P", "last_name": "Person", "prefix": "Mr" }, "password_change_declined_at": "2019-03-23 12:32:15", "password_changed_at": "2019-03-25 10:17:00", "phone": { "area_code": "111", "country_code": "+03", "subscriber_number": "123456" }, "rcp_client_ip_list": { "allow": [ "127.0.0.1" ], "deny": [ "127.0.0.1" ] }, "reseller_id": 12345, "role": "admin", "secret_key": "SECRETKEYVALUE", "username": "user_name", "vat": "XX123456789X12" } ], "total": 999 } }, "contactName": { "type": "object", "title": "Name", "properties": { "first_name": { "type": "string", "title": "First name" }, "full_name": { "type": "string", "title": "Full name" }, "initials": { "type": "string", "title": "Initials (first letters of first names, first letter of last name)" }, "last_name": { "type": "string", "title": "Last name" }, "prefix": { "type": "string", "title": "Prefix (often occuring in Dutch names; for example van de)" } }, "example": { "first_name": "Test", "full_name": "Test Person", "initials": "T P", "last_name": "Person", "prefix": "Mr" } }, "contactPhone": { "type": "object", "title": "Phone", "properties": { "area_code": { "type": "string", "title": "Area code part of the phone number (excluding leading zero)" }, "country_code": { "type": "string", "title": "Country code part of the phone number (including +)" }, "subscriber_number": { "type": "string", "title": "Subscriber number part of the phone number" } }, "example": { "area_code": "111", "country_code": "+03", "subscriber_number": "123456" } }, "contactUpdateContactRequest": { "type": "object", "title": "UpdateContactRequest", "properties": { "additional_data": { "title": "Collection of data fields that contain additional customer information", "$ref": "#/definitions/contactAdditionalData" }, "address": { "title": "Address", "$ref": "#/definitions/contactAddress" }, "api_access_enabled": { "type": "boolean", "format": "boolean", "title": "Indicates if API access is enabled for the contact" }, "api_client_ip_list": { "title": "API access IP whitelist / blacklist", "$ref": "#/definitions/contactClientIpList" }, "auth_type": { "type": "string", "title": "Autherntication type" }, "comments": { "type": "string", "title": "Custom notes to the specified handle" }, "company_name": { "type": "string", "title": "Company name" }, "email": { "type": "string", "title": "Email address" }, "id": { "type": "integer", "format": "int32", "title": "Object ID" }, "inn": { "type": "string", "title": "Customer's individual tax number (for Russian customers only)" }, "is_active": { "type": "boolean", "format": "boolean", "title": "Indicates if contact is active" }, "kpp": { "type": "string", "title": "KPP number. For Russian customers only" }, "locale": { "type": "string", "title": "Customer's language" }, "name": { "title": "The name", "$ref": "#/definitions/contactName" }, "password_change_declined_at": { "type": "string", "title": "Password change declined date" }, "phone": { "title": "The phone", "$ref": "#/definitions/contactPhone" }, "rcp_client_ip_list": { "title": "RCP access IP whitelist / blacklist", "$ref": "#/definitions/contactClientIpList" }, "role": { "type": "string", "title": "Contact's role" }, "type": { "type": "string", "title": "The type" }, "vat": { "type": "string", "title": "VAT (value-added tax) number of the customer" } }, "example": { "additional_data": { "birth_city": "Test city", "birth_date": "1969-12-31", "social_security_number": "12326178T" }, "address": { "city": "Test city", "country": "NL", "number": "123", "state": "Testprovince", "street": "Test street", "suffix": "A", "zipcode": "1235 XX" }, "api_access_enabled": false, "api_client_ip_list": { "allow": [ "127.0.0.1" ], "deny": [ "127.0.0.1" ] }, "auth_type": "", "comments": "", "company_name": "", "email": "", "id": 123456789, "inn": "", "is_active": false, "kpp": "", "locale": "", "name": { "first_name": "Test", "full_name": "Test Person", "initials": "T P", "last_name": "Person", "prefix": "Mr" }, "password_change_declined_at": "", "phone": { "area_code": "111", "country_code": "+03", "subscriber_number": "123456" }, "rcp_client_ip_list": { "allow": [ "127.0.0.1" ], "deny": [ "127.0.0.1" ] }, "role": "", "type": "", "vat": "" } }, "contactUpdateContactResponse": { "type": "object", "title": "UpdateContactResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/contactUpdateContactResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "success": false }, "desc": "" } }, "contactUpdateContactResponseData": { "type": "object", "title": "UpdateContactResponseData", "properties": { "success": { "type": "boolean", "format": "boolean", "title": "Indicates if operation was successful" } }, "example": { "success": false } }, "csrCreateCsrRequest": { "type": "object", "title": "CreateCsrRequest", "properties": { "bits": { "type": "integer", "format": "int32", "title": "CSR key size. Values up to 4096 supported" }, "common_name": { "type": "string", "title": "Domain name to protect" }, "country": { "type": "string", "title": "Enrolling company's country code" }, "email": { "type": "string", "title": "Requester email address" }, "locality": { "type": "string", "title": "Enrolling company's location, i.e. street name and number" }, "organization": { "type": "string", "title": "Enrolling company name" }, "signature_hash_algorithm": { "description": "Redundant field, can be used as 'sha2'.", "type": "string" }, "state": { "type": "string", "title": "Enrolling company's state / province" }, "subject_alternative_name": { "type": "array", "title": "Additional domains in a case of Multi-domain certificate", "items": { "type": "string" } }, "unit": { "type": "string", "title": "Enrolling company's organization unit. If empty can be left black or set to IT" }, "with_config": { "type": "boolean", "format": "boolean", "title": "Config file for OpenSSL command dumped out when subjectAlternativeName domains are included", "default": false } }, "example": { "bits": 2048, "common_name": "example.com", "country": "NL", "email": "admin@example.com", "locality": "City", "organization": "MyCompany B.V.", "signature_hash_algorithm": "sha2", "state": "Testprovince", "subject_alternative_name": [ "www.example.com" ], "unit": "Dev", "with_config": true } }, "csrCreateCsrResponse": { "type": "object", "title": "CreateCsrResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/csrCreateCsrResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "command": "", "config": "", "config_path": "", "csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIIC0TCCAbkCAQAwgYsxCzAJBgNVBAYTAkFVMREwDwYDVQQIDAhleGFtcGxlczER\nMA8GA1UEBwwIZXhhbXBsZXMxETAPBgNVBAoMCGV4YW1wbGVzMQswCQYDVQQLDAJp\ndDEUMBIGA1UEAwwLZXhhbXBsZS5jb20xIDAeBgkqhkiG9w0BCQEWEWFkbWluQGV4\nYW1wbGUuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA6XbdNhvH\nRldtqE8iNm1Da0z+rkmAJlEtKUjqz5CDGcA9ByCLQ4qBIsSAkRgElBonMyR8lLDK\nh5Ac9jrkg40zrrXCl8TQ4sW5GFavwBPKCTHQu0EhovGWdV490+oOTVBckBW6niI5\nyaezhL4ZJzd4smrqoH3fPYPgLcb7+Lb4fsMfavRrallMrHP612bLm0mOpXKcwHos\nqBdC3OW2v64MnBdla3ZcPKFG8ThcdJoD9sym1EtKsm3MbyT9d8r3D+L2+xqZOjww\nacElCLmZ8Ep4aQVx0GRbJoDEA1Yy7A9YC4E+SObW7daquTX+zymeK0k1mACmOwvo\nJOrjLIhUbjJDtQIDAQABoAAwDQYJKoZIhvcNAQELBQADggEBANBGBu55iuzTYc4S\nZW3F8flSd0cO8ubKII6WcwHJrk8NIlAgfduAuNRuG9CAba0e72Ea0xKIhXSzxbDi\ncq9Yl0rkovY95ZyRayxl9AC4d7grJnncmKk2aUtarRq0pOaYfWuKwjaVPknGaGu6\nwCnGI/7nMCZA77ZH2s+rberHO+/6GCt+9pqSqY4u+2r83WMWMrVT/4jNBxKVErAk\n99iAC69+/N/afaryLoiAAtuaUPOAOD3fW4FXtjvvfht8xeU1AvYPOr0IfYdMH/Yq\n1EzRUsoxnhNG3Lb6YaQ0K59iFoBESSN5JHmLSLFEPb1i36Gx4kQMGJH8FM5tlPma\nySUlLeY=\n-----END CERTIFICATE REQUEST-----", "key": "", "key_path": "" }, "desc": "" } }, "csrCreateCsrResponseData": { "type": "object", "title": "CreateCsrResponseData", "properties": { "command": { "type": "string", "title": "OpenSSL command used to generate CSR" }, "config": { "type": "string", "title": "Config file for OpenSSL command" }, "config_path": { "type": "string", "title": "Config file path" }, "csr": { "type": "string", "title": "Generated CSR" }, "key": { "type": "string", "title": "Private key for the CSR" }, "key_path": { "type": "string", "title": "Key path" } }, "example": { "command": "", "config": "", "config_path": "", "csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIIC0TCCAbkCAQAwgYsxCzAJBgNVBAYTAkFVMREwDwYDVQQIDAhleGFtcGxlczER\nMA8GA1UEBwwIZXhhbXBsZXMxETAPBgNVBAoMCGV4YW1wbGVzMQswCQYDVQQLDAJp\ndDEUMBIGA1UEAwwLZXhhbXBsZS5jb20xIDAeBgkqhkiG9w0BCQEWEWFkbWluQGV4\nYW1wbGUuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA6XbdNhvH\nRldtqE8iNm1Da0z+rkmAJlEtKUjqz5CDGcA9ByCLQ4qBIsSAkRgElBonMyR8lLDK\nh5Ac9jrkg40zrrXCl8TQ4sW5GFavwBPKCTHQu0EhovGWdV490+oOTVBckBW6niI5\nyaezhL4ZJzd4smrqoH3fPYPgLcb7+Lb4fsMfavRrallMrHP612bLm0mOpXKcwHos\nqBdC3OW2v64MnBdla3ZcPKFG8ThcdJoD9sym1EtKsm3MbyT9d8r3D+L2+xqZOjww\nacElCLmZ8Ep4aQVx0GRbJoDEA1Yy7A9YC4E+SObW7daquTX+zymeK0k1mACmOwvo\nJOrjLIhUbjJDtQIDAQABoAAwDQYJKoZIhvcNAQELBQADggEBANBGBu55iuzTYc4S\nZW3F8flSd0cO8ubKII6WcwHJrk8NIlAgfduAuNRuG9CAba0e72Ea0xKIhXSzxbDi\ncq9Yl0rkovY95ZyRayxl9AC4d7grJnncmKk2aUtarRq0pOaYfWuKwjaVPknGaGu6\nwCnGI/7nMCZA77ZH2s+rberHO+/6GCt+9pqSqY4u+2r83WMWMrVT/4jNBxKVErAk\n99iAC69+/N/afaryLoiAAtuaUPOAOD3fW4FXtjvvfht8xeU1AvYPOr0IfYdMH/Yq\n1EzRUsoxnhNG3Lb6YaQ0K59iFoBESSN5JHmLSLFEPb1i36Gx4kQMGJH8FM5tlPma\nySUlLeY=\n-----END CERTIFICATE REQUEST-----", "key": "", "key_path": "" } }, "csrCsrPublicKey": { "type": "object", "title": "CsrPublicKey", "properties": { "bits": { "type": "integer", "format": "int32", "title": "Key size in bits" }, "key": { "type": "string", "title": "Individual private key for new CSR" } }, "example": { "bits": 2048, "key": "" } }, "csrCsrSubject": { "type": "object", "title": "CsrSubject", "properties": { "common_name": { "type": "string", "title": "Common name used in CSR" }, "country": { "type": "string", "title": "Country used in CSR" }, "email": { "type": "string", "title": "Email used in CSR" }, "locality": { "type": "string", "title": "Locality used in CSR" }, "organization": { "type": "string", "title": "Company name used in CSR" }, "state": { "type": "string", "title": "State / province used in CSR" }, "unit": { "type": "string", "title": "Organization unit used in CSR" } }, "example": { "common_name": "example.com", "country": "NL", "email": "admin@example.com", "locality": "City", "organization": "MyCompany B.V.", "state": "Testprovince", "unit": "Domain Control Validated" } }, "csrDecodeCsrRequest": { "type": "object", "title": "DecodeCsrRequest", "properties": { "csr": { "type": "string", "title": "Encoded CSR Value" } }, "example": { "csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIIC0TCCAbkCAQAwgYsxCzAJBgNVBAYTAkFVMREwDwYDVQQIDAhleGFtcGxlczER\nMA8GA1UEBwwIZXhhbXBsZXMxETAPBgNVBAoMCGV4YW1wbGVzMQswCQYDVQQLDAJp\ndDEUMBIGA1UEAwwLZXhhbXBsZS5jb20xIDAeBgkqhkiG9w0BCQEWEWFkbWluQGV4\nYW1wbGUuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA6XbdNhvH\nRldtqE8iNm1Da0z+rkmAJlEtKUjqz5CDGcA9ByCLQ4qBIsSAkRgElBonMyR8lLDK\nh5Ac9jrkg40zrrXCl8TQ4sW5GFavwBPKCTHQu0EhovGWdV490+oOTVBckBW6niI5\nyaezhL4ZJzd4smrqoH3fPYPgLcb7+Lb4fsMfavRrallMrHP612bLm0mOpXKcwHos\nqBdC3OW2v64MnBdla3ZcPKFG8ThcdJoD9sym1EtKsm3MbyT9d8r3D+L2+xqZOjww\nacElCLmZ8Ep4aQVx0GRbJoDEA1Yy7A9YC4E+SObW7daquTX+zymeK0k1mACmOwvo\nJOrjLIhUbjJDtQIDAQABoAAwDQYJKoZIhvcNAQELBQADggEBANBGBu55iuzTYc4S\nZW3F8flSd0cO8ubKII6WcwHJrk8NIlAgfduAuNRuG9CAba0e72Ea0xKIhXSzxbDi\ncq9Yl0rkovY95ZyRayxl9AC4d7grJnncmKk2aUtarRq0pOaYfWuKwjaVPknGaGu6\nwCnGI/7nMCZA77ZH2s+rberHO+/6GCt+9pqSqY4u+2r83WMWMrVT/4jNBxKVErAk\n99iAC69+/N/afaryLoiAAtuaUPOAOD3fW4FXtjvvfht8xeU1AvYPOr0IfYdMH/Yq\n1EzRUsoxnhNG3Lb6YaQ0K59iFoBESSN5JHmLSLFEPb1i36Gx4kQMGJH8FM5tlPma\nySUlLeY=\n-----END CERTIFICATE REQUEST-----" } }, "csrDecodeCsrResponse": { "type": "object", "title": "DecodeCsrResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/csrDecodeCsrResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "domain_names_count": 2, "public_key": { "bits": 2048, "key": "" }, "signature_hash_algorithm": "sha2", "subject": { "common_name": "example.com", "country": "NL", "email": "admin@example.com", "locality": "City", "organization": "MyCompany B.V.", "state": "Testprovince", "unit": "Domain Control Validated" }, "subject_alternative_name": [ "www.example.com" ] }, "desc": "" } }, "csrDecodeCsrResponseData": { "type": "object", "title": "DecodeCsrResponseData", "properties": { "domain_names_count": { "type": "integer", "format": "int32", "title": "Count of additional domain names" }, "public_key": { "title": "Public key of the CSR", "$ref": "#/definitions/csrCsrPublicKey" }, "signature_hash_algorithm": { "type": "string", "title": "Signature algorithm" }, "subject": { "description": "Information about organization, country, etc.", "$ref": "#/definitions/csrCsrSubject" }, "subject_alternative_name": { "type": "array", "title": "Additional domain names", "items": { "type": "string" } } }, "example": { "domain_names_count": 2, "public_key": { "bits": 2048, "key": "" }, "signature_hash_algorithm": "sha2", "subject": { "common_name": "example.com", "country": "NL", "email": "admin@example.com", "locality": "City", "organization": "MyCompany B.V.", "state": "Testprovince", "unit": "Domain Control Validated" }, "subject_alternative_name": [ "www.example.com" ] } }, "customerCreateCustomerRequest": { "type": "object", "title": "CreateCustomerRequest", "properties": { "additional_data": { "title": "Collection of data fields that contain additional customer information", "$ref": "#/definitions/customerCustomerAdditionalData" }, "address": { "title": "Customer's address", "$ref": "#/definitions/contactAddress" }, "comments": { "type": "string", "title": "Custom notes to the specified handle" }, "company_name": { "type": "string", "title": "Company name" }, "email": { "type": "string", "title": "Customer's email" }, "extension_additional_data": { "type": "array", "title": "Collection of data fields that are required for certain TLDs", "items": { "$ref": "#/definitions/customerExtensionAdditionalData" } }, "fax": { "title": "Customer's fax", "$ref": "#/definitions/customerFax" }, "locale": { "type": "string", "title": "Customer's language" }, "name": { "title": "Customer's full name", "$ref": "#/definitions/contactName" }, "phone": { "title": "Customer's phone", "$ref": "#/definitions/contactPhone" }, "tags": { "type": "array", "title": "Custom tags applied to entity", "items": { "$ref": "#/definitions/customerTags" } }, "vat": { "type": "string", "title": "VAT (value-added tax) number of the customer" } }, "example": { "additional_data": { "attached_files": [ { "description": "My passport scan", "doc_type": "passport", "path": "https://drive.google.com/open?id=1EclbGeo8Y3UWg3KSF7ebmwcK7ddLTtC7m3aHZ1qMnjE" } ], "birth_address": "test street 45", "birth_city": "Test city", "birth_country": "NL", "birth_date": "1970-01-01", "birth_state": "Testprovince", "birth_zipcode": "123", "company_registration_city": "Testcity", "company_registration_number": "XX123456789X04", "company_registration_subscription_date": "2000-01-01", "company_url": "https://openprovider.com", "headquarters_address": "Test street 5", "headquarters_city": "Testcity", "headquarters_country": "NL", "headquarters_state": "Testprovince", "headquarters_zipcode": "123", "passport_number": "123456", "social_security_number": "6543210", "trading_name": "Openprovider" }, "address": { "city": "Test city", "country": "NL", "number": "123", "state": "Testprovince", "street": "Test street", "suffix": "A", "zipcode": "1235 XX" }, "comments": "", "company_name": "Example company", "email": "test@mail.tld", "extension_additional_data": [ { "data": { "admin_type": "1", "applicant_purpose": "P3", "birth_date": "1970-01-01", "company_name_cyrillic": "Example company", "company_name_latin": "Example company", "company_registration_number": "XX123456789X11", "contact_title": "CEO", "country_of_citizenship": "NL", "customer_uin": "", "ens_auth_id": "", "ens_key": "", "first_name_cyrillic": "Test", "first_name_latin": "Test", "hr_member": "", "industry_class": "19", "is_private_enterpreneur": "", "last_name_cyrillic": "Person", "last_name_latin": "Person", "legal_address_cyrillic": "13245 Country, City, street, 2", "legal_type": "FCORP", "middle_name_cyrillic": "Nikolaevich", "middle_name_latin": "Nikolaevich", "mobile_phone_number": "+7 (123) 456-78-90", "nexus_category": "C31", "org_type": "1", "passport_issue_date": "2009-01-11", "passport_issuer": "Issuer name", "passport_number": "12345678", "passport_series": "1234", "postal_address_cyrillic": "12345 Country, City, street, 1", "social_security_number": "X123455123X", "tax_payer_number": "1345678", "uin": "12345-6", "user_type": "Individual", "vat": "XX123456789X12", "website": "http://example.com", "whois_email": "test@mail.tld" }, "name": "ru" } ], "fax": { "area_code": "", "country_code": "", "subscriber_number": "" }, "locale": "nl_NL", "name": { "first_name": "Test", "full_name": "Test Person", "initials": "T P", "last_name": "Person", "prefix": "Mr" }, "phone": { "area_code": "111", "country_code": "+03", "subscriber_number": "123456" }, "tags": [ { "key": "customer", "value": "VIP" } ], "vat": "NL123456789X11" } }, "customerCreateCustomerResponse": { "type": "object", "title": "CreateCustomerResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/customerCreateCustomerResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "handle": "XX123456-XX" }, "desc": "" } }, "customerCreateCustomerResponseData": { "type": "object", "title": "CreateCustomerResponseData", "properties": { "handle": { "type": "string", "title": "Customer unique identifier or handle, which can be created via CreateCustomer API method" } }, "example": { "handle": "XX123456-XX" } }, "customerCustomerAdditionalData": { "type": "object", "title": "CustomerAdditionalData", "properties": { "attached_files": { "type": "array", "title": "File(s) attached to customer handle e.g. like the proof of the customer identity (passport scan or legal entity documents)", "items": { "$ref": "#/definitions/customerFile" } }, "birth_address": { "type": "string", "title": "Birth address" }, "birth_city": { "type": "string", "title": "Birth city" }, "birth_country": { "type": "string", "title": "Birth country" }, "birth_date": { "type": "string", "title": "Birth date" }, "birth_state": { "type": "string", "title": "Birth state / province" }, "birth_zipcode": { "type": "string", "title": "Birth address postal code" }, "company_registration_city": { "type": "string", "title": "Customer company's registration city" }, "company_registration_number": { "type": "string", "title": "Customer company's registration number" }, "company_registration_subscription_date": { "type": "string", "title": "Customer company's registration date" }, "company_url": { "type": "string", "title": "Company URL" }, "headquarters_address": { "type": "string", "title": "Company's headquarters address" }, "headquarters_city": { "type": "string", "title": "Company's headquarters city" }, "headquarters_country": { "type": "string", "title": "Company's headquarters country" }, "headquarters_state": { "type": "string", "title": "Company's headquarters state / province" }, "headquarters_zipcode": { "type": "string", "title": "Company's headquarters zip/postal code" }, "passport_number": { "type": "string", "title": "Customer's passport / id number" }, "social_security_number": { "type": "string", "title": "Social security number" }, "trading_name": { "type": "string", "title": "Trading name" } }, "example": { "attached_files": [ { "description": "My passport scan", "doc_type": "passport", "path": "https://drive.google.com/open?id=1EclbGeo8Y3UWg3KSF7ebmwcK7ddLTtC7m3aHZ1qMnjE" } ], "birth_address": "test street 45", "birth_city": "Test city", "birth_country": "NL", "birth_date": "1970-01-01", "birth_state": "Testprovince", "birth_zipcode": "123", "company_registration_city": "Testcity", "company_registration_number": "XX123456789X04", "company_registration_subscription_date": "2000-01-01", "company_url": "https://openprovider.com", "headquarters_address": "Test street 5", "headquarters_city": "Testcity", "headquarters_country": "NL", "headquarters_state": "Testprovince", "headquarters_zipcode": "123", "passport_number": "123456", "social_security_number": "6543210", "trading_name": "Openprovider" } }, "customerDeleteCustomerResponse": { "type": "object", "title": "DeleteCustomerResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/customerDeleteCustomerResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "success": false }, "desc": "" } }, "customerDeleteCustomerResponseData": { "type": "object", "title": "DeleteCustomerResponseData", "properties": { "success": { "type": "boolean", "format": "boolean", "title": "Indicates if operation was successful" } }, "example": { "success": false } }, "customerExtensionAdditionalData": { "type": "object", "title": "ExtensionAdditionalData", "properties": { "data": { "title": "Response data", "$ref": "#/definitions/customerExtensionData" }, "name": { "type": "string", "title": "Indicates for which extension additional data is listed" } }, "example": { "data": { "admin_type": "1", "applicant_purpose": "P3", "birth_date": "1970-01-01", "company_name_cyrillic": "Example company", "company_name_latin": "Example company", "company_registration_number": "XX123456789X11", "contact_title": "CEO", "country_of_citizenship": "NL", "customer_uin": "", "ens_auth_id": "", "ens_key": "", "first_name_cyrillic": "Test", "first_name_latin": "Test", "hr_member": "", "industry_class": "19", "is_private_enterpreneur": "", "last_name_cyrillic": "Person", "last_name_latin": "Person", "legal_address_cyrillic": "13245 Country, City, street, 2", "legal_type": "FCORP", "middle_name_cyrillic": "Nikolaevich", "middle_name_latin": "Nikolaevich", "mobile_phone_number": "+7 (123) 456-78-90", "nexus_category": "C31", "org_type": "1", "passport_issue_date": "2009-01-11", "passport_issuer": "Issuer name", "passport_number": "12345678", "passport_series": "1234", "postal_address_cyrillic": "12345 Country, City, street, 1", "social_security_number": "X123455123X", "tax_payer_number": "1345678", "uin": "12345-6", "user_type": "Individual", "vat": "XX123456789X12", "website": "http://example.com", "whois_email": "test@mail.tld" }, "name": "ru" } }, "customerExtensionData": { "type": "object", "title": "ExtensionData", "properties": { "admin_type": { "type": "string", "title": "The adminType: enter whether the contact is the administrative contact with the permission to act as an independent agent/recruiter on behalf of the listed registrant.\nApplicable to: .jobs" }, "applicant_purpose": { "type": "string", "title": "The applicant Purpose\nApplicable to: .us" }, "birth_date": { "type": "string", "title": "The date of birth of the domain holder or legal representative in case of an organization.The format of the date is YYYY-MM-DD.\nApplicable to: .ac.vn, .biz.vn, .com.vn, .edu.vn, .gov.vn, .health.vn, .info.vn, .int.vn, .name.vn, .net.vn, .org.vn, .pro.vn, .ru, .su, .vn, .xn--p1ai" }, "company_name_cyrillic": { "type": "string", "title": "The company name in Cyrillic. For companies based outside of Russia can be stated in Latin\nApplicable to: .ru, .su, .xn--p1ai" }, "company_name_latin": { "type": "string", "title": "The company name in Latin\nApplicable to: .ru, .su, .xn--p1ai" }, "company_registration_number": { "type": "string", "title": "The company registration number. Required in case if domain requester is a legal entity\nApplicable to: .es, .se" }, "contact_title": { "type": "string", "title": "The contactTitle should be filled with the title of the domain contact in the organization.\nApplicable to: .jobs" }, "country_of_citizenship": { "type": "string", "title": "Country of citizenship (only applicable for natural persons if country of residence is not within the eligible countries)\nApplicable to: .eu" }, "customer_uin": { "type": "string", "title": "Unique identification customer number\nApplicable to: .sk" }, "ens_auth_id": { "type": "string", "title": "The ensAuthId must be filled with aero authentication ID. Link to apply for an aero authentication ID: http://www.information.aero/registration/manage_your_aero_id/apply\nApplicable to: .aero" }, "ens_key": { "type": "string", "title": "The ensAuthId must be filled with aero ENS key\nApplicable to: .aero" }, "first_name_cyrillic": { "type": "string", "title": "The first name in Cyrillic. For individuals based outside of Russia can be stated in Latin\nApplicable to: .ru, .su, .xn--p1ai" }, "first_name_latin": { "type": "string", "title": "The first name in Latin\nApplicable to: .ru, .su, .xn--p1ai" }, "hr_member": { "type": "string", "title": "The hrMember: choose whether the contact is a member of the \u201eHuman Resource Organization\u201c.\nApplicable to: .jobs" }, "industry_class": { "type": "string", "title": "The industry class\nApplicable to: .jobs" }, "is_private_enterpreneur": { "type": "string", "title": "Indicates whether the contact is the private enterpreneur.\nApplicable to: .ru, .xn--p1ai" }, "last_name_cyrillic": { "type": "string", "title": "The last name in Cyrillic. or individuals based outside of Russia can be stated in Latin\nApplicable to: .ru, .su, .xn--p1ai" }, "last_name_latin": { "type": "string", "title": "The last name in Latin\nApplicable to: .ru, .su, .xn--p1ai" }, "legal_address_cyrillic": { "type": "string", "title": "The legal address in cyrillic.If domain owner is based outside of Russia can be supplied in Latin\nApplicable to: .ru, .su, .xn--p1ai" }, "legal_type": { "type": "string", "title": "The legal type of Customer.\nApplicable to: .uk, .co.uk, org.uk, me.uk, .ltd.uk" }, "middle_name_cyrillic": { "type": "string", "title": "The middle name in Cyrillic. or individuals based outside of Russia can be stated in Latin\nApplicable to: .ru, .su, .xn--p1ai" }, "middle_name_latin": { "type": "string", "title": "The middle name in Latin\nApplicable to: .ru, .su, .xn--p1ai" }, "mobile_phone_number": { "type": "string", "title": "The mobile phone number with SMS function\nApplicable to: .ru, .su, .xn--p1ai" }, "nexus_category": { "type": "string", "title": "The nexus Category\nApplicable to: .us" }, "org_type": { "type": "string", "title": "The type of Organization\nApplicable to: .fi" }, "passport_issue_date": { "type": "string", "title": "The passport issue date\nApplicable to: .ru, .su, .xn--p1ai" }, "passport_issuer": { "type": "string", "title": "The passport issuer\nApplicable to: .ru, .su, .xn--p1ai" }, "passport_number": { "type": "string", "title": "The iD / passport number of the domain holder for natural persons or VAT number for companies\nApplicable to: .ac.vn, .biz.vn, .com.vn, .edu.vn, .es, .gov.vn, .health.vn, .info.vn, .int.vn, .name.vn, .net.vn, .org.vn, .pro.vn, .ru, .su, .vn, .xn--p1ai" }, "passport_series": { "type": "string", "title": "The passport series\nApplicable to: .ru, .su, .xn--p1ai" }, "postal_address_cyrillic": { "type": "string", "title": "The postal address in cyrillic. If domain owner is based outside of Russia can be supplied in Latin\nApplicable to: .ru, .su, .xn--p1ai" }, "social_security_number": { "type": "string", "title": "The social security number. Required in case if domain requester is a private individual and passport number is empty\nApplicable to: .es, .se" }, "tax_payer_number": { "type": "string", "title": "The tax payer number\nApplicable to: .ru, .su, .xn--p1ai" }, "uin": { "type": "string", "title": "The in order to register .TRAVEL domains the registrant has to provide a UIN \"Unique Identification Number\". The UIN can be provided to the registrant through an Association Authentification Partner (further information can be found at http://www.travel.travel/index.php/authenticate-register/).\nApplicable to: .travel" }, "user_type": { "type": "string", "title": "The type of Customer\nApplicable to: .dk, .sk" }, "vat": { "type": "string", "title": "Vat number. Required in case if domain requester is a legal entity\nApplicable to: .ac.vn, .biz.vn, .com.vn, .edu.vn, .gov.vn, .health.vn, .info.vn, .int.vn, .name.vn, .net.vn, .org.vn, .pro.vn, .vn" }, "website": { "type": "string", "title": "The website: website must be filled with the correct website URL of the organization.\nApplicable to: .jobs" }, "whois_email": { "type": "string", "title": "The WHOIS email address of a registrant will only be visible on the web-based WHOIS https://whois.eurid.eu/en/ instead of current email\nApplicable to: .eu" } }, "example": { "admin_type": "1", "applicant_purpose": "P3", "birth_date": "1970-01-01", "company_name_cyrillic": "Example company", "company_name_latin": "Example company", "company_registration_number": "XX123456789X11", "contact_title": "CEO", "country_of_citizenship": "NL", "customer_uin": "", "ens_auth_id": "", "ens_key": "", "first_name_cyrillic": "Test", "first_name_latin": "Test", "hr_member": "", "industry_class": "19", "is_private_enterpreneur": "", "last_name_cyrillic": "Person", "last_name_latin": "Person", "legal_address_cyrillic": "13245 Country, City, street, 2", "legal_type": "FCORP", "middle_name_cyrillic": "Nikolaevich", "middle_name_latin": "Nikolaevich", "mobile_phone_number": "+7 (123) 456-78-90", "nexus_category": "C31", "org_type": "1", "passport_issue_date": "2009-01-11", "passport_issuer": "Issuer name", "passport_number": "12345678", "passport_series": "1234", "postal_address_cyrillic": "12345 Country, City, street, 1", "social_security_number": "X123455123X", "tax_payer_number": "1345678", "uin": "12345-6", "user_type": "Individual", "vat": "XX123456789X12", "website": "http://example.com", "whois_email": "test@mail.tld" } }, "customerFax": { "type": "object", "title": "Fax", "properties": { "area_code": { "type": "string", "title": "Area code part of the phone number (excluding leading zero)" }, "country_code": { "type": "string", "title": "Country code part of the phone number (including +)" }, "subscriber_number": { "type": "string", "title": "Subscriber number part of the phone number" } }, "example": { "area_code": "", "country_code": "", "subscriber_number": "" } }, "customerFile": { "type": "object", "title": "File", "properties": { "description": { "type": "string", "title": "Brief description of the file content" }, "doc_type": { "type": "string", "title": "Type of the document, e.g. 'passport', 'id'" }, "path": { "type": "string", "title": "Link to the external file storage" } }, "example": { "description": "My passport scan", "doc_type": "passport", "path": "https://drive.google.com/open?id=1EclbGeo8Y3UWg3KSF7ebmwcK7ddLTtC7m3aHZ1qMnjE" } }, "customerGetCustomerResponse": { "type": "object", "title": "GetCustomerResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/customerGetCustomerResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "additional_data": { "attached_files": [ { "description": "My passport scan", "doc_type": "passport", "path": "https://drive.google.com/open?id=1EclbGeo8Y3UWg3KSF7ebmwcK7ddLTtC7m3aHZ1qMnjE" } ], "birth_address": "test street 45", "birth_city": "Test city", "birth_country": "NL", "birth_date": "1970-01-01", "birth_state": "Testprovince", "birth_zipcode": "123", "company_registration_city": "Testcity", "company_registration_number": "XX123456789X04", "company_registration_subscription_date": "2000-01-01", "company_url": "https://openprovider.com", "headquarters_address": "Test street 5", "headquarters_city": "Testcity", "headquarters_country": "NL", "headquarters_state": "Testprovince", "headquarters_zipcode": "123", "passport_number": "123456", "social_security_number": "6543210", "trading_name": "Openprovider" }, "address": { "city": "Test city", "country": "NL", "number": "123", "state": "Testprovince", "street": "Test street", "suffix": "A", "zipcode": "1235 XX" }, "comments": "Some comment here", "comments_last_changed_at": "2014-05-08 19:04:11", "company_name": "Example company", "deleted_at": "0000-00-00 00:00:00", "email": "test@mail.tld", "email_verification_status": "ACT", "extension_additional_data": [ { "data": { "admin_type": "1", "applicant_purpose": "P3", "birth_date": "1970-01-01", "company_name_cyrillic": "Example company", "company_name_latin": "Example company", "company_registration_number": "XX123456789X11", "contact_title": "CEO", "country_of_citizenship": "NL", "customer_uin": "", "ens_auth_id": "", "ens_key": "", "first_name_cyrillic": "Test", "first_name_latin": "Test", "hr_member": "", "industry_class": "19", "is_private_enterpreneur": "", "last_name_cyrillic": "Person", "last_name_latin": "Person", "legal_address_cyrillic": "13245 Country, City, street, 2", "legal_type": "FCORP", "middle_name_cyrillic": "Nikolaevich", "middle_name_latin": "Nikolaevich", "mobile_phone_number": "+7 (123) 456-78-90", "nexus_category": "C31", "org_type": "1", "passport_issue_date": "2009-01-11", "passport_issuer": "Issuer name", "passport_number": "12345678", "passport_series": "1234", "postal_address_cyrillic": "12345 Country, City, street, 1", "social_security_number": "X123455123X", "tax_payer_number": "1345678", "uin": "12345-6", "user_type": "Individual", "vat": "XX123456789X12", "website": "http://example.com", "whois_email": "test@mail.tld" }, "name": "ru" } ], "fax": { "area_code": "", "country_code": "", "subscriber_number": "" }, "handle": "XX123456-XX", "id": 123456789, "inn": "123456789", "is_deleted": false, "locale": "nl_NL", "name": { "first_name": "Test", "full_name": "Test Person", "initials": "T P", "last_name": "Person", "prefix": "Mr" }, "phone": { "area_code": "111", "country_code": "+03", "subscriber_number": "123456" }, "reseller_id": 5349, "tags": [ { "key": "customer", "value": "VIP" } ], "vat": "XX123456789X11" }, "desc": "" } }, "customerGetCustomerResponseData": { "type": "object", "title": "GetCustomerResponseData", "properties": { "additional_data": { "title": "Collection of data fields that contain additional customer information", "$ref": "#/definitions/customerCustomerAdditionalData" }, "address": { "title": "Address", "$ref": "#/definitions/contactAddress" }, "comments": { "type": "string", "title": "Custom notes on the specified handle" }, "comments_last_changed_at": { "type": "string", "title": "Date of last comments change" }, "company_name": { "type": "string", "title": "Company name" }, "deleted_at": { "type": "string", "title": "Handle deletion date" }, "email": { "type": "string", "title": "Email address" }, "email_verification_status": { "type": "string", "title": "Status of email verification procedure" }, "extension_additional_data": { "type": "array", "title": "Collection of data fields that contain information required by certain TLDs", "items": { "$ref": "#/definitions/customerExtensionAdditionalData" } }, "fax": { "title": "Fax number", "$ref": "#/definitions/customerFax" }, "handle": { "type": "string", "title": "Customer unique identifier or handle, which can be created via CreateCustomer API method" }, "id": { "type": "integer", "format": "int32", "title": "Object ID" }, "inn": { "type": "string", "title": "Customer's individual tax number (for Russian customers only)" }, "is_deleted": { "type": "boolean", "format": "boolean", "title": "Indicates whether handle is deleted or not" }, "locale": { "type": "string", "title": "Customer's language" }, "name": { "title": "Customer's full name", "$ref": "#/definitions/contactName" }, "phone": { "title": "Phone number", "$ref": "#/definitions/contactPhone" }, "reseller_id": { "type": "integer", "format": "int32", "title": "Reseller ID" }, "tags": { "type": "array", "title": "Custom tags applied to entity", "items": { "$ref": "#/definitions/customerTags" } }, "vat": { "type": "string", "title": "VAT (value-added tax) number of the customer" } }, "example": { "additional_data": { "attached_files": [ { "description": "My passport scan", "doc_type": "passport", "path": "https://drive.google.com/open?id=1EclbGeo8Y3UWg3KSF7ebmwcK7ddLTtC7m3aHZ1qMnjE" } ], "birth_address": "test street 45", "birth_city": "Test city", "birth_country": "NL", "birth_date": "1970-01-01", "birth_state": "Testprovince", "birth_zipcode": "123", "company_registration_city": "Testcity", "company_registration_number": "XX123456789X04", "company_registration_subscription_date": "2000-01-01", "company_url": "https://openprovider.com", "headquarters_address": "Test street 5", "headquarters_city": "Testcity", "headquarters_country": "NL", "headquarters_state": "Testprovince", "headquarters_zipcode": "123", "passport_number": "123456", "social_security_number": "6543210", "trading_name": "Openprovider" }, "address": { "city": "Test city", "country": "NL", "number": "123", "state": "Testprovince", "street": "Test street", "suffix": "A", "zipcode": "1235 XX" }, "comments": "Some comment here", "comments_last_changed_at": "2014-05-08 19:04:11", "company_name": "Example company", "deleted_at": "0000-00-00 00:00:00", "email": "test@mail.tld", "email_verification_status": "ACT", "extension_additional_data": [ { "data": { "admin_type": "1", "applicant_purpose": "P3", "birth_date": "1970-01-01", "company_name_cyrillic": "Example company", "company_name_latin": "Example company", "company_registration_number": "XX123456789X11", "contact_title": "CEO", "country_of_citizenship": "NL", "customer_uin": "", "ens_auth_id": "", "ens_key": "", "first_name_cyrillic": "Test", "first_name_latin": "Test", "hr_member": "", "industry_class": "19", "is_private_enterpreneur": "", "last_name_cyrillic": "Person", "last_name_latin": "Person", "legal_address_cyrillic": "13245 Country, City, street, 2", "legal_type": "FCORP", "middle_name_cyrillic": "Nikolaevich", "middle_name_latin": "Nikolaevich", "mobile_phone_number": "+7 (123) 456-78-90", "nexus_category": "C31", "org_type": "1", "passport_issue_date": "2009-01-11", "passport_issuer": "Issuer name", "passport_number": "12345678", "passport_series": "1234", "postal_address_cyrillic": "12345 Country, City, street, 1", "social_security_number": "X123455123X", "tax_payer_number": "1345678", "uin": "12345-6", "user_type": "Individual", "vat": "XX123456789X12", "website": "http://example.com", "whois_email": "test@mail.tld" }, "name": "ru" } ], "fax": { "area_code": "", "country_code": "", "subscriber_number": "" }, "handle": "XX123456-XX", "id": 123456789, "inn": "123456789", "is_deleted": false, "locale": "nl_NL", "name": { "first_name": "Test", "full_name": "Test Person", "initials": "T P", "last_name": "Person", "prefix": "Mr" }, "phone": { "area_code": "111", "country_code": "+03", "subscriber_number": "123456" }, "reseller_id": 5349, "tags": [ { "key": "customer", "value": "VIP" } ], "vat": "XX123456789X11" } }, "customerGetDataResponse": { "type": "object", "title": "GetDataResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "type": "array", "title": "Response data", "items": { "$ref": "#/definitions/additional_dataSpecification" } }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates that the Openprovider system is temporarily unavailable because of maintenance" }, "warnings": { "type": "array", "title": "Contains warning responses if any", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": [ { "description": "IDN script states what language or character set the domain name is in", "name": "idnScript", "options": [ { "description": "Norwegian", "value": "no" } ], "required": false, "type": "select" } ], "desc": "" } }, "customerListCustomersResponse": { "type": "object", "title": "ListCustomersResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/customerListCustomersResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "results": [ { "additional_data": { "attached_files": [ { "description": "My passport scan", "doc_type": "passport", "path": "https://drive.google.com/open?id=1EclbGeo8Y3UWg3KSF7ebmwcK7ddLTtC7m3aHZ1qMnjE" } ], "birth_address": "test street 45", "birth_city": "Test city", "birth_country": "NL", "birth_date": "1970-01-01", "birth_state": "Testprovince", "birth_zipcode": "123", "company_registration_city": "Testcity", "company_registration_number": "XX123456789X04", "company_registration_subscription_date": "2000-01-01", "company_url": "https://openprovider.com", "headquarters_address": "Test street 5", "headquarters_city": "Testcity", "headquarters_country": "NL", "headquarters_state": "Testprovince", "headquarters_zipcode": "123", "passport_number": "123456", "social_security_number": "6543210", "trading_name": "Openprovider" }, "address": { "city": "Test city", "country": "NL", "number": "123", "state": "Testprovince", "street": "Test street", "suffix": "A", "zipcode": "1235 XX" }, "comments": "", "comments_last_changed_at": "", "company_name": "", "deleted_at": "0000-00-00 00:00:00", "email": "test@mail.tld", "email_verification_status": "FAI", "extension_additional_data": [ { "data": { "admin_type": "1", "applicant_purpose": "P3", "birth_date": "1970-01-01", "company_name_cyrillic": "Example company", "company_name_latin": "Example company", "company_registration_number": "XX123456789X11", "contact_title": "CEO", "country_of_citizenship": "NL", "customer_uin": "", "ens_auth_id": "", "ens_key": "", "first_name_cyrillic": "Test", "first_name_latin": "Test", "hr_member": "", "industry_class": "19", "is_private_enterpreneur": "", "last_name_cyrillic": "Person", "last_name_latin": "Person", "legal_address_cyrillic": "13245 Country, City, street, 2", "legal_type": "FCORP", "middle_name_cyrillic": "Nikolaevich", "middle_name_latin": "Nikolaevich", "mobile_phone_number": "+7 (123) 456-78-90", "nexus_category": "C31", "org_type": "1", "passport_issue_date": "2009-01-11", "passport_issuer": "Issuer name", "passport_number": "12345678", "passport_series": "1234", "postal_address_cyrillic": "12345 Country, City, street, 1", "social_security_number": "X123455123X", "tax_payer_number": "1345678", "uin": "12345-6", "user_type": "Individual", "vat": "XX123456789X12", "website": "http://example.com", "whois_email": "test@mail.tld" }, "name": "ru" } ], "handle": "XX123456-XX", "id": 123456789, "is_deleted": false, "locale": "nl_NL", "name": { "first_name": "Test", "full_name": "Test Person", "initials": "T P", "last_name": "Person", "prefix": "Mr" }, "phone": { "area_code": "111", "country_code": "+03", "subscriber_number": "123456" }, "reseller_id": 5349, "tags": [ { "key": "customer", "value": "VIP" } ] } ], "total": 999 }, "desc": "" } }, "customerListCustomersResponseData": { "type": "object", "title": "ListCustomersResponseData", "properties": { "results": { "type": "array", "title": "Array of results", "items": { "$ref": "#/definitions/customerListCustomersResponseDataResults" } }, "total": { "type": "integer", "format": "int32", "title": "Total number of entities matching search criteria" } }, "example": { "results": [ { "additional_data": { "attached_files": [ { "description": "My passport scan", "doc_type": "passport", "path": "https://drive.google.com/open?id=1EclbGeo8Y3UWg3KSF7ebmwcK7ddLTtC7m3aHZ1qMnjE" } ], "birth_address": "test street 45", "birth_city": "Test city", "birth_country": "NL", "birth_date": "1970-01-01", "birth_state": "Testprovince", "birth_zipcode": "123", "company_registration_city": "Testcity", "company_registration_number": "XX123456789X04", "company_registration_subscription_date": "2000-01-01", "company_url": "https://openprovider.com", "headquarters_address": "Test street 5", "headquarters_city": "Testcity", "headquarters_country": "NL", "headquarters_state": "Testprovince", "headquarters_zipcode": "123", "passport_number": "123456", "social_security_number": "6543210", "trading_name": "Openprovider" }, "address": { "city": "Test city", "country": "NL", "number": "123", "state": "Testprovince", "street": "Test street", "suffix": "A", "zipcode": "1235 XX" }, "comments": "", "comments_last_changed_at": "", "company_name": "", "deleted_at": "0000-00-00 00:00:00", "email": "test@mail.tld", "email_verification_status": "FAI", "extension_additional_data": [ { "data": { "admin_type": "1", "applicant_purpose": "P3", "birth_date": "1970-01-01", "company_name_cyrillic": "Example company", "company_name_latin": "Example company", "company_registration_number": "XX123456789X11", "contact_title": "CEO", "country_of_citizenship": "NL", "customer_uin": "", "ens_auth_id": "", "ens_key": "", "first_name_cyrillic": "Test", "first_name_latin": "Test", "hr_member": "", "industry_class": "19", "is_private_enterpreneur": "", "last_name_cyrillic": "Person", "last_name_latin": "Person", "legal_address_cyrillic": "13245 Country, City, street, 2", "legal_type": "FCORP", "middle_name_cyrillic": "Nikolaevich", "middle_name_latin": "Nikolaevich", "mobile_phone_number": "+7 (123) 456-78-90", "nexus_category": "C31", "org_type": "1", "passport_issue_date": "2009-01-11", "passport_issuer": "Issuer name", "passport_number": "12345678", "passport_series": "1234", "postal_address_cyrillic": "12345 Country, City, street, 1", "social_security_number": "X123455123X", "tax_payer_number": "1345678", "uin": "12345-6", "user_type": "Individual", "vat": "XX123456789X12", "website": "http://example.com", "whois_email": "test@mail.tld" }, "name": "ru" } ], "handle": "XX123456-XX", "id": 123456789, "is_deleted": false, "locale": "nl_NL", "name": { "first_name": "Test", "full_name": "Test Person", "initials": "T P", "last_name": "Person", "prefix": "Mr" }, "phone": { "area_code": "111", "country_code": "+03", "subscriber_number": "123456" }, "reseller_id": 5349, "tags": [ { "key": "customer", "value": "VIP" } ] } ], "total": 999 } }, "customerListCustomersResponseDataResults": { "type": "object", "title": "ListCustomersResponseDataResults", "properties": { "additional_data": { "title": "Collection of data fields that contain additional customer information", "$ref": "#/definitions/customerCustomerAdditionalData" }, "address": { "title": "Customer's address\nAddress", "$ref": "#/definitions/contactAddress" }, "comments": { "type": "string", "title": "Handle's comments\nCustom notes to the specified handle" }, "comments_last_changed_at": { "type": "string", "title": "Date of last comments property update" }, "company_name": { "type": "string", "title": "Customer's company name\nCompany name" }, "deleted_at": { "type": "string", "title": "Date of handle deletion" }, "email": { "type": "string", "title": "Customer's email\nEmail address" }, "email_verification_status": { "type": "string", "title": "Status of email verification process for specified handle" }, "extension_additional_data": { "type": "array", "title": "Collection of data fields that are required for certain TLDs", "items": { "$ref": "#/definitions/customerExtensionAdditionalData" } }, "handle": { "type": "string", "title": "Customer unique identifier or handle, which can be created via CreateCustomer API method" }, "id": { "type": "integer", "format": "int32", "title": "Handle's id\nObject ID" }, "is_deleted": { "type": "boolean", "format": "boolean", "title": "Indicates whether handle is deleted" }, "locale": { "type": "string", "title": "Customer's language" }, "name": { "title": "Customer's full name", "$ref": "#/definitions/contactName" }, "phone": { "title": "Customer's phone\nPhone number", "$ref": "#/definitions/contactPhone" }, "reseller_id": { "type": "integer", "format": "int32", "title": "Your reseller id\nReseller ID" }, "tags": { "type": "array", "title": "Custom tags applied to entity", "items": { "$ref": "#/definitions/customerTags" } } }, "example": { "additional_data": { "attached_files": [ { "description": "My passport scan", "doc_type": "passport", "path": "https://drive.google.com/open?id=1EclbGeo8Y3UWg3KSF7ebmwcK7ddLTtC7m3aHZ1qMnjE" } ], "birth_address": "test street 45", "birth_city": "Test city", "birth_country": "NL", "birth_date": "1970-01-01", "birth_state": "Testprovince", "birth_zipcode": "123", "company_registration_city": "Testcity", "company_registration_number": "XX123456789X04", "company_registration_subscription_date": "2000-01-01", "company_url": "https://openprovider.com", "headquarters_address": "Test street 5", "headquarters_city": "Testcity", "headquarters_country": "NL", "headquarters_state": "Testprovince", "headquarters_zipcode": "123", "passport_number": "123456", "social_security_number": "6543210", "trading_name": "Openprovider" }, "address": { "city": "Test city", "country": "NL", "number": "123", "state": "Testprovince", "street": "Test street", "suffix": "A", "zipcode": "1235 XX" }, "comments": "", "comments_last_changed_at": "", "company_name": "", "deleted_at": "0000-00-00 00:00:00", "email": "test@mail.tld", "email_verification_status": "FAI", "extension_additional_data": [ { "data": { "admin_type": "1", "applicant_purpose": "P3", "birth_date": "1970-01-01", "company_name_cyrillic": "Example company", "company_name_latin": "Example company", "company_registration_number": "XX123456789X11", "contact_title": "CEO", "country_of_citizenship": "NL", "customer_uin": "", "ens_auth_id": "", "ens_key": "", "first_name_cyrillic": "Test", "first_name_latin": "Test", "hr_member": "", "industry_class": "19", "is_private_enterpreneur": "", "last_name_cyrillic": "Person", "last_name_latin": "Person", "legal_address_cyrillic": "13245 Country, City, street, 2", "legal_type": "FCORP", "middle_name_cyrillic": "Nikolaevich", "middle_name_latin": "Nikolaevich", "mobile_phone_number": "+7 (123) 456-78-90", "nexus_category": "C31", "org_type": "1", "passport_issue_date": "2009-01-11", "passport_issuer": "Issuer name", "passport_number": "12345678", "passport_series": "1234", "postal_address_cyrillic": "12345 Country, City, street, 1", "social_security_number": "X123455123X", "tax_payer_number": "1345678", "uin": "12345-6", "user_type": "Individual", "vat": "XX123456789X12", "website": "http://example.com", "whois_email": "test@mail.tld" }, "name": "ru" } ], "handle": "XX123456-XX", "id": 123456789, "is_deleted": false, "locale": "nl_NL", "name": { "first_name": "Test", "full_name": "Test Person", "initials": "T P", "last_name": "Person", "prefix": "Mr" }, "phone": { "area_code": "111", "country_code": "+03", "subscriber_number": "123456" }, "reseller_id": 5349, "tags": [ { "key": "customer", "value": "VIP" } ] } }, "customerTags": { "type": "object", "title": "Tags", "properties": { "key": { "type": "string", "title": "The key of the tag. Allowed values: 'customer'" }, "value": { "type": "string", "title": "The value of the tag" } }, "example": { "key": "customer", "value": "VIP" } }, "customerUpdateCustomerRequest": { "type": "object", "title": "UpdateCustomerRequest", "properties": { "additional_data": { "title": "Collection of data fields that contain additional customer information", "$ref": "#/definitions/customerCustomerAdditionalData" }, "address": { "title": "Customer's address", "$ref": "#/definitions/contactAddress" }, "comments": { "type": "string", "title": "Custom notes to the specified handle" }, "email": { "type": "string", "title": "Customer's email" }, "extension_additional_data": { "type": "array", "title": "Collection of data fields that are required for certain TLDs", "items": { "$ref": "#/definitions/customerExtensionAdditionalData" } }, "fax": { "title": "Customer's fax", "$ref": "#/definitions/customerFax" }, "handle": { "type": "string", "title": "Customer unique identifier or handle, which can be created via CreateCustomer API method" }, "locale": { "type": "string", "title": "Customer's language" }, "phone": { "title": "Customer's phone", "$ref": "#/definitions/contactPhone" }, "tags": { "type": "array", "title": "Custom tags applied to entity", "items": { "$ref": "#/definitions/customerTags" } }, "vat": { "type": "string", "title": "VAT (value-added tax) number of the customer" } }, "example": { "additional_data": { "attached_files": [ { "description": "My passport scan", "doc_type": "passport", "path": "https://drive.google.com/open?id=1EclbGeo8Y3UWg3KSF7ebmwcK7ddLTtC7m3aHZ1qMnjE" } ], "birth_address": "test street 45", "birth_city": "Test city", "birth_country": "NL", "birth_date": "1970-01-01", "birth_state": "Testprovince", "birth_zipcode": "123", "company_registration_city": "Testcity", "company_registration_number": "XX123456789X04", "company_registration_subscription_date": "2000-01-01", "company_url": "https://openprovider.com", "headquarters_address": "Test street 5", "headquarters_city": "Testcity", "headquarters_country": "NL", "headquarters_state": "Testprovince", "headquarters_zipcode": "123", "passport_number": "123456", "social_security_number": "6543210", "trading_name": "Openprovider" }, "address": { "city": "Test city", "country": "NL", "number": "123", "state": "Testprovince", "street": "Test street", "suffix": "A", "zipcode": "1235 XX" }, "comments": "Some comment here", "email": "test@mail.tld", "extension_additional_data": [ { "data": { "admin_type": "1", "applicant_purpose": "P3", "birth_date": "1970-01-01", "company_name_cyrillic": "Example company", "company_name_latin": "Example company", "company_registration_number": "XX123456789X11", "contact_title": "CEO", "country_of_citizenship": "NL", "customer_uin": "", "ens_auth_id": "", "ens_key": "", "first_name_cyrillic": "Test", "first_name_latin": "Test", "hr_member": "", "industry_class": "19", "is_private_enterpreneur": "", "last_name_cyrillic": "Person", "last_name_latin": "Person", "legal_address_cyrillic": "13245 Country, City, street, 2", "legal_type": "FCORP", "middle_name_cyrillic": "Nikolaevich", "middle_name_latin": "Nikolaevich", "mobile_phone_number": "+7 (123) 456-78-90", "nexus_category": "C31", "org_type": "1", "passport_issue_date": "2009-01-11", "passport_issuer": "Issuer name", "passport_number": "12345678", "passport_series": "1234", "postal_address_cyrillic": "12345 Country, City, street, 1", "social_security_number": "X123455123X", "tax_payer_number": "1345678", "uin": "12345-6", "user_type": "Individual", "vat": "XX123456789X12", "website": "http://example.com", "whois_email": "test@mail.tld" }, "name": "ru" } ], "fax": { "area_code": "", "country_code": "", "subscriber_number": "" }, "handle": "XX123456-XX", "locale": "nl_NL", "phone": { "area_code": "111", "country_code": "+03", "subscriber_number": "123456" }, "tags": [ { "key": "customer", "value": "VIP" } ], "vat": "NL123456789X11" } }, "customerUpdateCustomerResponse": { "type": "object", "title": "UpdateCustomerResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/customerUpdateCustomerResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "success": false }, "desc": "" } }, "customerUpdateCustomerResponseData": { "type": "object", "title": "UpdateCustomerResponseData", "properties": { "success": { "type": "boolean", "format": "boolean", "title": "Indicates if operation was successful" } }, "example": { "success": false } }, "domainAbuseDetails": { "type": "object", "title": "AbuseDetails", "properties": { "abuse_id": { "type": "integer", "format": "int32", "title": "The abuse id" }, "is_domain_held": { "type": "boolean", "format": "boolean", "title": "Is domain held" }, "message": { "type": "string", "title": "Message information" } }, "example": { "abuse_id": 0, "is_domain_held": false, "message": "" } }, "domainAdditionalData": { "type": "object", "title": "AdditionalData", "properties": { "abogado_acceptance": { "type": "string", "title": "The abogado acceptance value should be set to 1\nApplicable to: .abogado" }, "admin_sing_pass_id": { "type": "string", "title": "If the admin contact is a natural person located in Singapore, the corresponding Singapore Personal Access ID has to be given. The format of the SingPassID is: X1234567X - where X is an upper case letter at the beginning and end of a seven digit string In case of a foreign organization, it is possible to use the SGNICID: SGNICID-X12-345678 - the SGNICID will look like this example\nApplicable to: .com.sg, .sg" }, "ae_acceptance": { "type": "string", "title": "The ae acceptance value should be set to 1\nApplicable to: .ae" }, "allocation_token": { "type": "string", "title": "The allocation token value cannot be empty\nApplicable to: .abogado, .bayern, .beer, .blog, .boston, .broadway, .casa, .cooking, .cymru, .fashion, .fishing, .fit, .garden, .gop, .horse, .law, .luxe , .miami, .rodeo, .surf, .vip, .vodka, .vuelos, .wales, .wedding, .work, .yoga" }, "auth_code": { "type": "string", "title": "The auth code\nApplicable to: .nz" }, "bank_acceptance": { "type": "string", "title": "The bank acceptance value should be set to 1\nApplicable to: .bank" }, "company_registration_number": { "type": "string", "title": "For companies located in Singapore, the corresponding company registration number has to be given. For Singapore citizens and permanent residents, please provide NRIC or Passport No. For Singapore companies, please provide RCBID as it appears in RCB Certificate. For Singapore societies, please provide RCBID as it appears in ROS Certificate.\nApplicable to: .com.sg, .no, .ro, .sg" }, "coop_acceptance": { "type": "string", "title": "The coop acceptance value should be set to 1\nApplicable to: .coop" }, "customer_uin": { "type": "string", "title": "Identification number of domain owner document that proves his identity (e.g. passport number, number of driving license or else in case if domain owner is a private person; chamber of commerce registration number, taxpayer number or else in case of legal entity)\nApplicable for all TLDs which require documents to complete operation with domain (e.g. .bg, .cn etc.)" }, "customer_uin_doc_type": { "title": "Type of the domain owner document used to prove his identity (e.g. passport, driving license or else in case if domain owner is a private person; chamber of commerce extract, business certificate or else in case of legal entity)\nApplicable for all TLDs which require documents to complete operation with domain (e.g. .bg, .cn etc.)", "$ref": "#/definitions/domainUINDocumentType" }, "domain_name_variants": { "type": "array", "title": "The domain name variants should be an array of strings, representing appropriate names\nApplicable to: .barcelona, .cat", "items": { "type": "string" } }, "eligibility_type": { "type": "string", "title": "The eligibility type value should be one from the options list\nApplicable to: .com.au, .id.au, .net.au, .org.au" }, "eligibility_type_relationship": { "type": "string", "title": "The eligibility type relationship indicates the relationship between the Eligibility Type (e.g. business name) and domain name\nApplicable to: .com.au, .id.au, .net.au, .org.au" }, "es_annex_acceptance": { "type": "string", "title": "Applicable to: .es" }, "ftld_token": { "type": "string", "title": "The fTLD token required for registration and data in owner handle must be exactly the same as in token. You need to request token from registry\nApplicable to: .bank, .insurance" }, "gay_donation_acceptance": { "type": "string", "title": "The .gay donation acceptance value should be set to 1\nApplicable to: .gay" }, "gay_rights_protection_acceptance": { "type": "string", "title": "The .gay rights protection acceptance value should be set to 1\nApplicable to: .gay" }, "id_number": { "type": "string", "title": "The identification number\nApplicable to: .com.au, .net.au, .org.au" }, "id_type": { "type": "string", "title": "The id type\nApplicable to: .com.au, .net.au, .org.au" }, "idn_script": { "type": "string", "title": "The IDN script states what language or character set the domain name is in\nApplicable to: .accountant, .actor, .ae.org, .airforce, .army, .art, .attorney, .auction, .band, .bar, .best, .bid, .br.com, .buzz, .ceo, .club, .cn.com, .college, .com, .com.de, .com.se, .consulting, .cricket, .dance, .date, .de.com, .degree, .democrat, .dentist, .design, .download, .engineer, .eu.com, .eus, .faith, .feedback, .fm, .forsale, .frl, .fun, .futbol, .gal, .gb.net, .gives, .gr.com, .haus, .hiv, .host, .immobilien, .in.net, .info, .ink, .jetzt, .jp.net, .jpn.com, .kaufen, .kyoto, .lawyer, .loan, .love, .market, .me, .mex.com, .moda, .moe, .mortgage, .navy, .net, .ninja, .nrw, .nyc, .online, .ooo, .org, .osaka, .party, .press, .protection, .pub, .pw, .qpon, .quebec, .racing, .radio.am, .radio.fm, .realty, .rehab, .rent, .republican, .rest, .review, .reviews, .rip, .rocks, .ru.com, .sa.com, .science, .scot, .se.net, .security, .shop, .site, .social, .software, .space, .store, .tech, .theatre, .tickets, .top, .trade, .uk.com, .uk.net, .uno, .us.com, .us.org, .vet, .webcam, .website, .whoswho, .wiki, .win, .xn--4gbrim, .xn--55qx5d, .xn--5tzm5g, .xn--80adxhks, .xn--80asehdb, .xn--80aswg, .xn--c1avg, .xn--czru2d, .xn--i1b6b1a6a2e, .xn--io0a7i, .xn--mk1bu44c, .xn--ngbc5azd, .xn--nqv7f, .xn--t60b56a, .xn--tckwe, .xyz, .za.com" }, "insurance_acceptance": { "type": "string", "title": "The insurance acceptance value should be set to 1\nApplicable to: .insurance" }, "intended_use": { "type": "string", "title": "The intended use value should contain information on how the domain name will be used\nApplicable to: .barcelona, .cat, .madrid, .radio, .sport, .swiss" }, "law_acceptance": { "type": "string", "title": "The law acceptance value should be set to 1\nApplicable to: .law" }, "legal_type": { "type": "string", "title": "The legal type\nApplicable to: .ca" }, "maintainer": { "type": "string", "title": "The maintainer value should be a string, specifying maintainer information. Maximum length 128 characters.\nApplicable to: .cat" }, "membership_id": { "type": "string", "title": "The membership id value cannot be empty\nApplicable to: .lotto, .xxx" }, "mobile_phone_number_verification": { "type": "string", "title": "The mobile phone verification via sms\nApplicable to: .ru, .su, .xn--p1ai" }, "ngo_ong_eligibility_acceptance": { "type": "string", "title": "The ngo, ong eligibility acceptance value should be set to 1\nApplicable to: .ngo, .ong" }, "ngo_ong_policy_acceptance": { "type": "string", "title": "The ngo, ong policy acceptance value should be set to 1\nApplicable to: .ngo, .ong" }, "passport_number": { "type": "string", "title": "The passport number. Required in case if domain requester is a private individual\nApplicable to: .co.hu, .hu" }, "rurf_blocked_domains": { "type": "string", "title": "The check domain name in blocked list of registry\nApplicable to: .ru, .xn--p1ai" }, "self_service": { "type": "string", "title": "The self service\nApplicable to: .feedback" }, "trademark": { "type": "string", "title": "The trademark\nApplicable to: .ca" }, "trademark_id": { "type": "string", "title": "The local trademark ID required for Local Trademark phase\nApplicable to: .barcelona" }, "travel_acceptance": { "type": "string", "title": "The .travel registration requires acknowledgement of the registrant that he is part of the travel industry\nApplicable to: .travel" }, "vat": { "type": "string", "title": "The vat number. Required in case if domain requester is a legal entity\nApplicable to: .co.hu, .hu" }, "verification_code": { "type": "string", "title": "The verification code value cannot be empty\nApplicable to: .lotto" }, "vote_acceptance": { "type": "string", "title": "The vote acceptance value should be set to 1\nApplicable to: .vote" }, "voto_acceptance": { "type": "string", "title": "The voto acceptance value should be set to 1\nApplicable to: .voto" } }, "example": { "abogado_acceptance": "", "admin_sing_pass_id": "", "ae_acceptance": "1", "allocation_token": "", "auth_code": "", "bank_acceptance": "", "company_registration_number": "XX123456789X01", "coop_acceptance": "1", "customer_uin": "374892173498127349", "customer_uin_doc_type": { "description": "Singapore Personal Access ID", "doc_type": "singpass" }, "domain_name_variants": [ "xn--\u0434\u043e\u043c\u0435\u043d.cat" ], "eligibility_type": "", "eligibility_type_relationship": "", "es_annex_acceptance": "1", "ftld_token": "", "gay_donation_acceptance": "1", "gay_rights_protection_acceptance": "1", "id_number": "123456789X", "id_type": "", "idn_script": "SPA", "insurance_acceptance": "", "intended_use": "generic", "law_acceptance": "", "legal_type": "Individual", "maintainer": "", "membership_id": "A", "mobile_phone_number_verification": "", "ngo_ong_eligibility_acceptance": "", "ngo_ong_policy_acceptance": "", "passport_number": "X123456", "rurf_blocked_domains": "", "self_service": "1", "trademark": "1", "trademark_id": "", "travel_acceptance": "1", "vat": "11843009X", "verification_code": "", "vote_acceptance": "", "voto_acceptance": "" } }, "domainApiHistory": { "type": "object", "title": "ApiHistory", "properties": { "cmd": { "type": "string", "title": "Command name" }, "created_at": { "type": "string", "title": "Domain creation date" }, "domain_id": { "type": "integer", "format": "int32", "title": "The domain id" }, "in": { "type": "string", "title": "Request" }, "out": { "type": "string", "title": "Response" } }, "example": { "cmd": "deleteDomainRequest", "created_at": "2018-09-05 13:58:55", "domain_id": 12345678, "in": "", "out": "" } }, "domainApproveTransferRequest": { "type": "object", "title": "ApproveTransferRequest", "properties": { "approve": { "type": "integer", "format": "int32", "title": "The approve" }, "auth_code": { "type": "string", "title": "Authorization code" }, "domain": { "title": "Domain name and extension", "$ref": "#/definitions/domainDomain" }, "id": { "type": "integer", "format": "int32", "title": "Domain id number" }, "registrar_tag": { "type": "string", "title": "Registrar tag for transfer of .uk domains" } }, "example": { "approve": 1, "auth_code": "", "domain": { "extension": "london", "name": "test4" }, "id": 0, "registrar_tag": "REGISTRAR-TAG" } }, "domainCheckAdditionalData": { "type": "object", "title": "CheckAdditionalData", "properties": { "idn_script": { "type": "string", "title": "The idn script states what language or character set the domain name is in\nApplicable to: .actor, .ae.org, .airforce, .army, .art, .attorney, .auction, .band, .bar, .best, .br.com, .ceo, .cn.com, .college, .com, .com.de, .com.se, .consulting, .dance, .de.com, .degree, .democrat, .dentist, .design, .engineer, .eu.com, .eus, .feedback, .fm, .forsale, .frl, .fun, .futbol, .gal, .gb.net, .gives, .gr.com, .haus, .hiv, .host, .immobilien, .in.net, .info, .ink, .jp.net, .jpn.com, .kaufen, .kyoto, .lawyer, .love, .market, .me, .mex.com, .moda, .mortgage, .navy, .net, .ninja, .nrw, .online, .ooo, .org, .press, .protection, .pub, .pw, .quebec, .radio.am, .radio.fm, .realty, .rehab, .rent, .republican, .rest, .reviews, .rip, .rocks, .ru.com, .sa.com, .scot, .se.net, .security, .site, .social, .software, .space, .store, .tech, .theatre, .tickets, .top, .uk.com, .uk.net, .us.com, .us.org, .vet, .website, .wiki, .xn--4gbrim, .xn--55qx5d, .xn--5tzm5g, .xn--80asehdb, .xn--80aswg, .xn--c1avg, .xn--czru2d, .xn--i1b6b1a6a2e, .xn--io0a7i, .xn--mk1bu44c, .xn--ngbc5azd, .xn--nqv7f, .xn--t60b56a, .xn--tckwe, .xyz, .za.com" } }, "example": { "idn_script": "cyrl" } }, "domainCheckDomainRequest": { "type": "object", "title": "CheckDomainRequest", "properties": { "additional_data": { "title": "Additional domain data", "$ref": "#/definitions/domainCheckAdditionalData" }, "application_mode": { "description": "When new gTLD is started it gets through several phases before it becomes available for registration to everybody (General availability or GA). There are several phases before GA when it is still possible to apply for a domain, but with some restrictions.", "type": "string" }, "domains": { "type": "array", "title": "Array of domains to check", "items": { "$ref": "#/definitions/domainDomain" } }, "provider": { "type": "string", "title": "Indicates what provider should be chosen for domain operation" }, "with_price": { "type": "boolean", "format": "boolean", "title": "Indicate whether to include the domain price with domain availability" } }, "example": { "additional_data": { "idn_script": "cyrl" }, "application_mode": "preregistration", "domains": [ { "extension": "london", "name": "test4" } ], "provider": "SEDO", "with_price": false } }, "domainCheckDomainResponse": { "type": "object", "title": "CheckDomainResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/domainCheckDomainResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates that the Openprovider system is temporarily unavailable because of maintenance" }, "warnings": { "type": "array", "title": "Contains warning responses if any", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "results": [ { "claim_key": "", "domain": "example.com", "is_premium": false, "premium": { "currency": "USD", "price": { "create": 0 } }, "price": { "product": { "currency": "USD", "price": 8.06 }, "reseller": { "currency": "USD", "price": 8.06 } }, "reason": "Domain exists", "status": "active", "whois": "" } ] }, "desc": "" } }, "domainCheckDomainResponseData": { "type": "object", "title": "CheckDomainResponseData", "properties": { "results": { "type": "array", "title": "Array of results", "items": { "$ref": "#/definitions/domainCheckDomainResult" } } }, "example": { "results": [ { "claim_key": "", "domain": "example.com", "is_premium": false, "premium": { "currency": "USD", "price": { "create": 0 } }, "price": { "product": { "currency": "USD", "price": 8.06 }, "reseller": { "currency": "USD", "price": 8.06 } }, "reason": "Domain exists", "status": "active", "whois": "" } ] } }, "domainCheckDomainResult": { "type": "object", "title": "CheckDomainResult", "properties": { "claim_key": { "type": "string", "title": "The claim key" }, "domain": { "type": "string", "title": "Domain full name" }, "is_premium": { "type": "boolean", "format": "boolean", "title": "Indicates that a domain has a premium price" }, "premium": { "title": "Domain premium price", "$ref": "#/definitions/domainPremiumPrice" }, "price": { "title": "Price for non-premium domain", "$ref": "#/definitions/domainPriceGroup" }, "reason": { "type": "string", "title": "Reason for returned availability status" }, "status": { "type": "string", "title": "Domain status (free or active)" }, "whois": { "type": "string", "title": "Domain whois data" } }, "example": { "claim_key": "", "domain": "example.com", "is_premium": false, "premium": { "currency": "USD", "price": { "create": 0 } }, "price": { "product": { "currency": "USD", "price": 8.06 }, "reseller": { "currency": "USD", "price": 8.06 } }, "reason": "Domain exists", "status": "active", "whois": "" } }, "domainCreateDomainRequest": { "type": "object", "title": "CreateDomainRequest", "properties": { "accept_eap_fee": { "type": "number", "format": "double", "title": "Required for certain pre-pregistrations" }, "accept_premium_fee": { "type": "number", "format": "double", "title": "Premium price fee acceptance" }, "additional_data": { "title": "Additional domain data", "$ref": "#/definitions/domainAdditionalData" }, "admin_handle": { "type": "string", "title": "Administrative contact handle" }, "application_mode": { "description": "When new gTLD is started it gets through several phases before it becomes available for registration to everybody (General availability or GA). There are several phases before GA when it is still possible to apply for a domain, but with some restrictions.", "type": "string" }, "application_notice_id": { "type": "string", "title": "The application notice id" }, "application_smd": { "type": "string", "title": "The application smd" }, "auth_code": { "type": "string", "title": "Authorization code" }, "autorenew": { "type": "string", "title": "Desired autorenew value: off, on, or default" }, "billing_handle": { "type": "string", "title": "Billing contact handle" }, "comments": { "type": "string", "title": "Domain comments" }, "dnssec_keys": { "type": "array", "title": "Array containing DNSSEC key information", "items": { "$ref": "#/definitions/domainDnssecKey" } }, "domain": { "title": "Domain name and extension", "$ref": "#/definitions/domainDomain" }, "is_dnssec_enabled": { "type": "boolean", "format": "boolean", "title": "Enables or disables DNSSEC on domain" }, "is_easy_dmarc_enabled": { "type": "boolean", "format": "boolean", "title": "Enables or disables easy dmarc protection for this domain", "default": false }, "is_private_whois_enabled": { "type": "boolean", "format": "boolean", "title": "Enables or disables whois privacy protection (WPP) on domain" }, "is_sectigo_dns_enabled": { "type": "boolean", "format": "boolean", "title": "Enables or disables premium Sectigo DNS on domain" }, "is_spamexperts_enabled": { "type": "boolean", "format": "boolean", "title": "Enable Spam Experts spam protetion for domain" }, "name_servers": { "type": "array", "title": "Array containing name server information", "items": { "$ref": "#/definitions/domainNameserver" } }, "ns_group": { "type": "string", "title": "Name of nameserver group" }, "ns_template_id": { "type": "integer", "format": "int32", "title": "Id of nameserver template" }, "ns_template_name": { "type": "string", "title": "Name of nameserver template" }, "owner_handle": { "type": "string", "title": "Owner contact handle" }, "period": { "type": "integer", "format": "int32", "title": "Domain registration period in years unless otherwise specified" }, "promo_code": { "type": "string", "title": "Promo code to apply to operation" }, "provider": { "type": "string", "title": "Indicates what provider should be chosen for domain operation" }, "reseller_handle": { "type": "string", "title": "Reseller handle" }, "tech_handle": { "type": "string", "title": "Tech contact handle" }, "unit": { "type": "string", "title": "Unit of time to register domain, yearly, quarterly, or monthly" }, "use_domicile": { "type": "boolean", "format": "boolean", "title": "Use of domicile or trustee address for TLDs that require local presence" } }, "example": { "accept_eap_fee": 0, "accept_premium_fee": 0, "additional_data": { "abogado_acceptance": "", "admin_sing_pass_id": "", "ae_acceptance": "1", "allocation_token": "", "auth_code": "", "bank_acceptance": "", "company_registration_number": "XX123456789X01", "coop_acceptance": "1", "customer_uin": "374892173498127349", "customer_uin_doc_type": { "description": "Singapore Personal Access ID", "doc_type": "singpass" }, "domain_name_variants": [ "xn--\u0434\u043e\u043c\u0435\u043d.cat" ], "eligibility_type": "", "eligibility_type_relationship": "", "es_annex_acceptance": "1", "ftld_token": "", "gay_donation_acceptance": "1", "gay_rights_protection_acceptance": "1", "id_number": "123456789X", "id_type": "", "idn_script": "SPA", "insurance_acceptance": "", "intended_use": "generic", "law_acceptance": "", "legal_type": "Individual", "maintainer": "", "membership_id": "A", "mobile_phone_number_verification": "", "ngo_ong_eligibility_acceptance": "", "ngo_ong_policy_acceptance": "", "passport_number": "X123456", "rurf_blocked_domains": "", "self_service": "1", "trademark": "1", "trademark_id": "", "travel_acceptance": "1", "vat": "11843009X", "verification_code": "", "vote_acceptance": "", "voto_acceptance": "" }, "admin_handle": "XX123456-XX", "application_mode": "preregistration", "application_notice_id": "983bdc1a0000100000188801724", "application_smd": "", "auth_code": "", "autorenew": "on", "billing_handle": "XX123456-XX", "comments": "any comment here", "dnssec_keys": [ { "alg": 8, "flags": 257, "protocol": 3, "pub_key": "WSgigdu8545g96", "readonly": 1 } ], "domain": { "extension": "london", "name": "test4" }, "is_dnssec_enabled": false, "is_easy_dmarc_enabled": false, "is_private_whois_enabled": false, "is_sectigo_dns_enabled": false, "is_spamexperts_enabled": false, "name_servers": [ { "ip": "12.3.123.121", "ip6": "1s23:123:123:f", "name": "ns1.example.com", "seq_nr": 1 } ], "ns_group": "example", "ns_template_id": 14977, "ns_template_name": "Default", "owner_handle": "XX123456-XX", "period": 1, "promo_code": "PROMOCODE", "provider": "SEDO", "reseller_handle": "XX123456-XX", "tech_handle": "XX123456-XX", "unit": "y", "use_domicile": false } }, "domainCreateDomainResponse": { "type": "object", "title": "CreateDomainResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/domainCreateDomainResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates that the Openprovider system is temporarily unavailable because of maintenance" }, "warnings": { "type": "array", "title": "Contains warning responses if any", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "activation_date": "2019-04-29 17:15:19", "additional_data": { "abogado_acceptance": "", "admin_sing_pass_id": "", "ae_acceptance": "1", "allocation_token": "", "auth_code": "", "bank_acceptance": "", "company_registration_number": "XX123456789X01", "coop_acceptance": "1", "customer_uin": "374892173498127349", "customer_uin_doc_type": { "description": "Singapore Personal Access ID", "doc_type": "singpass" }, "domain_name_variants": [ "xn--\u0434\u043e\u043c\u0435\u043d.cat" ], "eligibility_type": "", "eligibility_type_relationship": "", "es_annex_acceptance": "1", "ftld_token": "", "gay_donation_acceptance": "1", "gay_rights_protection_acceptance": "1", "id_number": "123456789X", "id_type": "", "idn_script": "SPA", "insurance_acceptance": "", "intended_use": "generic", "law_acceptance": "", "legal_type": "Individual", "maintainer": "", "membership_id": "A", "mobile_phone_number_verification": "", "ngo_ong_eligibility_acceptance": "", "ngo_ong_policy_acceptance": "", "passport_number": "X123456", "rurf_blocked_domains": "", "self_service": "1", "trademark": "1", "trademark_id": "", "travel_acceptance": "1", "vat": "11843009X", "verification_code": "", "vote_acceptance": "", "voto_acceptance": "" }, "auth_code": "12345678", "expiration_date": "2020-04-29 17:15:19", "id": 123456789, "renewal_date": "2020-04-29 17:15:19", "status": "ACT" }, "desc": "" } }, "domainCreateDomainResponseData": { "type": "object", "title": "CreateDomainResponseData", "properties": { "activation_date": { "type": "string", "title": "Domain activation date" }, "additional_data": { "title": "Additional domain data", "$ref": "#/definitions/domainAdditionalData" }, "auth_code": { "type": "string", "title": "Authorization code" }, "expiration_date": { "type": "string", "title": "Domain expiration date" }, "id": { "type": "integer", "format": "int32", "title": "Domain id number" }, "renewal_date": { "type": "string", "title": "Date on which domain will be renewed" }, "status": { "type": "string", "title": "Domain status" } }, "example": { "activation_date": "2019-04-29 17:15:19", "additional_data": { "abogado_acceptance": "", "admin_sing_pass_id": "", "ae_acceptance": "1", "allocation_token": "", "auth_code": "", "bank_acceptance": "", "company_registration_number": "XX123456789X01", "coop_acceptance": "1", "customer_uin": "374892173498127349", "customer_uin_doc_type": { "description": "Singapore Personal Access ID", "doc_type": "singpass" }, "domain_name_variants": [ "xn--\u0434\u043e\u043c\u0435\u043d.cat" ], "eligibility_type": "", "eligibility_type_relationship": "", "es_annex_acceptance": "1", "ftld_token": "", "gay_donation_acceptance": "1", "gay_rights_protection_acceptance": "1", "id_number": "123456789X", "id_type": "", "idn_script": "SPA", "insurance_acceptance": "", "intended_use": "generic", "law_acceptance": "", "legal_type": "Individual", "maintainer": "", "membership_id": "A", "mobile_phone_number_verification": "", "ngo_ong_eligibility_acceptance": "", "ngo_ong_policy_acceptance": "", "passport_number": "X123456", "rurf_blocked_domains": "", "self_service": "1", "trademark": "1", "trademark_id": "", "travel_acceptance": "1", "vat": "11843009X", "verification_code": "", "vote_acceptance": "", "voto_acceptance": "" }, "auth_code": "12345678", "expiration_date": "2020-04-29 17:15:19", "id": 123456789, "renewal_date": "2020-04-29 17:15:19", "status": "ACT" } }, "domainDeleteDomainResponse": { "type": "object", "title": "DeleteDomainResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/domainDeleteDomainResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates that the Openprovider system is temporarily unavailable because of maintenance" }, "warnings": { "type": "array", "title": "Contains warning responses if any", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "status": "ACT" }, "desc": "" } }, "domainDeleteDomainResponseData": { "type": "object", "title": "DeleteDomainResponseData", "properties": { "status": { "type": "string", "title": "Domain status" } }, "example": { "status": "ACT" } }, "domainDnssecKey": { "type": "object", "title": "DnssecKey", "properties": { "alg": { "type": "integer", "format": "int32", "title": "Algorithm" }, "flags": { "type": "integer", "format": "int32", "title": "DNSSEC flags" }, "protocol": { "type": "integer", "format": "int32", "title": "The protocol" }, "pub_key": { "type": "string", "title": "Public key" }, "readonly": { "type": "integer", "format": "int32", "title": "Read only flag" } }, "example": { "alg": 8, "flags": 257, "protocol": 3, "pub_key": "WSgigdu8545g96", "readonly": 1 } }, "domainDomain": { "type": "object", "title": "Domain", "properties": { "extension": { "type": "string", "title": "Domain extension" }, "name": { "type": "string", "title": "Domain name without extension" } }, "example": { "extension": "london", "name": "test4" } }, "domainGetDomainResponse": { "type": "object", "title": "GetDomainResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/domainGetDomainResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates that the Openprovider system is temporarily unavailable because of maintenance" }, "warnings": { "type": "array", "title": "Contains warning responses if any", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "abuse_details": { "abuse_id": 0, "is_domain_held": false, "message": "" }, "active_date": "2019-01-27 0:55:17", "additional_data": { "abogado_acceptance": "", "admin_sing_pass_id": "", "ae_acceptance": "1", "allocation_token": "", "auth_code": "", "bank_acceptance": "", "company_registration_number": "XX123456789X01", "coop_acceptance": "1", "customer_uin": "374892173498127349", "customer_uin_doc_type": { "description": "Singapore Personal Access ID", "doc_type": "singpass" }, "domain_name_variants": [ "xn--\u0434\u043e\u043c\u0435\u043d.cat" ], "eligibility_type": "", "eligibility_type_relationship": "", "es_annex_acceptance": "1", "ftld_token": "", "gay_donation_acceptance": "1", "gay_rights_protection_acceptance": "1", "id_number": "123456789X", "id_type": "", "idn_script": "SPA", "insurance_acceptance": "", "intended_use": "generic", "law_acceptance": "", "legal_type": "Individual", "maintainer": "", "membership_id": "A", "mobile_phone_number_verification": "", "ngo_ong_eligibility_acceptance": "", "ngo_ong_policy_acceptance": "", "passport_number": "X123456", "rurf_blocked_domains": "", "self_service": "1", "trademark": "1", "trademark_id": "", "travel_acceptance": "1", "vat": "11843009X", "verification_code": "", "vote_acceptance": "", "voto_acceptance": "" }, "admin_handle": "XX123456-XX", "api_history": [ { "cmd": "deleteDomainRequest", "created_at": "2018-09-05 13:58:55", "domain_id": 12345678, "in": "", "out": "" } ], "application_id": "A743C511084404F31B15757DC979A1412-ABI", "application_mode": "", "application_mode_expiration_date": "", "application_mode_title": "", "application_notice_id": "983bdc1a0000100000188801724", "application_smd": "", "auth_code": "1a2b3c4d5e6f", "autorenew": "default", "billing_handle": "XX123456-XX", "can_renew": false, "comments": "", "comments_last_changed_at": "2018-01-30 14:37:49", "creation_date": "2013-07-04 17:14:44", "delete_status": "quarantine", "deleted_at": "0000-00-00 00:00:00", "dnssec": "unsigned", "dnssec_keys": [ { "alg": 8, "flags": 257, "protocol": 3, "pub_key": "WSgigdu8545g96", "readonly": 1 } ], "domain": { "extension": "london", "name": "test4" }, "expiration_date": "2014-07-04 17:14:44", "hard_quarantine_expiry_date": "", "has_active_sectigo_zone": false, "has_history": false, "history": [ { "contents": "Domain: test-example.tldAction: registration succeededStatus: ACTOrder date: 2018-01-30Activation date: 2018-01-30Renewal date: 2019-01-27Expiration date: 2019-01-29Comments: registration of this domain has succeeded Nameserver addresses are automatically resolved by system; Nameserver IP addresses are only saved for glue records", "domain": "example.com", "ip": "12.123.3.12", "subject": "Sent status e-mail to admin@someemail.nl", "timestamp": "2018-01-30T14:38:45+01:00", "type": "I" } ], "id": 123456789, "internal_auth_code": "1a2b3c4d5e6f", "is_abusive": false, "is_client_hold_enabled": "no", "is_deleted": false, "is_dnssec_enabled": false, "is_hosted_whois": false, "is_lockable": false, "is_locked": false, "is_parked": false, "is_premium": false, "is_private_whois_allowed": false, "is_private_whois_enabled": false, "is_sectigo_dns_enabled": false, "is_spamexperts_enabled": false, "last_changed": "2014-04-18 7:13:05", "modify_owner_allowed": false, "name_servers": [ { "ip": "12.3.123.121", "ip6": "1s23:123:123:f", "name": "ns1.example.com", "seq_nr": 1 } ], "ns_group": "dns-openprovider", "ns_template_id": 0, "ns_template_name": "", "nsgroup_id": 1, "order_date": "2013-07-04 17:14:44", "owner": { "company_name": "Example company", "full_name": "Test Van Person" }, "owner_company_name": "Company Name", "owner_handle": "XX123456-XX", "quarantine_expiration_date": "", "registry_expiration_date": "2020-01-29 0:00:00", "registry_statuses": { "client_hold": { "is_changeable": false, "value": 0 }, "client_transfer_prohibited": { "is_changeable": false, "value": 0 } }, "renew": 2, "renewal_date": "2022-01-01 0:00:00", "reseller_handle": "XX123456-XX", "reseller_id": 12345, "restorable_until": "", "scheduled_at": "", "scheduled_from": "", "soft_quarantine_expiry_date": "", "status": "PRE", "tech_handle": "XX123456-XX", "trade_allowed": false, "trade_auth_code_required": "no", "transfer_auth_code_required": "yes", "transfer_cancel_supported": false, "type": "NEW", "unit": "y", "use_domicile": false, "verification_email_exp_date": "0000-00-00 00:00:00", "verification_email_name": "test@example.com", "verification_email_status": "not verified", "verification_email_status_description": "-", "whois_privacy_data": { "expiration_date": "2020-04-29 17:15:19" } }, "desc": "" } }, "domainGetDomainResponseData": { "type": "object", "title": "GetDomainResponseData", "properties": { "abuse_details": { "title": "The abuse details", "$ref": "#/definitions/domainAbuseDetails" }, "active_date": { "type": "string", "title": "Domain active date" }, "additional_data": { "title": "Additional domain data", "$ref": "#/definitions/domainAdditionalData" }, "admin_handle": { "type": "string", "title": "Administrative contact handle" }, "api_history": { "type": "array", "title": "API calls history related to specified domain", "items": { "$ref": "#/definitions/domainApiHistory" } }, "application_id": { "type": "string", "title": "The application id" }, "application_mode": { "description": "When new gTLD is started it gets through several phases before it becomes available for registration to everybody (General availability or GA). There are several phases before GA when it is still possible to apply for a domain, but with some restrictions.", "type": "string" }, "application_mode_expiration_date": { "type": "string", "title": "The application mode expiration date" }, "application_mode_title": { "type": "string", "title": "The application mode title" }, "application_notice_id": { "type": "string", "title": "The application notice id" }, "application_smd": { "type": "string", "title": "The application smd" }, "auth_code": { "type": "string", "title": "Authorization code" }, "autorenew": { "type": "string", "title": "Desired autorenew value: off, on, or default" }, "billing_handle": { "type": "string", "title": "Billing contact handle" }, "can_renew": { "type": "boolean", "format": "boolean", "title": "Indicates if domain can be renewed" }, "comments": { "type": "string", "title": "Domain comments" }, "comments_last_changed_at": { "type": "string", "title": "Timestamp indicating when domain comments were last edited" }, "creation_date": { "type": "string", "title": "Domain creation date" }, "delete_status": { "type": "string", "title": "Deletion status" }, "deleted_at": { "type": "string", "title": "Date the domain has been deleted" }, "dnssec": { "description": "Indicates, if DNSSEC is enabled. Possible values: signedDelegation, unsigned.", "type": "string" }, "dnssec_keys": { "type": "array", "title": "Array containing DNSSEC key information", "items": { "$ref": "#/definitions/domainDnssecKey" } }, "domain": { "title": "Domain name and extension", "$ref": "#/definitions/domainDomain" }, "expiration_date": { "type": "string", "title": "Domain expiration date" }, "hard_quarantine_expiry_date": { "type": "string", "title": "Date of hard quarantine expiration" }, "has_active_sectigo_zone": { "type": "boolean", "format": "boolean", "title": "Indicates if domain has an active dns zone in Sectigo" }, "has_history": { "type": "boolean", "format": "boolean", "title": "Indicates if domain has history data" }, "history": { "type": "array", "title": "Domain mutations history", "items": { "$ref": "#/definitions/domainHistory" } }, "id": { "type": "integer", "format": "int32", "title": "Domain id number" }, "internal_auth_code": { "type": "string", "title": "Authcode for internal transfers" }, "is_abusive": { "type": "boolean", "format": "boolean", "title": "Indicates if domain is abusive" }, "is_client_hold_enabled": { "type": "string", "title": "Indicates if domain is in clientHold EPP status" }, "is_deleted": { "type": "boolean", "format": "boolean", "title": "Indicates whether object is deleted" }, "is_dnssec_enabled": { "type": "boolean", "format": "boolean", "title": "Enables or disables DNSSEC on domain" }, "is_hosted_whois": { "type": "boolean", "format": "boolean", "title": "Indicates, if whois data is hosted at Openprovider" }, "is_lockable": { "type": "boolean", "format": "boolean", "title": "Indicates, if domain can be transfer locked" }, "is_locked": { "type": "boolean", "format": "boolean", "title": "Indicates that domain is locked for transfer" }, "is_parked": { "type": "boolean", "format": "boolean", "title": "Indicates whether object is parked" }, "is_premium": { "type": "boolean", "format": "boolean", "title": "Indicates that a domain has a premium price" }, "is_private_whois_allowed": { "type": "boolean", "format": "boolean", "title": "Indicates, if whois privacy protection allowed" }, "is_private_whois_enabled": { "type": "boolean", "format": "boolean", "title": "Enables or disables whois privacy protection (WPP) on domain" }, "is_sectigo_dns_enabled": { "type": "boolean", "format": "boolean", "title": "Indicates if domain has an active dns zone in Sectigo" }, "is_spamexperts_enabled": { "type": "boolean", "format": "boolean", "title": "Enable Spam Experts spam protetion for domain" }, "last_changed": { "type": "string", "title": "Date of last domain update" }, "modify_owner_allowed": { "type": "boolean", "format": "boolean", "title": "Indicates, if owner modification allowed" }, "name_servers": { "type": "array", "title": "Array containing name server information", "items": { "$ref": "#/definitions/domainNameserver" } }, "ns_group": { "type": "string", "title": "Name of nameserver group" }, "ns_template_id": { "type": "integer", "format": "int32", "title": "Id of nameserver template" }, "ns_template_name": { "type": "string", "title": "Name of nameserver template" }, "nsgroup_id": { "type": "integer", "format": "int32", "title": "Id of nameserver group" }, "order_date": { "type": "string", "title": "Domain order date" }, "owner": { "title": "Domain owner details", "$ref": "#/definitions/domainOwner" }, "owner_company_name": { "type": "string", "title": "Domain owner company name" }, "owner_handle": { "type": "string", "title": "Owner contact handle" }, "quarantine_expiration_date": { "type": "string", "title": "Quarantine expiration date" }, "registry_expiration_date": { "type": "string", "title": "Domain expiration date in the registry" }, "registry_statuses": { "title": "Array of registry statuses", "$ref": "#/definitions/domainRegistryStatuses" }, "renew": { "type": "integer", "format": "int32", "title": "The renew" }, "renewal_date": { "type": "string", "title": "Date on which domain will be renewed" }, "reseller_handle": { "type": "string", "title": "Reseller handle" }, "reseller_id": { "type": "integer", "format": "int32", "title": "Reseller id" }, "restorable_until": { "type": "string", "title": "Date until which domain can be restored" }, "scheduled_at": { "type": "string", "title": "The scheduled at" }, "scheduled_from": { "type": "string", "title": "The scheduled from" }, "soft_quarantine_expiry_date": { "type": "string", "title": "Date of soft quarantine expiration" }, "status": { "type": "string", "title": "Domain status" }, "tech_handle": { "type": "string", "title": "Tech contact handle" }, "trade_allowed": { "type": "boolean", "format": "boolean", "title": "Indicates if trade is allowed" }, "trade_auth_code_required": { "type": "string", "title": "Indicates if authcode required for trade" }, "transfer_auth_code_required": { "type": "string", "title": "Indicates if authcode required for transfer" }, "transfer_cancel_supported": { "type": "boolean", "format": "boolean", "title": "Indicates if transfer cancellation supported" }, "type": { "type": "string", "title": "Domain type" }, "unit": { "type": "string", "title": "Unit of time to register domain, yearly, quarterly, or monthly" }, "use_domicile": { "type": "boolean", "format": "boolean", "title": "Use of domicile or trustee address for TLDs that require local presence" }, "verification_email_exp_date": { "type": "string", "title": "The verification email exp date" }, "verification_email_name": { "type": "string", "title": "The verification email name" }, "verification_email_status": { "type": "string", "title": "The verification email status" }, "verification_email_status_description": { "type": "string", "title": "The verification email status description" }, "whois_privacy_data": { "title": "The whois privacy data", "$ref": "#/definitions/domainWhoisPrivacyData" } }, "example": { "abuse_details": { "abuse_id": 0, "is_domain_held": false, "message": "" }, "active_date": "2019-01-27 0:55:17", "additional_data": { "abogado_acceptance": "", "admin_sing_pass_id": "", "ae_acceptance": "1", "allocation_token": "", "auth_code": "", "bank_acceptance": "", "company_registration_number": "XX123456789X01", "coop_acceptance": "1", "customer_uin": "374892173498127349", "customer_uin_doc_type": { "description": "Singapore Personal Access ID", "doc_type": "singpass" }, "domain_name_variants": [ "xn--\u0434\u043e\u043c\u0435\u043d.cat" ], "eligibility_type": "", "eligibility_type_relationship": "", "es_annex_acceptance": "1", "ftld_token": "", "gay_donation_acceptance": "1", "gay_rights_protection_acceptance": "1", "id_number": "123456789X", "id_type": "", "idn_script": "SPA", "insurance_acceptance": "", "intended_use": "generic", "law_acceptance": "", "legal_type": "Individual", "maintainer": "", "membership_id": "A", "mobile_phone_number_verification": "", "ngo_ong_eligibility_acceptance": "", "ngo_ong_policy_acceptance": "", "passport_number": "X123456", "rurf_blocked_domains": "", "self_service": "1", "trademark": "1", "trademark_id": "", "travel_acceptance": "1", "vat": "11843009X", "verification_code": "", "vote_acceptance": "", "voto_acceptance": "" }, "admin_handle": "XX123456-XX", "api_history": [ { "cmd": "deleteDomainRequest", "created_at": "2018-09-05 13:58:55", "domain_id": 12345678, "in": "", "out": "" } ], "application_id": "A743C511084404F31B15757DC979A1412-ABI", "application_mode": "", "application_mode_expiration_date": "", "application_mode_title": "", "application_notice_id": "983bdc1a0000100000188801724", "application_smd": "", "auth_code": "1a2b3c4d5e6f", "autorenew": "default", "billing_handle": "XX123456-XX", "can_renew": false, "comments": "", "comments_last_changed_at": "2018-01-30 14:37:49", "creation_date": "2013-07-04 17:14:44", "delete_status": "quarantine", "deleted_at": "0000-00-00 00:00:00", "dnssec": "unsigned", "dnssec_keys": [ { "alg": 8, "flags": 257, "protocol": 3, "pub_key": "WSgigdu8545g96", "readonly": 1 } ], "domain": { "extension": "london", "name": "test4" }, "expiration_date": "2014-07-04 17:14:44", "hard_quarantine_expiry_date": "", "has_active_sectigo_zone": false, "has_history": false, "history": [ { "contents": "Domain: test-example.tldAction: registration succeededStatus: ACTOrder date: 2018-01-30Activation date: 2018-01-30Renewal date: 2019-01-27Expiration date: 2019-01-29Comments: registration of this domain has succeeded Nameserver addresses are automatically resolved by system; Nameserver IP addresses are only saved for glue records", "domain": "example.com", "ip": "12.123.3.12", "subject": "Sent status e-mail to admin@someemail.nl", "timestamp": "2018-01-30T14:38:45+01:00", "type": "I" } ], "id": 123456789, "internal_auth_code": "1a2b3c4d5e6f", "is_abusive": false, "is_client_hold_enabled": "no", "is_deleted": false, "is_dnssec_enabled": false, "is_hosted_whois": false, "is_lockable": false, "is_locked": false, "is_parked": false, "is_premium": false, "is_private_whois_allowed": false, "is_private_whois_enabled": false, "is_sectigo_dns_enabled": false, "is_spamexperts_enabled": false, "last_changed": "2014-04-18 7:13:05", "modify_owner_allowed": false, "name_servers": [ { "ip": "12.3.123.121", "ip6": "1s23:123:123:f", "name": "ns1.example.com", "seq_nr": 1 } ], "ns_group": "dns-openprovider", "ns_template_id": 0, "ns_template_name": "", "nsgroup_id": 1, "order_date": "2013-07-04 17:14:44", "owner": { "company_name": "Example company", "full_name": "Test Van Person" }, "owner_company_name": "Company Name", "owner_handle": "XX123456-XX", "quarantine_expiration_date": "", "registry_expiration_date": "2020-01-29 0:00:00", "registry_statuses": { "client_hold": { "is_changeable": false, "value": 0 }, "client_transfer_prohibited": { "is_changeable": false, "value": 0 } }, "renew": 2, "renewal_date": "2022-01-01 0:00:00", "reseller_handle": "XX123456-XX", "reseller_id": 12345, "restorable_until": "", "scheduled_at": "", "scheduled_from": "", "soft_quarantine_expiry_date": "", "status": "PRE", "tech_handle": "XX123456-XX", "trade_allowed": false, "trade_auth_code_required": "no", "transfer_auth_code_required": "yes", "transfer_cancel_supported": false, "type": "NEW", "unit": "y", "use_domicile": false, "verification_email_exp_date": "0000-00-00 00:00:00", "verification_email_name": "test@example.com", "verification_email_status": "not verified", "verification_email_status_description": "-", "whois_privacy_data": { "expiration_date": "2020-04-29 17:15:19" } } }, "domainHistory": { "type": "object", "title": "History", "properties": { "contents": { "type": "string", "title": "The contents" }, "domain": { "type": "string", "title": "Domain full name" }, "ip": { "type": "string", "title": "The ip" }, "subject": { "type": "string", "title": "The subject" }, "timestamp": { "type": "string", "title": "The timestamp" }, "type": { "type": "string", "title": "API history type" } }, "example": { "contents": "Domain: test-example.tldAction: registration succeededStatus: ACTOrder date: 2018-01-30Activation date: 2018-01-30Renewal date: 2019-01-27Expiration date: 2019-01-29Comments: registration of this domain has succeeded Nameserver addresses are automatically resolved by system; Nameserver IP addresses are only saved for glue records", "domain": "example.com", "ip": "12.123.3.12", "subject": "Sent status e-mail to admin@someemail.nl", "timestamp": "2018-01-30T14:38:45+01:00", "type": "I" } }, "domainListDomainsRequestOrderBy": { "type": "object", "title": "ListDomainsRequestOrderBy", "properties": { "active_date": { "type": "string", "title": "The active date" }, "domain_extension": { "type": "string", "title": "Domain extension" }, "domain_name": { "type": "string", "title": "The domain name" }, "expiration_date": { "type": "string", "title": "Domain expiration date" }, "id": { "type": "string", "title": "Domain id number" }, "order_date": { "type": "string", "title": "The order date" }, "renewal_date": { "type": "string", "title": "Date on which domain will be renewed" }, "status": { "type": "string", "title": "Domain status" }, "transfer_date": { "type": "string", "title": "The transfer date" } } }, "domainListDomainsRequestResponseField": { "type": "object", "title": "ListDomainsRequestResponseField", "properties": { "to": { "type": "string", "title": "The to" }, "type": { "type": "string", "title": "The type" } } }, "domainListDomainsResponse": { "type": "object", "title": "ListDomainsResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/domainListDomainsResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates that the Openprovider system is temporarily unavailable because of maintenance" }, "warnings": { "type": "array", "title": "Contains warning responses if any", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "results": [ { "abuse_details": { "abuse_id": 0, "is_domain_held": false, "message": "" }, "active_date": "2019-01-27 0:55:17", "additional_data": { "abogado_acceptance": "", "admin_sing_pass_id": "", "ae_acceptance": "1", "allocation_token": "", "auth_code": "", "bank_acceptance": "", "company_registration_number": "XX123456789X01", "coop_acceptance": "1", "customer_uin": "374892173498127349", "customer_uin_doc_type": { "description": "Singapore Personal Access ID", "doc_type": "singpass" }, "domain_name_variants": [ "xn--\u0434\u043e\u043c\u0435\u043d.cat" ], "eligibility_type": "", "eligibility_type_relationship": "", "es_annex_acceptance": "1", "ftld_token": "", "gay_donation_acceptance": "1", "gay_rights_protection_acceptance": "1", "id_number": "123456789X", "id_type": "", "idn_script": "SPA", "insurance_acceptance": "", "intended_use": "generic", "law_acceptance": "", "legal_type": "Individual", "maintainer": "", "membership_id": "A", "mobile_phone_number_verification": "", "ngo_ong_eligibility_acceptance": "", "ngo_ong_policy_acceptance": "", "passport_number": "X123456", "rurf_blocked_domains": "", "self_service": "1", "trademark": "1", "trademark_id": "", "travel_acceptance": "1", "vat": "11843009X", "verification_code": "", "vote_acceptance": "", "voto_acceptance": "" }, "admin_handle": "XX123456-XX", "api_history": [ { "cmd": "deleteDomainRequest", "created_at": "2018-09-05 13:58:55", "domain_id": 12345678, "in": "", "out": "" } ], "application_id": "A743C511084404F31B15757DC979A1412-ABI", "application_mode": "", "application_mode_expiration_date": "", "application_mode_title": "", "application_notice_id": "983bdc1a0000100000188801724", "application_smd": "", "auth_code": "1a2b3c4d5e6f", "autorenew": "default", "billing_handle": "XX123456-XX", "can_renew": false, "comments": "", "comments_last_changed_at": "2018-01-30 14:37:49", "creation_date": "2013-07-04 17:14:44", "delete_status": "quarantine", "deleted_at": "0000-00-00 00:00:00", "dnssec": "unsigned", "dnssec_keys": [ { "alg": 8, "flags": 257, "protocol": 3, "pub_key": "WSgigdu8545g96", "readonly": 1 } ], "domain": { "extension": "london", "name": "test4" }, "expiration_date": "2014-07-04 17:14:44", "hard_quarantine_expiry_date": "", "has_active_sectigo_zone": false, "has_history": false, "history": [ { "contents": "Domain: test-example.tldAction: registration succeededStatus: ACTOrder date: 2018-01-30Activation date: 2018-01-30Renewal date: 2019-01-27Expiration date: 2019-01-29Comments: registration of this domain has succeeded Nameserver addresses are automatically resolved by system; Nameserver IP addresses are only saved for glue records", "domain": "example.com", "ip": "12.123.3.12", "subject": "Sent status e-mail to admin@someemail.nl", "timestamp": "2018-01-30T14:38:45+01:00", "type": "I" } ], "id": 123456789, "internal_auth_code": "1a2b3c4d5e6f", "is_abusive": false, "is_client_hold_enabled": "no", "is_deleted": false, "is_dnssec_enabled": false, "is_hosted_whois": false, "is_lockable": false, "is_locked": false, "is_parked": false, "is_premium": false, "is_private_whois_allowed": false, "is_private_whois_enabled": false, "is_sectigo_dns_enabled": false, "is_spamexperts_enabled": false, "last_changed": "2014-04-18 7:13:05", "modify_owner_allowed": false, "name_servers": [ { "ip": "12.3.123.121", "ip6": "1s23:123:123:f", "name": "ns1.example.com", "seq_nr": 1 } ], "ns_group": "dns-openprovider", "ns_template_id": 0, "ns_template_name": "", "nsgroup_id": 1, "order_date": "2013-07-04 17:14:44", "owner": { "company_name": "Example company", "full_name": "Test Van Person" }, "owner_company_name": "Company Name", "owner_handle": "XX123456-XX", "quarantine_expiration_date": "", "registry_expiration_date": "2020-01-29 0:00:00", "registry_statuses": { "client_hold": { "is_changeable": false, "value": 0 }, "client_transfer_prohibited": { "is_changeable": false, "value": 0 } }, "renew": 2, "renewal_date": "2022-01-01 0:00:00", "reseller_handle": "XX123456-XX", "reseller_id": 12345, "restorable_until": "", "scheduled_at": "", "scheduled_from": "", "soft_quarantine_expiry_date": "", "status": "PRE", "tech_handle": "XX123456-XX", "trade_allowed": false, "trade_auth_code_required": "no", "transfer_auth_code_required": "yes", "transfer_cancel_supported": false, "type": "NEW", "unit": "y", "use_domicile": false, "verification_email_exp_date": "0000-00-00 00:00:00", "verification_email_name": "test@example.com", "verification_email_status": "not verified", "verification_email_status_description": "-", "whois_privacy_data": { "expiration_date": "2020-04-29 17:15:19" } } ], "total": 999 }, "desc": "" } }, "domainListDomainsResponseData": { "type": "object", "title": "ListDomainsResponseData", "properties": { "results": { "type": "array", "title": "The results", "items": { "$ref": "#/definitions/domainGetDomainResponseData" } }, "total": { "type": "integer", "format": "int32", "title": "The total" } }, "example": { "results": [ { "abuse_details": { "abuse_id": 0, "is_domain_held": false, "message": "" }, "active_date": "2019-01-27 0:55:17", "additional_data": { "abogado_acceptance": "", "admin_sing_pass_id": "", "ae_acceptance": "1", "allocation_token": "", "auth_code": "", "bank_acceptance": "", "company_registration_number": "XX123456789X01", "coop_acceptance": "1", "customer_uin": "374892173498127349", "customer_uin_doc_type": { "description": "Singapore Personal Access ID", "doc_type": "singpass" }, "domain_name_variants": [ "xn--\u0434\u043e\u043c\u0435\u043d.cat" ], "eligibility_type": "", "eligibility_type_relationship": "", "es_annex_acceptance": "1", "ftld_token": "", "gay_donation_acceptance": "1", "gay_rights_protection_acceptance": "1", "id_number": "123456789X", "id_type": "", "idn_script": "SPA", "insurance_acceptance": "", "intended_use": "generic", "law_acceptance": "", "legal_type": "Individual", "maintainer": "", "membership_id": "A", "mobile_phone_number_verification": "", "ngo_ong_eligibility_acceptance": "", "ngo_ong_policy_acceptance": "", "passport_number": "X123456", "rurf_blocked_domains": "", "self_service": "1", "trademark": "1", "trademark_id": "", "travel_acceptance": "1", "vat": "11843009X", "verification_code": "", "vote_acceptance": "", "voto_acceptance": "" }, "admin_handle": "XX123456-XX", "api_history": [ { "cmd": "deleteDomainRequest", "created_at": "2018-09-05 13:58:55", "domain_id": 12345678, "in": "", "out": "" } ], "application_id": "A743C511084404F31B15757DC979A1412-ABI", "application_mode": "", "application_mode_expiration_date": "", "application_mode_title": "", "application_notice_id": "983bdc1a0000100000188801724", "application_smd": "", "auth_code": "1a2b3c4d5e6f", "autorenew": "default", "billing_handle": "XX123456-XX", "can_renew": false, "comments": "", "comments_last_changed_at": "2018-01-30 14:37:49", "creation_date": "2013-07-04 17:14:44", "delete_status": "quarantine", "deleted_at": "0000-00-00 00:00:00", "dnssec": "unsigned", "dnssec_keys": [ { "alg": 8, "flags": 257, "protocol": 3, "pub_key": "WSgigdu8545g96", "readonly": 1 } ], "domain": { "extension": "london", "name": "test4" }, "expiration_date": "2014-07-04 17:14:44", "hard_quarantine_expiry_date": "", "has_active_sectigo_zone": false, "has_history": false, "history": [ { "contents": "Domain: test-example.tldAction: registration succeededStatus: ACTOrder date: 2018-01-30Activation date: 2018-01-30Renewal date: 2019-01-27Expiration date: 2019-01-29Comments: registration of this domain has succeeded Nameserver addresses are automatically resolved by system; Nameserver IP addresses are only saved for glue records", "domain": "example.com", "ip": "12.123.3.12", "subject": "Sent status e-mail to admin@someemail.nl", "timestamp": "2018-01-30T14:38:45+01:00", "type": "I" } ], "id": 123456789, "internal_auth_code": "1a2b3c4d5e6f", "is_abusive": false, "is_client_hold_enabled": "no", "is_deleted": false, "is_dnssec_enabled": false, "is_hosted_whois": false, "is_lockable": false, "is_locked": false, "is_parked": false, "is_premium": false, "is_private_whois_allowed": false, "is_private_whois_enabled": false, "is_sectigo_dns_enabled": false, "is_spamexperts_enabled": false, "last_changed": "2014-04-18 7:13:05", "modify_owner_allowed": false, "name_servers": [ { "ip": "12.3.123.121", "ip6": "1s23:123:123:f", "name": "ns1.example.com", "seq_nr": 1 } ], "ns_group": "dns-openprovider", "ns_template_id": 0, "ns_template_name": "", "nsgroup_id": 1, "order_date": "2013-07-04 17:14:44", "owner": { "company_name": "Example company", "full_name": "Test Van Person" }, "owner_company_name": "Company Name", "owner_handle": "XX123456-XX", "quarantine_expiration_date": "", "registry_expiration_date": "2020-01-29 0:00:00", "registry_statuses": { "client_hold": { "is_changeable": false, "value": 0 }, "client_transfer_prohibited": { "is_changeable": false, "value": 0 } }, "renew": 2, "renewal_date": "2022-01-01 0:00:00", "reseller_handle": "XX123456-XX", "reseller_id": 12345, "restorable_until": "", "scheduled_at": "", "scheduled_from": "", "soft_quarantine_expiry_date": "", "status": "PRE", "tech_handle": "XX123456-XX", "trade_allowed": false, "trade_auth_code_required": "no", "transfer_auth_code_required": "yes", "transfer_cancel_supported": false, "type": "NEW", "unit": "y", "use_domicile": false, "verification_email_exp_date": "0000-00-00 00:00:00", "verification_email_name": "test@example.com", "verification_email_status": "not verified", "verification_email_status_description": "-", "whois_privacy_data": { "expiration_date": "2020-04-29 17:15:19" } } ], "total": 999 } }, "domainNameserver": { "type": "object", "title": "Nameserver", "properties": { "ip": { "type": "string", "title": "The ip" }, "ip6": { "type": "string", "title": "The ip6" }, "name": { "type": "string", "title": "Full name of the nameserver" }, "seq_nr": { "type": "integer", "format": "int32", "title": "The seq nr" } }, "example": { "ip": "12.3.123.121", "ip6": "1s23:123:123:f", "name": "ns1.example.com", "seq_nr": 1 } }, "domainOperationPrice": { "type": "object", "title": "OperationPrice", "properties": { "create": { "type": "number", "format": "double", "title": "Registration price" } }, "example": { "create": 0 } }, "domainOwner": { "type": "object", "title": "Owner", "properties": { "company_name": { "type": "string", "title": "Domain owner company name" }, "full_name": { "type": "string", "title": "Domain owner full name" } }, "example": { "company_name": "Example company", "full_name": "Test Van Person" } }, "domainPremiumPrice": { "type": "object", "title": "PremiumPrice", "properties": { "currency": { "type": "string", "title": "Price currency" }, "price": { "title": "Operation price", "$ref": "#/definitions/domainOperationPrice" } }, "example": { "currency": "USD", "price": { "create": 0 } } }, "domainPrice": { "type": "object", "title": "Price", "properties": { "currency": { "type": "string", "title": "Product or reseller currency" }, "price": { "type": "number", "format": "double", "title": "Amount in product or reseller currency" } }, "example": { "currency": "USD", "price": 8.06 } }, "domainPriceGroup": { "type": "object", "title": "PriceGroup", "properties": { "product": { "title": "Amount in product currency", "$ref": "#/definitions/domainPrice" }, "reseller": { "title": "Amount in reseller currency", "$ref": "#/definitions/domainPrice" } }, "example": { "product": { "currency": "USD", "price": 8.06 }, "reseller": { "currency": "USD", "price": 8.06 } } }, "domainRegistryStatus": { "type": "object", "title": "RegistryStatus", "properties": { "is_changeable": { "type": "boolean", "format": "boolean", "title": "Indicate whether status can be removed" }, "value": { "type": "integer", "format": "int32", "title": "Status value" } }, "example": { "is_changeable": false, "value": 0 } }, "domainRegistryStatuses": { "type": "object", "title": "RegistryStatuses", "properties": { "client_hold": { "title": "Client hold EPP status", "$ref": "#/definitions/domainRegistryStatus" }, "client_transfer_prohibited": { "title": "Client transfer prohibited EPP status", "$ref": "#/definitions/domainRegistryStatus" } }, "example": { "client_hold": { "is_changeable": false, "value": 0 }, "client_transfer_prohibited": { "is_changeable": false, "value": 0 } } }, "domainRenewDomainRequest": { "type": "object", "title": "RenewDomainRequest", "properties": { "domain": { "title": "Domain name and extension", "$ref": "#/definitions/domainDomain" }, "id": { "type": "integer", "format": "int32", "title": "Domain id number" }, "period": { "type": "integer", "format": "int32", "title": "Domain registration period in years unless otherwise specified" } }, "example": { "domain": { "extension": "london", "name": "test4" }, "id": 0, "period": 1 } }, "domainRenewDomainResponse": { "type": "object", "title": "RenewDomainResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/domainRenewDomainResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates that the Openprovider system is temporarily unavailable because of maintenance" }, "warnings": { "type": "array", "title": "Contains warning responses if any", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "status": "ACT" }, "desc": "" } }, "domainRenewDomainResponseData": { "type": "object", "title": "RenewDomainResponseData", "properties": { "status": { "type": "string", "title": "Domain status" } }, "example": { "status": "ACT" } }, "domainRestoreDomainRequest": { "type": "object", "title": "RestoreDomainRequest", "properties": { "domain": { "title": "Domain name and extension", "$ref": "#/definitions/domainDomain" }, "id": { "type": "integer", "format": "int32", "title": "Domain id number" } }, "example": { "domain": { "extension": "london", "name": "test4" }, "id": 0 } }, "domainRestoreDomainResponse": { "type": "object", "title": "RestoreDomainResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/domainRestoreDomainResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates that the Openprovider system is temporarily unavailable because of maintenance" }, "warnings": { "type": "array", "title": "Contains warning responses if any", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "status": "ACT" }, "desc": "" } }, "domainRestoreDomainResponseData": { "type": "object", "title": "RestoreDomainResponseData", "properties": { "status": { "type": "string", "title": "Domain status" } }, "example": { "status": "ACT" } }, "domainSendFoa1Request": { "type": "object", "title": "SendFoa1Request", "properties": { "domain": { "title": "Domain name and extension", "$ref": "#/definitions/domainDomain" }, "id": { "type": "integer", "format": "int32", "title": "Domain id number" } }, "example": { "domain": { "extension": "london", "name": "test4" }, "id": 0 } }, "domainSuggestNameDomainRequest": { "type": "object", "title": "SuggestNameDomainRequest", "properties": { "language": { "type": "string", "title": "The three letter country code for the language in which responses should be generated (ISO-3166 ALPHA-3 code format)" }, "limit": { "type": "integer", "format": "int32", "title": "Maximum number of suggestions to return" }, "name": { "type": "string", "title": "The search term which will be used to generate matches" }, "provider": { "type": "string", "title": "Provider of suggest name service" }, "sensitive": { "description": "Set true to remove domain name suggestions deemed obscene by the supplier. set false to include obscene domain name suggestions.", "type": "boolean", "format": "boolean" }, "tlds": { "type": "array", "title": "List of TLDs which will be used to generate matches", "items": { "type": "string" } } }, "example": { "language": "eng", "limit": 50, "name": "example-domain", "provider": "namestudio", "sensitive": false, "tlds": [ "" ] } }, "domainSuggestNameDomainResponse": { "type": "object", "title": "SuggestNameDomainResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/domainSuggestNameDomainResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "results": [ { "domain": "yourexampledomain", "name": "yourexampledomain.com", "tld": "com" } ] }, "desc": "" } }, "domainSuggestNameDomainResponseData": { "type": "object", "title": "SuggestNameDomainResponseData", "properties": { "results": { "type": "array", "title": "Array of results", "items": { "$ref": "#/definitions/domainSuggestNameDomainResult" } } }, "example": { "results": [ { "domain": "yourexampledomain", "name": "yourexampledomain.com", "tld": "com" } ] } }, "domainSuggestNameDomainResult": { "type": "object", "title": "SuggestNameDomainResult", "properties": { "domain": { "type": "string", "title": "Domain name, not including the TLD" }, "name": { "type": "string", "title": "Domain and TLD separated by '.'" }, "tld": { "type": "string", "title": "TLD" } }, "example": { "domain": "yourexampledomain", "name": "yourexampledomain.com", "tld": "com" } }, "domainTradeDomainRequest": { "type": "object", "title": "TradeDomainRequest", "properties": { "additional_data": { "title": "Additional domain data", "$ref": "#/definitions/domainAdditionalData" }, "admin_handle": { "type": "string", "title": "Administrative contact handle" }, "auth_code": { "type": "string", "title": "Authorization code" }, "autorenew": { "type": "string", "title": "Desired autorenew value: off, on, or default" }, "billing_handle": { "type": "string", "title": "Billing contact handle" }, "comments": { "type": "string", "title": "Domain comments" }, "dnssec_keys": { "type": "array", "title": "Array containing DNSSEC key information", "items": { "$ref": "#/definitions/domainDnssecKey" } }, "domain": { "title": "Domain name and extension", "$ref": "#/definitions/domainDomain" }, "name_servers": { "type": "array", "title": "Array containing name server information", "items": { "$ref": "#/definitions/domainNameserver" } }, "ns_group": { "type": "string", "title": "Name of nameserver group" }, "ns_template_id": { "type": "integer", "format": "int32", "title": "Id of nameserver template" }, "ns_template_name": { "type": "string", "title": "Name of nameserver template" }, "owner_handle": { "type": "string", "title": "Owner contact handle" }, "period": { "type": "integer", "format": "int32", "title": "Domain registration period in years unless otherwise specified" }, "promo_code": { "type": "string", "title": "Promo code to apply to operation" }, "tech_handle": { "type": "string", "title": "Tech contact handle" }, "use_domicile": { "type": "boolean", "format": "boolean", "title": "Use of domicile or trustee address for TLDs that require local presence" } }, "example": { "additional_data": { "abogado_acceptance": "", "admin_sing_pass_id": "", "ae_acceptance": "1", "allocation_token": "", "auth_code": "", "bank_acceptance": "", "company_registration_number": "XX123456789X01", "coop_acceptance": "1", "customer_uin": "374892173498127349", "customer_uin_doc_type": { "description": "Singapore Personal Access ID", "doc_type": "singpass" }, "domain_name_variants": [ "xn--\u0434\u043e\u043c\u0435\u043d.cat" ], "eligibility_type": "", "eligibility_type_relationship": "", "es_annex_acceptance": "1", "ftld_token": "", "gay_donation_acceptance": "1", "gay_rights_protection_acceptance": "1", "id_number": "123456789X", "id_type": "", "idn_script": "SPA", "insurance_acceptance": "", "intended_use": "generic", "law_acceptance": "", "legal_type": "Individual", "maintainer": "", "membership_id": "A", "mobile_phone_number_verification": "", "ngo_ong_eligibility_acceptance": "", "ngo_ong_policy_acceptance": "", "passport_number": "X123456", "rurf_blocked_domains": "", "self_service": "1", "trademark": "1", "trademark_id": "", "travel_acceptance": "1", "vat": "11843009X", "verification_code": "", "vote_acceptance": "", "voto_acceptance": "" }, "admin_handle": "XX123456-XX", "auth_code": "12345678", "autorenew": "default", "billing_handle": "XX123456-XX", "comments": "", "dnssec_keys": [ { "alg": 8, "flags": 257, "protocol": 3, "pub_key": "WSgigdu8545g96", "readonly": 1 } ], "domain": { "extension": "london", "name": "test4" }, "name_servers": [ { "ip": "12.3.123.121", "ip6": "1s23:123:123:f", "name": "ns1.example.com", "seq_nr": 1 } ], "ns_group": "dns-openprovider", "ns_template_id": 18354, "ns_template_name": "", "owner_handle": "XX123456-XX", "period": 0, "promo_code": "", "tech_handle": "XX123456-XX", "use_domicile": false } }, "domainTradeDomainResponse": { "type": "object", "title": "TradeDomainResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/domainTradeDomainResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates that the Openprovider system is temporarily unavailable because of maintenance" }, "warnings": { "type": "array", "title": "Contains warning responses if any", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "creation_date": "2019-04-12 7:28:27", "expiration_date": "2020-04-16 13:18:54", "renewal_date": "2020-04-16 13:18:54", "status": "ACT" }, "desc": "" } }, "domainTradeDomainResponseData": { "type": "object", "title": "TradeDomainResponseData", "properties": { "creation_date": { "type": "string", "title": "Domain creation date" }, "expiration_date": { "type": "string", "title": "Domain expiration date" }, "renewal_date": { "type": "string", "title": "Date on which domain will be renewed" }, "status": { "type": "string", "title": "Domain status" } }, "example": { "creation_date": "2019-04-12 7:28:27", "expiration_date": "2020-04-16 13:18:54", "renewal_date": "2020-04-16 13:18:54", "status": "ACT" } }, "domainTransferAdditionalData": { "type": "object", "title": "TransferAdditionalData", "properties": { "admin_sing_pass_id": { "type": "string", "title": "If the admin contact is a natural person located in Singapore, the corresponding Singapore Personal Access ID has to be given. The format of the SingPassID is: X1234567X - where X is an upper case letter at the beginning and end of a seven digit string In case of a foreign organization, it is possible to use the SGNICID: SGNICID-X12-345678 - the SGNICID will look like this example\nApplicable to: .com.sg, .sg" }, "auth_code": { "type": "string", "title": "The auth code\nApplicable to: .nz" }, "company_registration_number": { "type": "string", "title": "For companies located in Singapore, the corresponding company registration number has to be given. For Singapore citizens and permanent residents, please provide NRIC or Passport No. For Singapore companies, please provide RCBID as it appears in RCB Certificate. For Singapore societies, please provide RCBID as it appears in ROS Certificate.\nApplicable to: .com.sg, .no, .ro, .sg" }, "customer_uin": { "type": "string", "title": "Identification number of domain owner document that proves his identity (e.g. passport number, number of driving license or else in case if domain owner is a private person; chamber of commerce registration number, taxpayer number or else in case of legal entity)\nApplicable for all TLDs which require documents to complete operation with domain (e.g. .bg, .cn etc.)" }, "customer_uin_doc_type": { "title": "Type of the domain owner document used to prove his identity (e.g. passport, driving license or else in case if domain owner is a private person; chamber of commerce extract, business certificate or else in case of legal entity)\nApplicable for all TLDs which require documents to complete operation with domain (e.g. .bg, .cn etc.)", "$ref": "#/definitions/domainUINDocumentType" }, "domain_name_variants": { "type": "array", "title": "The domain name variants should be an array of strings, representing appropriate names\nApplicable to: .cat", "items": { "type": "string" } }, "ftld_token": { "type": "string", "title": "The fTLD token and data in owner handle must be exactly the same as in token. You need to request token from registry\nApplicable to: .bank, .insurance" }, "gay_donation_acceptance": { "type": "string", "title": "The .gay donation acceptance value should be set to 1\nApplicable to: .gay" }, "gay_rights_protection_acceptance": { "type": "string", "title": "The .gay rights protection acceptance value should be set to 1\nApplicable to: .gay" }, "idn_script": { "type": "string", "title": "The idn script states what language or character set the domain name is in\nApplicable to: .eus, .gal, .hiv, .quebec, .scot, .xn--55qx5d, .xn--5tzm5g, .xn--czru2d, .xn--io0a7i, .xn--mk1bu44c, .xn--t60b56a, .xn--tckwe" }, "intended_use": { "type": "string", "title": "The intended use value must contain information on how the domain name will be used\nApplicable to: .cat, .scot, .gal, .eus, .swiss, .radio, .barcelona, .sport, .pl, .aid.pl, .agro.pl, .atm.pl, .auto.pl, .biz.pl, .com.pl, .edu.pl, .gmina.pl, .gsm.pl, .info.pl, .mail.pl, .miasta.pl, .media.pl, .mil.pl, .net.pl, .nieruchomosci.pl, .nom.pl, .org.pl, .pc.pl, .powiat.pl, .priv.pl, .realestate.pl, .rel.pl, .sex.pl, .shop.pl, .sklep.pl, .sos.pl, .szkola.pl, .targi.pl, .tm.pl, .tourism.pl, .travel.pl, .turystyka.pl, .augustow.pl, .babia-gora.pl, .bedzin.pl, .beskidy.pl, .bialowieza.pl, .bialystok.pl, .bielawa.pl, .bieszczady.pl, .boleslawiec.pl, .bydgoszcz.pl, .bytom.pl, .cieszyn.pl, .czeladz.pl, .czest.pl, .dlugoleka.pl, .elblag.pl, .elk.pl, .glogow.pl, .gniezno.pl, .gorlice.pl, .grajewo.pl, .ilawa.pl, .jaworzno.pl, .jelenia-gora.pl, .jgora.pl, .kalisz.pl, .kazimierz-dolny.pl, .karpacz.pl, .kartuzy.pl, .kaszuby.pl, .katowice.pl, .kepno.pl, .ketrzyn.pl, .klodzko.pl, .kobierzyce.pl, .kolobrzeg.pl, .konin.pl, .konskowola.pl, .kutno.pl, .lapy.pl, .lebork.pl, .legnica.pl, .lezajsk.pl, .limanowa.pl, .lomza.pl, .lowicz.pl, .lubin.pl, .lukow.pl, .malbork.pl, .malopolska.pl, .mazowsze.pl, .mazury.pl, .mielec.pl, .mielno.pl, .mragowo.pl, .naklo.pl, .nowaruda.pl, .nysa.pl, .olawa.pl, .olecko.pl, .olkusz.pl, .olsztyn.pl, .opoczno.pl, .opole.pl, .ostroda.pl, .ostroleka.pl, .ostrowiec.pl, .ostrowwlkp.pl, .pila.pl, .pisz.pl, .podhale.pl, .podlasie.pl, .polkowice.pl, .pomorze.pl, .pomorskie.pl, .prochowice.pl, .pruszkow.pl, .przeworsk.pl, .pulawy.pl, .radom.pl, .rawa-maz.pl, .rybnik.pl, .rzeszow.pl, .sanok.pl, .sejny.pl, .slask.pl, .slupsk.pl, .sosnowiec.pl, .stalowa-wola.pl, .skoczow.pl, .starachowice.pl, .stargard.pl, .suwalki.pl, .swidnica.pl, .swiebodzin.pl, .swinoujscie.pl, .szczecin.pl, .szczytno.pl, .tarnobrzeg.pl, .tgory.pl, .turek.pl, .tychy.pl, .ustka.pl, .walbrzych.pl, .warmia.pl, .warszawa.pl, .waw.pl, .wegrow.pl, .wielun.pl, .wlocl.pl, .wloclawek.pl, .wodzislaw.pl, .wolomin.pl, .wroclaw.pl, .zachpomor.pl, .zagan.pl, .zarow.pl, .zgora.pl, .zgorzelec.pl" }, "legal_type": { "type": "string", "title": "The legal type\nApplicable to: .ca" }, "maintainer": { "type": "string", "title": "The maintainer value should be a string, specifying maintainer information. Maximum length 128 characters.\nApplicable to: .cat" }, "membership_id": { "type": "string", "title": "The membership id value cannot be empty\nApplicable to: .lotto, .xxx" }, "mobile_phone_number_verification": { "type": "string", "title": "The mobile phone's verification via sms\nApplicable to: .ru, .su, .xn--p1ai" }, "passport_number": { "type": "string", "title": "The passport number. Required in case if domain requester is a private individual\nApplicable to: .co.hu, .hu" }, "self_service": { "type": "string", "title": "The self service\nApplicable to: .feedback" }, "trademark": { "type": "string", "title": "The trademark\nApplicable to: .ca" }, "vat": { "type": "string", "title": "The vat number. Required in case if domain requester is a legal entity\nApplicable to: .co.hu, .hu" }, "verification_code": { "type": "string", "title": "The verification code value cannot be empty\nApplicable to: .lotto" } }, "example": { "admin_sing_pass_id": "", "auth_code": "", "company_registration_number": "XX123456789X03", "customer_uin": "374892173498127349", "customer_uin_doc_type": { "description": "Singapore Personal Access ID", "doc_type": "singpass" }, "domain_name_variants": [ "xn--\u0434\u043e\u043c\u0435\u043d.cat" ], "ftld_token": "", "gay_donation_acceptance": "1", "gay_rights_protection_acceptance": "1", "idn_script": "SPA", "intended_use": "generic", "legal_type": "Individual", "maintainer": "", "membership_id": "A", "mobile_phone_number_verification": "", "passport_number": "X123458", "self_service": "1", "trademark": "1", "vat": "11843009X", "verification_code": "" } }, "domainTransferDomainRequest": { "type": "object", "title": "TransferDomainRequest", "properties": { "accept_premium_fee": { "type": "number", "format": "double", "title": "Required in case when domain is premium, value is the price returned in the response for TransferDomainRequest without acceptPremiumFee" }, "additional_data": { "title": "Additional domain data", "$ref": "#/definitions/domainTransferAdditionalData" }, "admin_handle": { "type": "string", "title": "Administrative contact handle" }, "at": { "type": "string", "title": "Scheduled transfer date" }, "auth_code": { "type": "string", "title": "Authorization code" }, "autorenew": { "type": "string", "title": "Desired autorenew value: off, on, or default", "default": "default" }, "billing_handle": { "type": "string", "title": "Billing contact handle" }, "comments": { "type": "string", "title": "Domain comments" }, "dnssec_keys": { "type": "array", "title": "Array containing DNSSEC key information", "items": { "$ref": "#/definitions/domainDnssecKey" } }, "domain": { "title": "Domain name and extension", "$ref": "#/definitions/domainDomain" }, "import_contacts_from_registry": { "description": "Imports contacts data from registry and creates handles after the transfer. Allows to skip admin_handle, billing_handle, owner_handle, reseller_handle and tech_handle parameters.", "type": "boolean", "format": "boolean" }, "import_nameservers_from_registry": { "description": "Imports nameservers from registry after the transfer. Allows to skip ns_group, ns_template_id and ns_template_name parameters.", "type": "boolean", "format": "boolean" }, "is_dnssec_enabled": { "type": "boolean", "format": "boolean", "title": "Enables or disables DNSSEC on domain" }, "is_private_whois_enabled": { "type": "boolean", "format": "boolean", "title": "Enables or disables whois privacy protection (WPP) on domain" }, "name_servers": { "type": "array", "title": "Array containing name server information", "items": { "$ref": "#/definitions/domainNameserver" } }, "ns_group": { "type": "string", "title": "Name of nameserver group" }, "ns_template_id": { "type": "integer", "format": "int32", "title": "Id of nameserver template" }, "ns_template_name": { "type": "string", "title": "Name of nameserver template" }, "owner_handle": { "type": "string", "title": "Owner contact handle" }, "promo_code": { "type": "string", "title": "Promo code to apply to operation" }, "reseller_handle": { "type": "string", "title": "Reseller handle" }, "roid": { "type": "string", "title": "Registry id of domain" }, "tech_handle": { "type": "string", "title": "Tech contact handle" }, "unit": { "type": "string", "title": "Unit of time to register domain, yearly, quarterly, or monthly" }, "use_domicile": { "type": "boolean", "format": "boolean", "title": "Use of domicile or trustee address for TLDs that require local presence" } }, "example": { "accept_premium_fee": 17, "additional_data": { "admin_sing_pass_id": "", "auth_code": "", "company_registration_number": "XX123456789X03", "customer_uin": "374892173498127349", "customer_uin_doc_type": { "description": "Singapore Personal Access ID", "doc_type": "singpass" }, "domain_name_variants": [ "xn--\u0434\u043e\u043c\u0435\u043d.cat" ], "ftld_token": "", "gay_donation_acceptance": "1", "gay_rights_protection_acceptance": "1", "idn_script": "SPA", "intended_use": "generic", "legal_type": "Individual", "maintainer": "", "membership_id": "A", "mobile_phone_number_verification": "", "passport_number": "X123458", "self_service": "1", "trademark": "1", "vat": "11843009X", "verification_code": "" }, "admin_handle": "XX123456-XX", "at": "2019-04-30", "auth_code": "12345678", "autorenew": "default", "billing_handle": "XX123456-XX", "comments": "any comment here", "dnssec_keys": [ { "alg": 8, "flags": 257, "protocol": 3, "pub_key": "WSgigdu8545g96", "readonly": 1 } ], "domain": { "extension": "london", "name": "test4" }, "import_contacts_from_registry": false, "import_nameservers_from_registry": false, "is_dnssec_enabled": false, "is_private_whois_enabled": false, "name_servers": [ { "ip": "12.3.123.121", "ip6": "1s23:123:123:f", "name": "ns1.example.com", "seq_nr": 1 } ], "ns_group": "dns-openprovider", "ns_template_id": 30951, "ns_template_name": "example", "owner_handle": "XX123456-XX", "promo_code": "PROMOCODE", "reseller_handle": "XX123456-XX", "roid": "100590-UK", "tech_handle": "XX123456-XX", "unit": "y", "use_domicile": false } }, "domainTransferDomainResponse": { "type": "object", "title": "TransferDomainResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/domainTransferDomainResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates that the Openprovider system is temporarily unavailable because of maintenance" }, "warnings": { "type": "array", "title": "Contains warning responses if any", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "auth_code": "12345678", "description": "intendedUse value must contain information on how the domain name will be used", "error": "Nameserver 1: IPv4 is not specified", "expiration_date": "2020-03-31 23:59:59", "id": 123456789, "name": "intendedUse", "renewal_date": "2020-03-29 23:59:59", "required": false, "status": "ACT", "type": "text" }, "desc": "" } }, "domainTransferDomainResponseData": { "type": "object", "title": "TransferDomainResponseData", "properties": { "auth_code": { "type": "string", "title": "Authorization code" }, "description": { "type": "string", "title": "Parameter description" }, "error": { "type": "string", "title": "The error" }, "expiration_date": { "type": "string", "title": "Domain expiration date" }, "id": { "type": "integer", "format": "int32", "title": "Domain id number" }, "name": { "type": "string", "title": "Parameter name" }, "renewal_date": { "type": "string", "title": "Date on which domain will be renewed" }, "required": { "type": "boolean", "format": "boolean", "title": "Indicates, if parameter is required" }, "status": { "type": "string", "title": "Domain status" }, "type": { "type": "string", "title": "Parameter type" } }, "example": { "auth_code": "12345678", "description": "intendedUse value must contain information on how the domain name will be used", "error": "Nameserver 1: IPv4 is not specified", "expiration_date": "2020-03-31 23:59:59", "id": 123456789, "name": "intendedUse", "renewal_date": "2020-03-29 23:59:59", "required": false, "status": "ACT", "type": "text" } }, "domainTryAgainLastOperationRequest": { "type": "object", "title": "TryAgainLastOperationRequest", "properties": { "auth_code": { "type": "string", "title": "Auth code for transfer" }, "domain": { "title": "Domain name and extension", "$ref": "#/definitions/domainDomain" }, "id": { "type": "integer", "format": "int32", "title": "Domain id number" } }, "example": { "auth_code": "1a2b3c4d5e6f", "domain": { "extension": "london", "name": "test4" }, "id": 0 } }, "domainUINDocumentType": { "type": "object", "title": "UINDocumentType", "properties": { "description": { "type": "string", "title": "Brief description of the document used to prove domain owner's identity" }, "doc_type": { "type": "string", "title": "Type of the document used to prove domain owner's identity" } }, "example": { "description": "Singapore Personal Access ID", "doc_type": "singpass" } }, "domainUpdateAdditionalData": { "type": "object", "title": "UpdateAdditionalData", "properties": { "abogado_acceptance": { "type": "string", "title": "The abogado acceptance value should be set to 1\nApplicable to: .abogado" }, "admin_sing_pass_id": { "type": "string", "title": "If the admin contact is a natural person located in Singapore, the corresponding Singapore Personal Access ID has to be given. The format of the SingPassID is: X1234567X - where X is an upper case letter at the beginning and end of a seven digit string In case of a foreign organization, it is possible to use the SGNICID: SGNICID-X12-345678 - the SGNICID will look like this example\nApplicable to: .com.sg, .sg" }, "auth_code": { "type": "string", "title": "The auth code\nApplicable to: .nz" }, "company_registration_number": { "type": "string", "title": "For companies located in Singapore, the corresponding company registration number has to be given. For Singapore citizens and permanent residents, please provide NRIC or Passport No. For Singapore companies, please provide RCBID as it appears in RCB Certificate. For Singapore societies, please provide RCBID as it appears in ROS Certificate.\nApplicable to: .com.sg, .no, .ro, .sg" }, "customer_uin": { "type": "string", "title": "Identification number of domain owner document that proves his identity (e.g. passport number, number of driving license or else in case if domain owner is a private person; chamber of commerce registration number, taxpayer number or else in case of legal entity)\nApplicable for all TLDs which require documents to complete operation with domain (e.g. .bg, .cn etc.)" }, "customer_uin_doc_type": { "title": "Type of the domain owner document used to prove his identity (e.g. passport, driving license or else in case if domain owner is a private person; chamber of commerce extract, business certificate or else in case of legal entity)\nApplicable for all TLDs which require documents to complete operation with domain (e.g. .bg, .cn etc.)", "$ref": "#/definitions/domainUINDocumentType" }, "domain_name_variants": { "type": "array", "title": "The domain name variants should be an array of strings, representing appropriate names\nApplicable to: .cat", "items": { "type": "string" } }, "intended_use": { "type": "string", "title": "The intended use value should contain information on how the domain name will be used\nApplicable to: .cat" }, "law_acceptance": { "type": "string", "title": "The law acceptance value should be set to 1\nApplicable to: .law" }, "legal_type": { "type": "string", "title": "The legal type\nApplicable to: .ca" }, "maintainer": { "type": "string", "title": "The maintainer value should be a string, specifying maintainer information. Maximum length 128 characters.\nApplicable to: .cat" }, "membership_id": { "type": "string", "title": "The membership id value cannot be empty\nApplicable to: .lotto, .xxx" }, "mobile_phone_number_verification": { "type": "string", "title": "The mobile phone's verification via sms\nApplicable to: .ru, .su, .xn--p1ai" }, "ngo_ong_eligibility_acceptance": { "type": "string", "title": "The ngo, ong eligibility acceptance value should be set to 1\nApplicable to: .ngo, .ong" }, "ngo_ong_policy_acceptance": { "type": "string", "title": "The ngo, ong policy acceptance value should be set to 1\nApplicable to: .ngo, .ong" }, "passport_number": { "type": "string", "title": "The passport number. Required in case if domain requester is a private individual\nApplicable to: .co.hu, .hu" }, "vat": { "type": "string", "title": "The vat number. Required in case if domain requester is a legal entity\nApplicable to: .co.hu, .hu" }, "verification_code": { "type": "string", "title": "The verification code value cannot be empty\nApplicable to: .lotto" } }, "example": { "abogado_acceptance": "", "admin_sing_pass_id": "", "auth_code": "", "company_registration_number": "XX123456789X02", "customer_uin": "374892173498127349", "customer_uin_doc_type": { "description": "Singapore Personal Access ID", "doc_type": "singpass" }, "domain_name_variants": [ "xn--\u0434\u043e\u043c\u0435\u043d.cat" ], "intended_use": "generic", "law_acceptance": "", "legal_type": "Individual", "maintainer": "", "membership_id": "A", "mobile_phone_number_verification": "", "ngo_ong_eligibility_acceptance": "", "ngo_ong_policy_acceptance": "", "passport_number": "X123457", "vat": "11843009X", "verification_code": "" } }, "domainUpdateDomainRequest": { "type": "object", "title": "UpdateDomainRequest", "properties": { "accept_update_fee": { "type": "number", "format": "double", "title": "Amount that will be charged for domain modification" }, "additional_data": { "title": "Additional domain data", "$ref": "#/definitions/domainUpdateAdditionalData" }, "admin_handle": { "type": "string", "title": "Administrative contact handle" }, "auth_code": { "type": "string", "title": "Authorization code" }, "autorenew": { "type": "string", "title": "Desired autorenew value: off, on, or default" }, "billing_handle": { "type": "string", "title": "Billing contact handle" }, "comments": { "type": "string", "title": "Domain comments" }, "dnssec_keys": { "type": "array", "title": "Array containing DNSSEC key information", "items": { "$ref": "#/definitions/domainDnssecKey" } }, "domain": { "title": "Domain name and extension", "$ref": "#/definitions/domainDomain" }, "force_registry_update": { "type": "boolean", "format": "boolean", "title": "Triggers enforced domain update in registry" }, "id": { "type": "integer", "format": "int32", "title": "Domain id number" }, "is_dnssec_enabled": { "type": "boolean", "format": "boolean", "title": "Enables or disables DNSSEC on domain" }, "is_locked": { "type": "boolean", "format": "boolean", "title": "Indicates that domain should be locked or unlocked" }, "is_private_whois_enabled": { "type": "boolean", "format": "boolean", "title": "Enables or disables whois privacy protection (WPP) on domain" }, "is_sectigo_dns_enabled": { "type": "boolean", "format": "boolean", "title": "Enables or disables premium Sectigo DNS on domain" }, "is_spamexperts_enabled": { "type": "boolean", "format": "boolean", "title": "Enable Spam Experts spam protection for domain" }, "name_servers": { "type": "array", "title": "Array containing name server information", "items": { "$ref": "#/definitions/domainNameserver" } }, "ns_group": { "type": "string", "title": "Name of nameserver group" }, "ns_template_id": { "type": "integer", "format": "int32", "title": "Id of nameserver template" }, "ns_template_name": { "type": "string", "title": "Name of nameserver template" }, "owner_handle": { "type": "string", "title": "Owner contact handle" }, "remove_nses": { "type": "boolean", "format": "boolean", "title": "Use for deletion of existing nameservers" }, "reseller_handle": { "type": "string", "title": "Reseller handle" }, "reset_auth_code": { "type": "boolean", "format": "boolean", "title": "Resets domain authcode" }, "scheduled_at": { "type": "string", "title": "The scheduled at" }, "tech_handle": { "type": "string", "title": "Tech contact handle" }, "use_domicile": { "type": "boolean", "format": "boolean", "title": "Use of domicile or trustee address for TLDs that require local presence" } }, "example": { "accept_update_fee": 0, "additional_data": { "abogado_acceptance": "", "admin_sing_pass_id": "", "auth_code": "", "company_registration_number": "XX123456789X02", "customer_uin": "374892173498127349", "customer_uin_doc_type": { "description": "Singapore Personal Access ID", "doc_type": "singpass" }, "domain_name_variants": [ "xn--\u0434\u043e\u043c\u0435\u043d.cat" ], "intended_use": "generic", "law_acceptance": "", "legal_type": "Individual", "maintainer": "", "membership_id": "A", "mobile_phone_number_verification": "", "ngo_ong_eligibility_acceptance": "", "ngo_ong_policy_acceptance": "", "passport_number": "X123457", "vat": "11843009X", "verification_code": "" }, "admin_handle": "XX123456-XX", "auth_code": "12345678", "autorenew": "default", "billing_handle": "XX123456-XX", "comments": "Test domain for explaining SSL Panel workflow.", "dnssec_keys": [ { "alg": 8, "flags": 257, "protocol": 3, "pub_key": "WSgigdu8545g96", "readonly": 1 } ], "domain": { "extension": "london", "name": "test4" }, "force_registry_update": false, "id": 0, "is_dnssec_enabled": false, "is_locked": false, "is_private_whois_enabled": false, "is_sectigo_dns_enabled": false, "is_spamexperts_enabled": false, "name_servers": [ { "ip": "12.3.123.121", "ip6": "1s23:123:123:f", "name": "ns1.example.com", "seq_nr": 1 } ], "ns_group": "example", "ns_template_id": 0, "ns_template_name": "Default", "owner_handle": "XX123456-XX", "remove_nses": false, "reseller_handle": "XX123456-XX", "reset_auth_code": false, "scheduled_at": "2019-03-30", "tech_handle": "XX123456-XX", "use_domicile": false } }, "domainUpdateDomainResponse": { "type": "object", "title": "UpdateDomainResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/domainUpdateDomainResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates that the Openprovider system is temporarily unavailable because of maintenance" }, "warnings": { "type": "array", "title": "Contains warning responses if any", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "id": 123456789, "status": "ACT" }, "desc": "" } }, "domainUpdateDomainResponseData": { "type": "object", "title": "UpdateDomainResponseData", "properties": { "id": { "type": "integer", "format": "int32", "title": "Domain id number" }, "status": { "type": "string", "title": "Domain status" } }, "example": { "id": 123456789, "status": "ACT" } }, "domainWhoisPrivacyData": { "type": "object", "title": "WhoisPrivacyData", "properties": { "expiration_date": { "type": "string", "title": "WPP expiration date" } }, "example": { "expiration_date": "2020-04-29 17:15:19" } }, "domain_tokenCreateTokenRequest": { "type": "object", "title": "CreateTokenRequest", "properties": { "domain": { "type": "string", "title": "Domain name" }, "zone_provider": { "type": "string", "title": "Name of the DNS provider" } }, "example": { "domain": "example.com", "zone_provider": "sectigo" } }, "domain_tokenCreateTokenResponse": { "type": "object", "title": "CreateTokenResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "The data", "$ref": "#/definitions/domain_tokenCreateTokenResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "The warnings", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "token": "eyJhbGciOiJIUzI1NiIsInA4cCI6IkpXVCJ9.eyJleHAiOjE1NjQ1NDkDNDAsImRvbWFpbiI6ImRvbWFpbml3YW5uYXJlZ2lzdGVyLm5sLiIsImRvbWFpbl96b25lX2lkIjo5MzA1Mjk0LCJyZXNlbGxlcl9jb250YWN0X2lkIjo0OTQ3OH0.HjL7eZV3p-CvQ6zsMUH0w3xBmUsphTqCBYkOVg3Vxkg", "url": "https://single-domain.example.com?token=eyJhbGciOiJIUzI1NiIsInA4cCI6IkpXVCJ9.eyJleHAiOjE1NjQ1NDkDNDAsImRvbWFpbiI6ImRvbWFpbml3YW5uYXJlZ2lzdGVyLm5sLiIsImRvbWFpbl96b25lX2lkIjo5MzA1Mjk0LCJyZXNlbGxlcl9jb250YWN0X2lkIjo0OTQ3OH0.HjL7eZV3p-CvQ6zsMUH0w3xBmUsphTqCBYkOVg3Vxkg&lang=ru_ru" }, "desc": "" } }, "domain_tokenCreateTokenResponseData": { "type": "object", "title": "CreateTokenResponseData", "properties": { "token": { "type": "string", "title": "The token" }, "url": { "type": "string", "title": "The url" } }, "example": { "token": "eyJhbGciOiJIUzI1NiIsInA4cCI6IkpXVCJ9.eyJleHAiOjE1NjQ1NDkDNDAsImRvbWFpbiI6ImRvbWFpbml3YW5uYXJlZ2lzdGVyLm5sLiIsImRvbWFpbl96b25lX2lkIjo5MzA1Mjk0LCJyZXNlbGxlcl9jb250YWN0X2lkIjo0OTQ3OH0.HjL7eZV3p-CvQ6zsMUH0w3xBmUsphTqCBYkOVg3Vxkg", "url": "https://single-domain.example.com?token=eyJhbGciOiJIUzI1NiIsInA4cCI6IkpXVCJ9.eyJleHAiOjE1NjQ1NDkDNDAsImRvbWFpbiI6ImRvbWFpbml3YW5uYXJlZ2lzdGVyLm5sLiIsImRvbWFpbl96b25lX2lkIjo5MzA1Mjk0LCJyZXNlbGxlcl9jb250YWN0X2lkIjo0OTQ3OH0.HjL7eZV3p-CvQ6zsMUH0w3xBmUsphTqCBYkOVg3Vxkg&lang=ru_ru" } }, "emailCreateEmailRequest": { "type": "object", "title": "CreateEmailRequest", "properties": { "fields": { "type": "array", "title": "Array of template fields and values", "items": { "$ref": "#/definitions/emailFields" } }, "group": { "type": "string", "title": "Email template type. There are several types of ICANN emails that can be customized in Openprovider: -errp (Expired Registration Recovery policy emails) -foa (Form of Authorization emails for domain transfers approval \\ rejection) -ive (Information verification emails, such emails used to verify email address of the customer) -tcn (Trademark Claims Notification emails) -wdrp (Whois Data Reminder Policy emails)" }, "is_active": { "type": "boolean", "format": "boolean", "title": "Indicates, if template is active" }, "is_default": { "type": "boolean", "format": "boolean", "title": "Indicates, if template is used by default" }, "locale": { "type": "array", "title": "Template language. All supported codes http://demo.icu-project.org/icu-bin/locexp", "items": { "type": "string" } }, "name": { "type": "string", "title": "Template name" }, "tags": { "type": "array", "title": "This parameter is optional and allows you to specify a specific tags for object", "items": { "$ref": "#/definitions/emailTags" } } }, "example": { "fields": [ { "name": "senderEmail", "value": "support@resellerA.com" } ], "group": "wdrp", "is_active": false, "is_default": false, "locale": [ "nl_NL" ], "name": "", "tags": [ { "key": "customer", "value": "Reseller A" } ] } }, "emailCreateEmailResponse": { "type": "object", "title": "CreateEmailResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/emailCreateEmailResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates, if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "id": 0 }, "desc": "" } }, "emailCreateEmailResponseData": { "type": "object", "title": "CreateEmailResponseData", "properties": { "id": { "type": "integer", "format": "int32", "title": "Object ID" } }, "example": { "id": 0 } }, "emailDeleteEmailResponse": { "type": "object", "title": "DeleteEmailResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/emailDeleteEmailResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates, if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "success": false }, "desc": "" } }, "emailDeleteEmailResponseData": { "type": "object", "title": "DeleteEmailResponseData", "properties": { "success": { "type": "boolean", "format": "boolean", "title": "Indicates, if operation was successfull" } }, "example": { "success": false } }, "emailDomainEmailVerification": { "type": "object", "title": "DomainEmailVerification", "properties": { "description": { "type": "string", "title": "The description" }, "domain": { "type": "string", "title": "The domain" }, "email": { "type": "string", "title": "The email" }, "expiration_date": { "type": "string", "title": "The expiration date" }, "handle": { "type": "string", "title": "The handle" }, "is_suspended": { "type": "boolean", "format": "boolean", "title": "Is suspended" }, "status": { "type": "string", "title": "The status" } }, "example": { "description": "", "domain": "", "email": "", "expiration_date": "", "handle": "", "is_suspended": false, "status": "" } }, "emailFields": { "type": "object", "title": "Fields", "properties": { "name": { "type": "string", "title": "Template name" }, "value": { "type": "string", "title": "The value of the tag. I.e.:VIP customer" } }, "example": { "name": "senderEmail", "value": "support@resellerA.com" } }, "emailListDomainVerificationsResponse": { "type": "object", "title": "ListDomainVerificationsResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "The code" }, "data": { "title": "The data", "$ref": "#/definitions/emailListDomainVerificationsResponseData" }, "desc": { "type": "string", "title": "The desc" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "The maintenance" }, "warnings": { "type": "array", "title": "The warnings", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "results": [ { "description": "", "domain": "", "email": "", "expiration_date": "", "handle": "", "is_suspended": false, "status": "" } ], "total": 0 }, "desc": "" } }, "emailListDomainVerificationsResponseData": { "type": "object", "title": "ListDomainVerificationsResponseData", "properties": { "results": { "type": "array", "title": "The results", "items": { "$ref": "#/definitions/emailDomainEmailVerification" } }, "total": { "type": "integer", "format": "int32", "title": "The total" } }, "example": { "results": [ { "description": "", "domain": "", "email": "", "expiration_date": "", "handle": "", "is_suspended": false, "status": "" } ], "total": 0 } }, "emailListEmailsResponse": { "type": "object", "title": "ListEmailsResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/emailListEmailsResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates, if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "results": [ { "fields": [ { "name": "senderEmail", "value": "support@resellerA.com" } ], "group": "ive", "id": 0, "is_active": false, "is_default": false, "locale": [ "nl_NL" ], "name": "", "tags": [ { "key": "customer", "value": "Reseller A" } ] } ], "total": 999 }, "desc": "" } }, "emailListEmailsResponseData": { "type": "object", "title": "ListEmailsResponseData", "properties": { "results": { "type": "array", "title": "Array of results", "items": { "$ref": "#/definitions/emailListEmailsResponseDataResults" } }, "total": { "type": "integer", "format": "int32", "title": "Results count" } }, "example": { "results": [ { "fields": [ { "name": "senderEmail", "value": "support@resellerA.com" } ], "group": "ive", "id": 0, "is_active": false, "is_default": false, "locale": [ "nl_NL" ], "name": "", "tags": [ { "key": "customer", "value": "Reseller A" } ] } ], "total": 999 } }, "emailListEmailsResponseDataResults": { "type": "object", "title": "ListEmailsResponseDataResults", "properties": { "fields": { "type": "array", "title": "Array of template fields and values", "items": { "$ref": "#/definitions/emailFields" } }, "group": { "type": "string", "title": "Email template type. There are several types of ICANN emails that can be customized in Openprovider: -errp (Expired Registration Recovery policy emails) -foa (Form of Authorization emails for domain transfers approval \\ rejection) -ive (Information verification emails, such emails used to verify email address of the customer) -tcn (Trademark Claims Notification emails) -wdrp (Whois Data Reminder Policy emails)" }, "id": { "type": "integer", "format": "int32", "title": "Object ID" }, "is_active": { "type": "boolean", "format": "boolean", "title": "Indicates, if template is active" }, "is_default": { "type": "boolean", "format": "boolean", "title": "Indicates, if template is used by default" }, "locale": { "type": "array", "title": "Template language. All supported codes http://demo.icu-project.org/icu-bin/locexp", "items": { "type": "string" } }, "name": { "type": "string", "title": "Template name" }, "tags": { "type": "array", "title": "This parameter is optional and allows you to specify a specific tags for object", "items": { "$ref": "#/definitions/emailTags" } } }, "example": { "fields": [ { "name": "senderEmail", "value": "support@resellerA.com" } ], "group": "ive", "id": 0, "is_active": false, "is_default": false, "locale": [ "nl_NL" ], "name": "", "tags": [ { "key": "customer", "value": "Reseller A" } ] } }, "emailRestartEmailVerificationRequest": { "type": "object", "title": "RestartEmailVerificationRequest", "properties": { "email": { "type": "string", "title": "Email address" }, "language": { "type": "string", "title": "The language" }, "tag": { "type": "string", "title": "The tag" } }, "example": { "email": "test@mail.tld", "language": "", "tag": "" } }, "emailRestartEmailVerificationResponse": { "type": "object", "title": "RestartEmailVerificationResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/emailRestartEmailVerificationResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "success": false }, "desc": "" } }, "emailRestartEmailVerificationResponseData": { "type": "object", "title": "RestartEmailVerificationResponseData", "properties": { "success": { "type": "boolean", "format": "boolean", "title": "Indicates if operation was successful" } }, "example": { "success": false } }, "emailStartEmailVerificationRequest": { "type": "object", "title": "StartEmailVerificationRequest", "properties": { "email": { "type": "string", "title": "Email address" }, "handle": { "type": "string", "title": "Customer's handle" }, "language": { "type": "string", "title": "The language" }, "tag": { "type": "string", "title": "The tag" } }, "example": { "email": "test@mail.tld", "handle": "", "language": "", "tag": "" } }, "emailStartEmailVerificationResponse": { "type": "object", "title": "StartEmailVerificationResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/emailStartEmailVerificationResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 20001, "data": { "id": 123456789 }, "desc": "Verification email in progress" } }, "emailStartEmailVerificationResponseData": { "type": "object", "title": "StartEmailVerificationResponseData", "properties": { "id": { "type": "integer", "format": "int32", "title": "Object ID" } }, "example": { "id": 123456789 } }, "emailTags": { "type": "object", "title": "Tags", "properties": { "key": { "type": "string", "title": "The key of the tag. Allowed values: 'customer'" }, "value": { "type": "string", "title": "The value of the tag. I.e.:VIP customer" } }, "example": { "key": "customer", "value": "Reseller A" } }, "emailUpdateEmailRequest": { "type": "object", "title": "UpdateEmailRequest", "properties": { "fields": { "type": "array", "title": "Array of template fields and values", "items": { "$ref": "#/definitions/emailFields" } }, "group": { "type": "string", "title": "The group" }, "id": { "type": "integer", "format": "int32", "title": "Object ID" }, "is_active": { "type": "boolean", "format": "boolean", "title": "Indicates, if template is active" }, "is_default": { "type": "boolean", "format": "boolean", "title": "Indicates, if template is used by default" }, "locale": { "type": "array", "title": "Template language. All supported codes http://demo.icu-project.org/icu-bin/locexp", "items": { "type": "string" } }, "name": { "type": "string", "title": "The name" }, "tags": { "type": "array", "title": "This parameter is optional and allows you to specify a specific tags for object", "items": { "$ref": "#/definitions/emailTags" } } }, "example": { "fields": [ { "name": "senderEmail", "value": "support@resellerA.com" } ], "group": "", "id": 0, "is_active": false, "is_default": false, "locale": [ "nl_NL" ], "name": "", "tags": [ { "key": "customer", "value": "Reseller A" } ] } }, "emailUpdateEmailResponse": { "type": "object", "title": "UpdateEmailResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/emailUpdateEmailResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates, if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "success": false }, "desc": "" } }, "emailUpdateEmailResponseData": { "type": "object", "title": "UpdateEmailResponseData", "properties": { "success": { "type": "boolean", "format": "boolean", "title": "Indicates, if operation was successfull" } }, "example": { "success": false } }, "emailVerificationRecipient": { "type": "object", "title": "VerificationRecipient", "properties": { "to": { "type": "string", "title": "The to" }, "type": { "type": "string", "title": "The type" } }, "example": { "to": "recipient@example.com", "type": "email" } }, "errorError": { "type": "object", "title": "Error", "properties": { "code": { "type": "integer", "format": "int32", "title": "Error code" }, "data": { "type": "string", "title": "Additional error description" }, "desc": { "type": "string", "title": "Error description" } }, "example": { "code": 0, "data": "", "desc": "" } }, "errorWarning": { "type": "object", "title": "Warning", "properties": { "code": { "type": "integer", "format": "int32", "title": "Warning code" }, "data": { "type": "string", "title": "Additional warning description" }, "desc": { "type": "string", "title": "Warning description" } }, "example": { "code": 0, "data": "", "desc": "" } }, "helperstagTag": { "type": "object", "title": "Tag", "properties": { "key": { "type": "string", "title": "The key of the tag. Allowed values: 'customer'" }, "value": { "type": "string", "title": "The value of the tag. I.e.: VIP customer" } }, "example": { "key": "customer", "value": "example" } }, "historyZoneHistory": { "type": "object", "title": "ZoneHistory", "properties": { "date": { "type": "string", "title": "Date of operation" }, "is": { "type": "string", "title": "New value" }, "source": { "type": "string", "title": "The source" }, "was": { "type": "string", "title": "Old value" } }, "example": { "date": "2019-06-19 17:40:09", "is": "+ A | | 8.8.8.8", "source": "", "was": "" } }, "invoiceInvoice": { "type": "object", "title": "Invoice", "properties": { "amount": { "title": "The amount", "$ref": "#/definitions/invoicePrices" }, "attachment_url": { "type": "string", "title": "The attachment url" }, "creation_date": { "type": "string", "title": "The creation date" }, "id": { "type": "integer", "format": "int32", "title": "The id" }, "invoice_number": { "type": "string", "title": "The invoice number" }, "invoice_url": { "type": "string", "title": "The invoice url" } }, "example": { "amount": { "product": { "currency": "EUR", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } }, "attachment_url": "https://rest.openprovider.eu/invoice/XX123456?token=&type=invoice", "creation_date": "2006-09-29 0:00:00", "id": 1, "invoice_number": "XX123456", "invoice_url": "https://rest.openprovider.eu/invoice/XX123456?token=&type=invoice" } }, "invoiceListInvoicesResponse": { "type": "object", "title": "ListInvoicesResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "The code" }, "data": { "title": "The data", "$ref": "#/definitions/invoiceListInvoicesResponseData" }, "desc": { "type": "string", "title": "The desc" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "The maintenance" }, "warnings": { "type": "array", "title": "The warnings", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "results": [ { "amount": { "product": { "currency": "EUR", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } }, "attachment_url": "https://rest.openprovider.eu/invoice/XX123456?token=&type=invoice", "creation_date": "2006-09-29 0:00:00", "id": 1, "invoice_number": "XX123456", "invoice_url": "https://rest.openprovider.eu/invoice/XX123456?token=&type=invoice" } ], "total": 0 }, "desc": "" } }, "invoiceListInvoicesResponseData": { "type": "object", "title": "ListInvoicesResponseData", "properties": { "results": { "type": "array", "title": "The results", "items": { "$ref": "#/definitions/invoiceInvoice" } }, "total": { "type": "integer", "format": "int32", "title": "The total" } }, "example": { "results": [ { "amount": { "product": { "currency": "EUR", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } }, "attachment_url": "https://rest.openprovider.eu/invoice/XX123456?token=&type=invoice", "creation_date": "2006-09-29 0:00:00", "id": 1, "invoice_number": "XX123456", "invoice_url": "https://rest.openprovider.eu/invoice/XX123456?token=&type=invoice" } ], "total": 0 } }, "invoicePrice": { "type": "object", "title": "Price", "properties": { "currency": { "type": "string", "title": "The currency" }, "price": { "type": "number", "format": "double", "title": "The price" } }, "example": { "currency": "EUR", "price": 0 } }, "invoicePrices": { "type": "object", "title": "Prices", "properties": { "product": { "title": "Price in product currency", "$ref": "#/definitions/invoicePrice" }, "reseller": { "title": "Price in reseller currency", "$ref": "#/definitions/invoicePrice" } }, "example": { "product": { "currency": "EUR", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } } }, "licenseCreateLicenseResponseData": { "type": "object", "title": "CreateLicenseResponseData", "properties": { "attached_keys": { "type": "array", "title": "Third-party extension keys", "items": { "type": "integer", "format": "int32" } }, "key_id": { "type": "integer", "format": "int32", "title": "License key ID" } }, "example": { "attached_keys": [ 123456 ], "key_id": 123456 } }, "licenseCreatePleskLicenseRequest": { "type": "object", "title": "CreatePleskLicenseRequest", "properties": { "attached_keys": { "type": "array", "title": "Third-party extension keys", "items": { "type": "string" } }, "comment": { "type": "string", "title": "Custom notes" }, "ip_address_binding": { "type": "string", "title": "IP addess to bind license to" }, "items": { "type": "array", "title": "List of license items", "items": { "type": "string" } }, "parent_key_id": { "type": "integer", "format": "int32", "title": "Key ID of the partent license" }, "period": { "type": "integer", "format": "int32", "title": "Period for which license is active" }, "restrict_ip_binding": { "type": "boolean", "format": "boolean", "title": "Indicates, if license is bound to an IP" }, "title": { "type": "string", "title": "Custom license title" } } }, "licenseCreatePleskLicenseResponse": { "type": "object", "title": "CreatePleskLicenseResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/licenseCreateLicenseResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates, if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "attached_keys": [ 123456 ], "key_id": 123456 }, "desc": "" } }, "licenseCreateVirtuozzoLicenseRequest": { "type": "object", "title": "CreateVirtuozzoLicenseRequest", "properties": { "attached_keys": { "type": "array", "title": "Third-party extension keys", "items": { "type": "string" } }, "comment": { "type": "string", "title": "Custom notes" }, "ip_address_binding": { "type": "string", "title": "IP addess to bind license to" }, "items": { "type": "array", "title": "List of license items", "items": { "type": "string" } }, "parent_key_id": { "type": "integer", "format": "int32", "title": "Key ID of the partent license" }, "pcs_capacity": { "type": "integer", "format": "int32", "title": "Virtuozzzo storage capacity in 100 Gb blocks" }, "period": { "type": "integer", "format": "int32", "title": "Period for which license is active" }, "restrict_ip_binding": { "type": "boolean", "format": "boolean", "title": "Indicates, if license is bound to an IP" }, "title": { "type": "string", "title": "Custom license title" } } }, "licenseCreateVirtuozzoLicenseResponse": { "type": "object", "title": "CreateVirtuozzoLicenseResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/licenseCreateLicenseResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates, if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "attached_keys": [ 123456 ], "key_id": 123456 }, "desc": "" } }, "licenseDeleteLicenseResponse": { "type": "object", "title": "DeleteLicenseResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/licenseDeleteLicenseResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates, if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "success": false }, "desc": "" } }, "licenseDeleteLicenseResponseData": { "type": "object", "title": "DeleteLicenseResponseData", "properties": { "success": { "type": "boolean", "format": "boolean", "title": "Indicates, if operation was succesful" } }, "example": { "success": false } }, "licenseExtendedLicense": { "type": "object", "title": "ExtendedLicense", "properties": { "activation_code": { "type": "string", "title": "License activation code" }, "billing_type": { "type": "string", "title": "License billing type" }, "comment": { "type": "string", "title": "Custom notes" }, "contract": { "type": "string", "title": "Openprovider contract version" }, "expiration_date": { "type": "string", "title": "License expiration date" }, "extensions": { "type": "array", "title": "License extensions", "items": { "$ref": "#/definitions/licenseExtendedLicense" } }, "features": { "type": "array", "title": "License features", "items": { "$ref": "#/definitions/licenseLicenseItem" } }, "ip_address_binding": { "type": "string", "title": "IP addess to bind license to" }, "items": { "type": "array", "title": "List of license items", "items": { "type": "string" } }, "key": { "title": "License key", "$ref": "#/definitions/licenseKey" }, "key_id": { "type": "integer", "format": "int32", "title": "License key ID" }, "key_number": { "type": "string", "title": "License key number" }, "order_date": { "type": "string", "title": "License order date" }, "parent_key_id": { "type": "integer", "format": "int32", "title": "Key ID of the partent license" }, "period": { "type": "integer", "format": "int32", "title": "Period for which license is active" }, "product": { "type": "string", "title": "Product type (only Plesk is available)" }, "sku_values": { "type": "object", "title": "List of license SKU values", "additionalProperties": { "type": "boolean", "format": "boolean" } }, "status": { "type": "string", "title": "License status" }, "title": { "type": "string", "title": "Custom license title" } } }, "licenseGetLicenseKeyResponse": { "type": "object", "title": "GetLicenseKeyResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/licenseLicenseKey" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates, if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "key": "" }, "desc": "" } }, "licenseGetLicenseResponse": { "type": "object", "title": "GetLicenseResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/licenseExtendedLicense" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates, if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } } }, "licenseKey": { "type": "object", "title": "Key", "properties": { "item": { "type": "string", "title": "License item" }, "product": { "type": "string", "title": "Product type (only Plesk is available)" }, "sku_values": { "type": "object", "title": "List of license SKU values", "additionalProperties": { "type": "boolean", "format": "boolean" } }, "title": { "type": "string", "title": "Custom license title" } }, "example": { "item": "PLESK-12-VPS-WEB-HOST-1M", "product": "plesk", "sku_values": null, "title": "Plesk for VPS Web Host Edition" } }, "licenseLicenseItem": { "type": "object", "title": "LicenseItem", "properties": { "item": { "type": "string", "title": "License item" }, "product": { "type": "string", "title": "Product type (only Plesk is available)" }, "sku_values": { "type": "object", "title": "List of license SKU values", "additionalProperties": { "type": "boolean", "format": "boolean" } }, "title": { "type": "string", "title": "Custom license title" } }, "example": { "item": "FT-PLESK-VPS-WPB-100-SITES-1M", "product": "plesk", "sku_values": null, "title": "DNSSEC for Plesk (Bundled)" } }, "licenseLicenseKey": { "type": "object", "title": "LicenseKey", "properties": { "key": { "type": "string", "title": "License key" } }, "example": { "key": "" } }, "licenseLicenseWithPriceVersion": { "type": "object", "title": "LicenseWithPriceVersion", "properties": { "activation_code": { "type": "string", "title": "License activation code" }, "billing_type": { "type": "string", "title": "License billing type" }, "comment": { "type": "string", "title": "Custom notes" }, "contract": { "type": "string", "title": "Openprovider contract version" }, "expiration_date": { "type": "string", "title": "License expiration date" }, "items": { "type": "array", "title": "List of license items", "items": { "type": "string" } }, "key_id": { "type": "integer", "format": "int32", "title": "License key ID" }, "key_number": { "type": "string", "title": "License key number" }, "order_date": { "type": "string", "title": "License order date" }, "parent_key_id": { "type": "integer", "format": "int32", "title": "Key ID of the partent license" }, "period": { "type": "integer", "format": "int32", "title": "Period for which license is active" }, "product": { "type": "string", "title": "Product type (only Plesk is available)" }, "sku_values": { "type": "object", "title": "List of license SKU values", "additionalProperties": { "type": "boolean", "format": "boolean" } }, "status": { "type": "string", "title": "License status" }, "title": { "type": "string", "title": "Custom license title" } } }, "licenseListItemsOrderBy": { "type": "object", "title": "ListItemsOrderBy", "properties": { "expiration_date": { "type": "string", "title": "License expiration date" }, "id": { "type": "string", "title": "Object ID" }, "key_id": { "type": "string", "title": "License key ID" }, "key_number": { "type": "string", "title": "License key number" }, "product": { "type": "string", "title": "Product type (only Plesk is available)" }, "status": { "type": "string", "title": "License status" }, "title": { "type": "string", "title": "Custom license title" } }, "example": { "expiration_date": "", "id": "", "key_id": "", "key_number": "", "product": "", "status": "", "title": "asc" } }, "licenseListItemsResponse": { "type": "object", "title": "ListItemsResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/licenseListItemsResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates, if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "results": [ { "item": "FT-PLESK-VPS-WPB-100-SITES-1M", "product": "plesk", "sku_values": null, "title": "DNSSEC for Plesk (Bundled)" } ], "total": 999 }, "desc": "" } }, "licenseListItemsResponseData": { "type": "object", "title": "ListItemsResponseData", "properties": { "results": { "type": "array", "title": "Array of results", "items": { "$ref": "#/definitions/licenseLicenseItem" } }, "total": { "type": "integer", "format": "int32", "title": "Results count" } }, "example": { "results": [ { "item": "FT-PLESK-VPS-WPB-100-SITES-1M", "product": "plesk", "sku_values": null, "title": "DNSSEC for Plesk (Bundled)" } ], "total": 999 } }, "licenseListLicensesOrderBy": { "type": "object", "title": "ListLicensesOrderBy", "properties": { "expiration_date": { "type": "string", "title": "License expiration date" }, "id": { "type": "string", "title": "Object ID" }, "key_id": { "type": "string", "title": "License key ID" }, "key_number": { "type": "string", "title": "License key number" }, "product": { "type": "string", "title": "Product type (only Plesk is available)" }, "status": { "type": "string", "title": "License status" }, "title": { "type": "string", "title": "Custom license title" } }, "example": { "expiration_date": "", "id": "", "key_id": "desc", "key_number": "", "product": "", "status": "", "title": "" } }, "licenseListLicensesResponse": { "type": "object", "title": "ListLicensesResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/licenseListLicensesResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates, if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } } }, "licenseListLicensesResponseData": { "type": "object", "title": "ListLicensesResponseData", "properties": { "results": { "type": "array", "title": "Array of results", "items": { "$ref": "#/definitions/licenselicenseLicense" } }, "total": { "type": "integer", "format": "int32", "title": "Results count" } } }, "licenseListLicensesWithPriceVersionResponse": { "type": "object", "title": "ListLicensesWithPriceVersionResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/licenseListLicensesWithPriceVersionResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates, if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } } }, "licenseListLicensesWithPriceVersionResponseData": { "type": "object", "title": "ListLicensesWithPriceVersionResponseData", "properties": { "results": { "type": "array", "title": "Array of results", "items": { "$ref": "#/definitions/licenseLicenseWithPriceVersion" } }, "total": { "type": "integer", "format": "int32", "title": "Results count" } } }, "licenseResetHwidRequest": { "type": "object", "title": "ResetHwidRequest", "properties": { "key_id": { "type": "integer", "format": "int32", "title": "License key ID" }, "product": { "type": "string", "title": "Product type (only Plesk is available)" } }, "example": { "key_id": 12345, "product": "plesk" } }, "licenseResetHwidResponse": { "type": "object", "title": "ResetHwidResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/licenseResetHwidResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates, if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "success": false }, "desc": "" } }, "licenseResetHwidResponseData": { "type": "object", "title": "ResetHwidResponseData", "properties": { "success": { "type": "boolean", "format": "boolean", "title": "Indicates, if operation was succesful" } }, "example": { "success": false } }, "licenseUpdateLicenseResponse": { "type": "object", "title": "UpdateLicenseResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/licenseUpdateLicenseResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates, if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "success": false }, "desc": "" } }, "licenseUpdateLicenseResponseData": { "type": "object", "title": "UpdateLicenseResponseData", "properties": { "success": { "type": "boolean", "format": "boolean", "title": "Indicates, if operation was succesful" } }, "example": { "success": false } }, "licenseUpdatePleskLicenseRequest": { "type": "object", "title": "UpdatePleskLicenseRequest", "properties": { "attached_keys": { "type": "array", "title": "Third-party extension keys", "items": { "type": "string" } }, "comment": { "type": "string", "title": "Custom notes" }, "ip_address_binding": { "type": "string", "title": "IP addess to bind license to" }, "items": { "type": "array", "title": "List of license items", "items": { "type": "string" } }, "key_id": { "type": "integer", "format": "int32", "title": "License key ID" }, "parent_key_id": { "type": "integer", "format": "int32", "title": "Key ID of the partent license" }, "period": { "type": "integer", "format": "int32", "title": "Period for which license is active" }, "restrict_ip_binding": { "type": "boolean", "format": "boolean", "title": "Indicates, if license is bound to an IP" }, "suspended": { "type": "boolean", "format": "boolean", "title": "Indicates, if license is suspended" }, "title": { "type": "string", "title": "Custom license title" } } }, "licenseUpdateVirtuozzoLicenseRequest": { "type": "object", "title": "UpdateVirtuozzoLicenseRequest", "properties": { "attached_keys": { "type": "array", "title": "Third-party extension keys", "items": { "type": "string" } }, "comment": { "type": "string", "title": "Custom notes" }, "ip_address_binding": { "type": "string", "title": "IP addess to bind license to" }, "items": { "type": "array", "title": "List of license items", "items": { "type": "string" } }, "key_id": { "type": "integer", "format": "int32", "title": "License key ID" }, "parent_key_id": { "type": "integer", "format": "int32", "title": "Key ID of the partent license" }, "pcs_capacity": { "type": "integer", "format": "int32", "title": "Virtuozzzo storage capacity in 100 Gb blocks" }, "period": { "type": "integer", "format": "int32", "title": "Period for which license is active" }, "restrict_ip_binding": { "type": "boolean", "format": "boolean", "title": "Indicates, if license is bound to an IP" }, "suspended": { "type": "boolean", "format": "boolean", "title": "Indicates, if license is suspended" }, "title": { "type": "string", "title": "Custom license title" } } }, "licenselicenseLicense": { "type": "object", "title": "License", "properties": { "activation_code": { "type": "string", "title": "License activation code" }, "billing_type": { "type": "string", "title": "License billing type" }, "comment": { "type": "string", "title": "Custom notes" }, "contract": { "type": "string", "title": "Openprovider contract version" }, "expiration_date": { "type": "string", "title": "License expiration date" }, "ip_address_binding": { "type": "string", "title": "IP addess to bind license to" }, "items": { "type": "array", "title": "List of license items", "items": { "type": "string" } }, "key_id": { "type": "integer", "format": "int32", "title": "License key ID" }, "key_number": { "type": "string", "title": "License key number" }, "order_date": { "type": "string", "title": "License order date" }, "parent_key_id": { "type": "integer", "format": "int32", "title": "Key ID of the partent license" }, "period": { "type": "integer", "format": "int32", "title": "Period for which license is active" }, "product": { "type": "string", "title": "Product type (only Plesk is available)" }, "sku_values": { "type": "object", "title": "List of license SKU values", "additionalProperties": { "type": "boolean", "format": "boolean" } }, "status": { "type": "string", "title": "License status" }, "title": { "type": "string", "title": "Custom license title" } } }, "nameserverCreateNameserverResponse": { "type": "object", "title": "CreateNameserverResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "The data", "$ref": "#/definitions/nameserverNameserver" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "The warnings", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "ip": "127.0.0.1", "ip6": "0001:0001:0001:0001:0001:0001:0001:0001", "name": "ns1.domain.com" }, "desc": "" } }, "nameserverGetNameserverResponse": { "type": "object", "title": "GetNameserverResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "The data", "$ref": "#/definitions/nameserverNameserver" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "The warnings", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "ip": "127.0.0.1", "ip6": "0001:0001:0001:0001:0001:0001:0001:0001", "name": "ns1.domain.com" }, "desc": "" } }, "nameserverListNameserversResponse": { "type": "object", "title": "ListNameserversResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "The data", "$ref": "#/definitions/nameserverListNameserversResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "The warnings", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "results": [ { "ip": "127.0.0.1", "ip6": "0001:0001:0001:0001:0001:0001:0001:0001", "name": "ns1.domain.com" } ], "total": 9 }, "desc": "" } }, "nameserverListNameserversResponseData": { "type": "object", "title": "ListNameserversResponseData", "properties": { "results": { "type": "array", "title": "Array of results", "items": { "$ref": "#/definitions/nameserverNameserver" } }, "total": { "type": "integer", "format": "int32", "title": "Results count" } }, "example": { "results": [ { "ip": "127.0.0.1", "ip6": "0001:0001:0001:0001:0001:0001:0001:0001", "name": "ns1.domain.com" } ], "total": 9 } }, "nameserverNameserver": { "type": "object", "title": "Nameserver", "properties": { "ip": { "type": "string", "title": "Nameserver IP" }, "ip6": { "type": "string", "title": "Nameserver IPv6" }, "name": { "type": "string", "title": "Nameserver name" } }, "example": { "ip": "127.0.0.1", "ip6": "0001:0001:0001:0001:0001:0001:0001:0001", "name": "ns1.domain.com" } }, "nameserverNameserverBoolResponse": { "type": "object", "title": "NameserverBoolResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "The data", "$ref": "#/definitions/nameserverNameserverBoolResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "The warnings", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "success": false }, "desc": "" } }, "nameserverNameserverBoolResponseData": { "type": "object", "title": "NameserverBoolResponseData", "properties": { "success": { "type": "boolean", "format": "boolean", "title": "Indicates if request was successful" } }, "example": { "success": false } }, "ns_groupCreateGroupRequest": { "type": "object", "title": "CreateGroupRequest", "properties": { "name_servers": { "type": "array", "title": "Set of nameservers and their IP addresses", "items": { "$ref": "#/definitions/ns_groupNameServersSet" } }, "ns_group": { "description": "Plain text name of the nameserver group, which can consist of several nameservers with attached IPs. Once created in Openprovider reseller account, nameserver group can be reused for operations with domains.", "type": "string" } }, "example": { "name_servers": [ { "id": 0, "ip": "127.0.0.1", "ip6": "0001:0001:0001:0001:0001:0001:0001:0001", "name": "ns1.domain.com", "seq_nr": 0 } ], "ns_group": "MyGroup" } }, "ns_groupCreateGroupResponse": { "type": "object", "title": "CreateGroupResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "The data", "$ref": "#/definitions/ns_groupGroupBoolResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "The warnings", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "success": false }, "desc": "" } }, "ns_groupGetGroupResponse": { "type": "object", "title": "GetGroupResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "The data", "$ref": "#/definitions/ns_groupGroup" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "The warnings", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "domain_count": 0, "id": 0, "name_servers": [ { "id": 0, "ip": "127.0.0.1", "ip6": "0001:0001:0001:0001:0001:0001:0001:0001", "name": "ns1.domain.com", "seq_nr": 0 } ], "ns_count": 0, "ns_group": "mygroup" }, "desc": "" } }, "ns_groupGroup": { "type": "object", "title": "Group", "properties": { "domain_count": { "type": "integer", "format": "int32", "title": "Number of domains associated with the group" }, "id": { "type": "integer", "format": "int32", "title": "Nameserver group ID" }, "name_servers": { "type": "array", "title": "List of nameservers", "items": { "$ref": "#/definitions/ns_groupNameServersSet" } }, "ns_count": { "type": "integer", "format": "int32", "title": "Number of nameservers associated with the group" }, "ns_group": { "type": "string", "title": "Nameserver group name" } }, "example": { "domain_count": 0, "id": 0, "name_servers": [ { "id": 0, "ip": "127.0.0.1", "ip6": "0001:0001:0001:0001:0001:0001:0001:0001", "name": "ns1.domain.com", "seq_nr": 0 } ], "ns_count": 0, "ns_group": "mygroup" } }, "ns_groupGroupBoolResponse": { "type": "object", "title": "GroupBoolResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "The data", "$ref": "#/definitions/ns_groupGroupBoolResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "The warnings", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "success": false }, "desc": "" } }, "ns_groupGroupBoolResponseData": { "type": "object", "title": "GroupBoolResponseData", "properties": { "success": { "type": "boolean", "format": "boolean", "title": "Indicates if request has been succesful" } }, "example": { "success": false } }, "ns_groupListGroupsOrderBy": { "type": "object", "title": "ListGroupsOrderBy", "properties": { "domain_count": { "type": "string", "title": "Sorting type (asc/desc)" }, "ns_count": { "type": "string", "title": "Sorting type (asc/desc)" }, "ns_group": { "type": "string", "title": "Sorting type (asc/desc)", "default": "asc" } }, "example": { "domain_count": "", "ns_count": "", "ns_group": "asc" } }, "ns_groupListGroupsResponse": { "type": "object", "title": "ListGroupsResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "The data", "$ref": "#/definitions/ns_groupListGroupsResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "The warnings", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "results": [ { "domain_count": 0, "id": 0, "name_servers": [ { "id": 0, "ip": "127.0.0.1", "ip6": "0001:0001:0001:0001:0001:0001:0001:0001", "name": "ns1.domain.com", "seq_nr": 0 } ], "ns_count": 0, "ns_group": "mygroup" } ], "total": 17 }, "desc": "" } }, "ns_groupListGroupsResponseData": { "type": "object", "title": "ListGroupsResponseData", "properties": { "results": { "type": "array", "title": "Array of request results", "items": { "$ref": "#/definitions/ns_groupGroup" } }, "total": { "type": "integer", "format": "int32", "title": "Results count" } }, "example": { "results": [ { "domain_count": 0, "id": 0, "name_servers": [ { "id": 0, "ip": "127.0.0.1", "ip6": "0001:0001:0001:0001:0001:0001:0001:0001", "name": "ns1.domain.com", "seq_nr": 0 } ], "ns_count": 0, "ns_group": "mygroup" } ], "total": 17 } }, "ns_groupNameServersSet": { "type": "object", "title": "NameServersSet", "properties": { "id": { "type": "integer", "format": "int32", "title": "Nameserver ID" }, "ip": { "type": "string", "title": "Nameserver IP" }, "ip6": { "type": "string", "title": "Nameserver IPv6" }, "name": { "type": "string", "title": "Nameserver name" }, "seq_nr": { "type": "integer", "format": "int32", "title": "Nameserver position in the group" } }, "example": { "id": 0, "ip": "127.0.0.1", "ip6": "0001:0001:0001:0001:0001:0001:0001:0001", "name": "ns1.domain.com", "seq_nr": 0 } }, "ns_groupUpdateGroupRequest": { "type": "object", "title": "UpdateGroupRequest", "properties": { "name_servers": { "type": "array", "title": "Set of nameservers and their IP addresses", "items": { "$ref": "#/definitions/ns_groupNameServersSet" } }, "ns_group": { "description": "Plain text name of the nameserver group, which can consist of several nameservers with attached IPs. Once created in Openprovider reseller account, nameserver group can be reused for operations with domains.", "type": "string" } }, "example": { "name_servers": [ { "id": 0, "ip": "127.0.0.1", "ip6": "0001:0001:0001:0001:0001:0001:0001:0001", "name": "ns1.domain.com", "seq_nr": 0 } ], "ns_group": "MyGroup" } }, "orderCancelOrderRequest": { "type": "object", "title": "CancelOrderRequest", "properties": { "id": { "type": "integer", "format": "int32", "title": "Object id" } }, "example": { "id": 1 } }, "orderCancelOrderResponse": { "type": "object", "title": "CancelOrderResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/orderCancelOrderResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "id": 1 }, "desc": "" } }, "orderCancelOrderResponseData": { "type": "object", "title": "CancelOrderResponseData", "properties": { "id": { "type": "integer", "format": "int32", "title": "Object id" } }, "example": { "id": 1 } }, "orderCreateEasyDmarcRequest": { "type": "object", "title": "CreateEasyDmarcRequest", "properties": { "domain": { "title": "Domain name and extension", "$ref": "#/definitions/orderDomain" }, "owner_handle": { "type": "string", "title": "Domain owner handle value" } }, "example": { "domain": { "extension": "london", "name": "test4" }, "owner_handle": "XX123456-XX" } }, "orderCreateEasyDmarcResponse": { "type": "object", "title": "CreateEasyDmarcResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/orderEasyDmarcOrder" }, "desc": { "type": "string", "title": "Response description" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "activated_at": "2019-01-01 0:00:01", "domain": { "extension": "london", "name": "test4" }, "easydmarc_email_address": "", "expired_at": "2019-01-01 0:00:01", "id": 123456789, "recent_easydmarc_action": { "message": "", "recent_action": "enabled" }, "record_host": "", "record_type": "", "record_value": "", "renew_at": "2019-01-01 0:00:01", "status": "" }, "desc": "" } }, "orderCreateOrderRequest": { "type": "object", "title": "CreateOrderRequest", "properties": { "approver_email": { "description": "Email for domain ownership verification. Should start with well-known generic name like admin@, hostmater@, administrator@, etc.", "type": "string" }, "autorenew": { "type": "string", "title": "Indicates, whether the certificate should be renewed automatically once its expiration date is reached", "default": "off" }, "csr": { "type": "string", "title": "Certificate signing request" }, "domain_amount": { "type": "integer", "format": "int32", "title": "Number of domains to include in certificate" }, "domain_validation_methods": { "type": "array", "title": "Method of domain validation", "items": { "$ref": "#/definitions/orderSslOrderDomainValidationMethods" } }, "enable_dns_automation": { "type": "boolean", "format": "boolean", "title": "Indicates whether the automatic DNS validation will be applied to the certificate", "default": false }, "host_names": { "type": "array", "title": "List of domain names to protect", "items": { "type": "string" } }, "organization_handle": { "type": "string", "title": "Handle of the organization contact" }, "period": { "type": "integer", "format": "int32", "title": "Certificate issuance period" }, "product_id": { "type": "integer", "format": "int32", "title": "ID of product order will be created for" }, "signature_hash_algorithm": { "type": "string", "title": "Certificate has algorithm. Set to sha2 or leave blank" }, "software_id": { "type": "string", "title": "Software used on host where certificate will be installed" }, "start_provision": { "type": "boolean", "format": "boolean", "title": "Indicates, whether a validation request should be sent to CA. If false, UpdateOrder method should be used later to change the setting and begin validation", "default": false }, "technical_handle": { "type": "string", "title": "Handle of the technical contact" }, "wildcard_domain_amount": { "type": "integer", "format": "int32", "title": "Amount of the wildcard domains in the order" } }, "example": { "approver_email": "admin@example.com", "autorenew": "off", "csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIIC0TCCAbkCAQAwgYsxCzAJBgNVBAYTAkFVMREwDwYDVQQIDAhleGFtcGxlczER\nMA8GA1UEBwwIZXhhbXBsZXMxETAPBgNVBAoMCGV4YW1wbGVzMQswCQYDVQQLDAJp\ndDEUMBIGA1UEAwwLZXhhbXBsZS5jb20xIDAeBgkqhkiG9w0BCQEWEWFkbWluQGV4\nYW1wbGUuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA6XbdNhvH\nRldtqE8iNm1Da0z+rkmAJlEtKUjqz5CDGcA9ByCLQ4qBIsSAkRgElBonMyR8lLDK\nh5Ac9jrkg40zrrXCl8TQ4sW5GFavwBPKCTHQu0EhovGWdV490+oOTVBckBW6niI5\nyaezhL4ZJzd4smrqoH3fPYPgLcb7+Lb4fsMfavRrallMrHP612bLm0mOpXKcwHos\nqBdC3OW2v64MnBdla3ZcPKFG8ThcdJoD9sym1EtKsm3MbyT9d8r3D+L2+xqZOjww\nacElCLmZ8Ep4aQVx0GRbJoDEA1Yy7A9YC4E+SObW7daquTX+zymeK0k1mACmOwvo\nJOrjLIhUbjJDtQIDAQABoAAwDQYJKoZIhvcNAQELBQADggEBANBGBu55iuzTYc4S\nZW3F8flSd0cO8ubKII6WcwHJrk8NIlAgfduAuNRuG9CAba0e72Ea0xKIhXSzxbDi\ncq9Yl0rkovY95ZyRayxl9AC4d7grJnncmKk2aUtarRq0pOaYfWuKwjaVPknGaGu6\nwCnGI/7nMCZA77ZH2s+rberHO+/6GCt+9pqSqY4u+2r83WMWMrVT/4jNBxKVErAk\n99iAC69+/N/afaryLoiAAtuaUPOAOD3fW4FXtjvvfht8xeU1AvYPOr0IfYdMH/Yq\n1EzRUsoxnhNG3Lb6YaQ0K59iFoBESSN5JHmLSLFEPb1i36Gx4kQMGJH8FM5tlPma\nySUlLeY=\n-----END CERTIFICATE REQUEST-----", "domain_amount": 1, "domain_validation_methods": [ { "host_name": "example.com", "method": "https" } ], "enable_dns_automation": false, "host_names": [ "www.example.com" ], "organization_handle": "TH000001-NL", "period": 1, "product_id": 5, "signature_hash_algorithm": "sha2", "software_id": "linux", "start_provision": true, "technical_handle": "TH000001-NL", "wildcard_domain_amount": 5 } }, "orderCreateOrderResponse": { "type": "object", "title": "CreateOrderResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/orderCreateOrderResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "id": 1 }, "desc": "" } }, "orderCreateOrderResponseData": { "type": "object", "title": "CreateOrderResponseData", "properties": { "id": { "type": "integer", "format": "int32", "title": "Object id" } }, "example": { "id": 1 } }, "orderDeleteEasyDmarcResponse": { "type": "object", "title": "DeleteEasyDmarcResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/orderDeleteEasyDmarcResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates that the Openprovider system is temporarily unavailable because of maintenance" }, "warnings": { "type": "array", "title": "Contains warning responses if any", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "status": "ACT" }, "desc": "" } }, "orderDeleteEasyDmarcResponseData": { "type": "object", "title": "DeleteEasyDmarcResponseData", "properties": { "status": { "type": "string", "title": "Easy Dmarc status" } }, "example": { "status": "ACT" } }, "orderDomain": { "type": "object", "title": "Domain", "properties": { "extension": { "type": "string", "title": "Domain extension" }, "name": { "type": "string", "title": "Domain name without extension" } }, "example": { "extension": "london", "name": "test4" } }, "orderEasyDmarcOrder": { "type": "object", "title": "EasyDmarcOrder", "properties": { "activated_at": { "type": "string", "title": "date when we order has been activated last time" }, "domain": { "title": "Domain name and extension", "$ref": "#/definitions/orderDomain" }, "easydmarc_email_address": { "type": "string", "title": "Email address (fake) used in the easy dmarc account" }, "expired_at": { "type": "string", "title": "date when order has been expired" }, "id": { "type": "integer", "format": "int32", "title": "Easydmarc id (order number)" }, "recent_easydmarc_action": { "title": "Recent client chronicle action and additional information", "$ref": "#/definitions/orderRecentEasyDmarcAction" }, "record_host": { "type": "string", "title": "Easy Dmarc CNAME record host" }, "record_type": { "type": "string", "title": "Easy Dmarc CNAME record type" }, "record_value": { "type": "string", "title": "Easy Dmarc CNAME record value" }, "renew_at": { "type": "string", "title": "date when we will request automatic renew" }, "status": { "type": "string", "title": "Status of easy dmarc" } }, "example": { "activated_at": "2019-01-01 0:00:01", "domain": { "extension": "london", "name": "test4" }, "easydmarc_email_address": "", "expired_at": "2019-01-01 0:00:01", "id": 123456789, "recent_easydmarc_action": { "message": "", "recent_action": "enabled" }, "record_host": "", "record_type": "", "record_value": "", "renew_at": "2019-01-01 0:00:01", "status": "" } }, "orderGetEasyDmarcResponse": { "type": "object", "title": "GetEasyDmarcResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/orderEasyDmarcOrder" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates that the Openprovider system is temporarily unavailable because of maintenance" }, "warnings": { "type": "array", "title": "Contains warning responses if any", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "activated_at": "2019-01-01 0:00:01", "domain": { "extension": "london", "name": "test4" }, "easydmarc_email_address": "", "expired_at": "2019-01-01 0:00:01", "id": 123456789, "recent_easydmarc_action": { "message": "", "recent_action": "enabled" }, "record_host": "", "record_type": "", "record_value": "", "renew_at": "2019-01-01 0:00:01", "status": "" }, "desc": "" } }, "orderGetEasyDmarcSsoResponse": { "type": "object", "title": "GetEasyDmarcSsoResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/orderGetEasyDmarcSsoResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates that the Openprovider system is temporarily unavailable because of maintenance" }, "warnings": { "type": "array", "title": "Contains warning responses if any", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "url": "" }, "desc": "" } }, "orderGetEasyDmarcSsoResponseData": { "type": "object", "title": "GetEasyDmarcSsoResponseData", "properties": { "url": { "type": "string", "title": "Single sign on url along with one time passsword token as query params" } }, "example": { "url": "" } }, "orderGetOrderResponse": { "type": "object", "title": "GetOrderResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/orderSslOrder" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "active_date": "2019-01-01 0:00:01", "additional_data": [ { "dns": "73d01a1232214f96ebf08d6f9d0af6f9", "dns_record": "example.com", "dns_value": "0453ff12343c6d5e24466832668aa13658e5893c917b9486d7c59a5727074c9c", "domain": "example.com", "file_content": "73d01a1232214f96ebf08d6f9d0af6f9", "file_contents": "0453ff12343c6d5e24466832668aa13658e5893c917b9486d7c59a5727074c9c", "file_location": "example.com/.well-known/pki-validation/fileauth.txt", "file_name": "fileauth.txt", "md5": "73d01a1232214f96ebf08d6f9d0af6f9", "old_cert_format": [ "dywtgtjttvdk5v4ncd8231yl6v5ji8pv" ], "sha1": "0453ff12343c6d5e24466832668aa13658e5893c917b9486d7c59a5727074c9c", "sha256": "0453ff12343c6d5e24466832668aa13658e5893c917b9486d7c59a5727074c9c", "token": "a9a5775036334709b3c04e0e4a095f15", "url": "http://3.example.com/.well-known/pki-validation/12345e32k4j32kljlkfsdjlkfjsdlk333.txt" } ], "administrative_handle": "XX123456-XX", "autorenew": "off", "billing_handle": "XX123456-XX", "brand_name": "Comodo", "certificate": "", "common_name": "example.com", "csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIIC0TCCAbkCAQAwgYsxCzAJBgNVBAYTAkFVMREwDwYDVQQIDAhleGFtcGxlczER\nMA8GA1UEBwwIZXhhbXBsZXMxETAPBgNVBAoMCGV4YW1wbGVzMQswCQYDVQQLDAJp\ndDEUMBIGA1UEAwwLZXhhbXBsZS5jb20xIDAeBgkqhkiG9w0BCQEWEWFkbWluQGV4\nYW1wbGUuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA6XbdNhvH\nRldtqE8iNm1Da0z+rkmAJlEtKUjqz5CDGcA9ByCLQ4qBIsSAkRgElBonMyR8lLDK\nh5Ac9jrkg40zrrXCl8TQ4sW5GFavwBPKCTHQu0EhovGWdV490+oOTVBckBW6niI5\nyaezhL4ZJzd4smrqoH3fPYPgLcb7+Lb4fsMfavRrallMrHP612bLm0mOpXKcwHos\nqBdC3OW2v64MnBdla3ZcPKFG8ThcdJoD9sym1EtKsm3MbyT9d8r3D+L2+xqZOjww\nacElCLmZ8Ep4aQVx0GRbJoDEA1Yy7A9YC4E+SObW7daquTX+zymeK0k1mACmOwvo\nJOrjLIhUbjJDtQIDAQABoAAwDQYJKoZIhvcNAQELBQADggEBANBGBu55iuzTYc4S\nZW3F8flSd0cO8ubKII6WcwHJrk8NIlAgfduAuNRuG9CAba0e72Ea0xKIhXSzxbDi\ncq9Yl0rkovY95ZyRayxl9AC4d7grJnncmKk2aUtarRq0pOaYfWuKwjaVPknGaGu6\nwCnGI/7nMCZA77ZH2s+rberHO+/6GCt+9pqSqY4u+2r83WMWMrVT/4jNBxKVErAk\n99iAC69+/N/afaryLoiAAtuaUPOAOD3fW4FXtjvvfht8xeU1AvYPOr0IfYdMH/Yq\n1EzRUsoxnhNG3Lb6YaQ0K59iFoBESSN5JHmLSLFEPb1i36Gx4kQMGJH8FM5tlPma\nySUlLeY=\n-----END CERTIFICATE REQUEST-----", "domain_validation_methods": [ { "host_name": "example.com", "method": "https" } ], "domain_validation_statuses": { "ca_operation": "request", "ca_order_status": "in_progress", "ca_status": "requested", "status": "open" }, "email_approver": "admin@example.com", "email_reissue": "admin@example.com", "expiration_date": "2021-01-01 0:00:01", "features": "", "host_names": [ "www.example.com" ], "id": 123456789, "intermediate_certificate": "", "options": { "features": "" }, "order_date": "2019-01-01 0:00:01", "order_ends_at": "2019-01-01 0:00:01", "organization_handle": "TH000001-NL", "period": 2, "product_id": 5, "product_name": "EssentialSSL", "reissue_at": "2019-01-01 0:00:01", "root_certificate": "", "software": "linux", "sslinhva_order_id": "11111111-1111-1111-1111-111111111111", "status": "REQ", "technical_handle": "TH000001-NL", "validation_method": "domain", "vendor_order_id": "123456789", "vendor_reference_id": "123456789" }, "desc": "" } }, "orderListEasyDmarcOrder": { "type": "object", "title": "ListEasyDmarcOrder", "properties": { "activated_at": { "type": "string", "title": "date when we order has been activated last time" }, "domain": { "title": "Domain name and extension", "$ref": "#/definitions/orderDomain" }, "expired_at": { "type": "string", "title": "date when order has been expired" }, "id": { "type": "integer", "format": "int32", "title": "Order id number" }, "record_host": { "type": "string", "title": "Easy Dmarc CNAME record host" }, "record_type": { "type": "string", "title": "Easy Dmarc CNAME record type" }, "record_value": { "type": "string", "title": "Easy Dmarc CNAME record value" }, "renew_at": { "type": "string", "title": "date when we will request automatic renew" }, "status": { "type": "string", "title": "Status of order" } }, "example": { "activated_at": "2019-01-01 0:00:01", "domain": { "extension": "london", "name": "test4" }, "expired_at": "2019-01-01 0:00:01", "id": 123456789, "record_host": "", "record_type": "", "record_value": "", "renew_at": "2019-01-01 0:00:01", "status": "" } }, "orderListEasyDmarcRequestOrderBy": { "type": "object", "title": "ListEasyDmarcRequestOrderBy", "properties": { "id": { "type": "string", "title": "desc/asc" } } }, "orderListEasyDmarcResponse": { "type": "object", "title": "ListEasyDmarcResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/orderListEasyDmarcResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "results": [ { "activated_at": "2019-01-01 0:00:01", "domain": { "extension": "london", "name": "test4" }, "expired_at": "2019-01-01 0:00:01", "id": 123456789, "record_host": "", "record_type": "", "record_value": "", "renew_at": "2019-01-01 0:00:01", "status": "" } ], "total": 999 }, "desc": "" } }, "orderListEasyDmarcResponseData": { "type": "object", "title": "ListEasyDmarcResponseData", "properties": { "results": { "type": "array", "title": "Results list", "items": { "$ref": "#/definitions/orderListEasyDmarcOrder" } }, "total": { "type": "integer", "format": "int32", "title": "Results count" } }, "example": { "results": [ { "activated_at": "2019-01-01 0:00:01", "domain": { "extension": "london", "name": "test4" }, "expired_at": "2019-01-01 0:00:01", "id": 123456789, "record_host": "", "record_type": "", "record_value": "", "renew_at": "2019-01-01 0:00:01", "status": "" } ], "total": 999 } }, "orderListOrdersRequestOrderBy": { "type": "object", "title": "ListOrdersRequestOrderBy", "properties": { "active_date": { "type": "string", "title": "desc/asc" }, "common_name": { "type": "string", "title": "desc/asc" }, "expiration_date": { "type": "string", "title": "desc/asc" }, "order_date": { "type": "string", "title": "desc/asc", "default": "desc" }, "product_name": { "type": "string", "title": "desc/asc" }, "status": { "type": "string", "title": "desc/asc" } } }, "orderListOrdersResponse": { "type": "object", "title": "ListOrdersResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/orderListOrdersResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "results": [ { "active_date": "2019-01-01 0:00:01", "additional_data": [ { "dns": "73d01a1232214f96ebf08d6f9d0af6f9", "dns_record": "example.com", "dns_value": "0453ff12343c6d5e24466832668aa13658e5893c917b9486d7c59a5727074c9c", "domain": "example.com", "file_content": "73d01a1232214f96ebf08d6f9d0af6f9", "file_contents": "0453ff12343c6d5e24466832668aa13658e5893c917b9486d7c59a5727074c9c", "file_location": "example.com/.well-known/pki-validation/fileauth.txt", "file_name": "fileauth.txt", "md5": "73d01a1232214f96ebf08d6f9d0af6f9", "old_cert_format": [ "dywtgtjttvdk5v4ncd8231yl6v5ji8pv" ], "sha1": "0453ff12343c6d5e24466832668aa13658e5893c917b9486d7c59a5727074c9c", "sha256": "0453ff12343c6d5e24466832668aa13658e5893c917b9486d7c59a5727074c9c", "token": "a9a5775036334709b3c04e0e4a095f15", "url": "http://3.example.com/.well-known/pki-validation/12345e32k4j32kljlkfsdjlkfjsdlk333.txt" } ], "administrative_handle": "XX123456-XX", "autorenew": "off", "billing_handle": "XX123456-XX", "brand_name": "Comodo", "certificate": "", "common_name": "example.com", "csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIIC0TCCAbkCAQAwgYsxCzAJBgNVBAYTAkFVMREwDwYDVQQIDAhleGFtcGxlczER\nMA8GA1UEBwwIZXhhbXBsZXMxETAPBgNVBAoMCGV4YW1wbGVzMQswCQYDVQQLDAJp\ndDEUMBIGA1UEAwwLZXhhbXBsZS5jb20xIDAeBgkqhkiG9w0BCQEWEWFkbWluQGV4\nYW1wbGUuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA6XbdNhvH\nRldtqE8iNm1Da0z+rkmAJlEtKUjqz5CDGcA9ByCLQ4qBIsSAkRgElBonMyR8lLDK\nh5Ac9jrkg40zrrXCl8TQ4sW5GFavwBPKCTHQu0EhovGWdV490+oOTVBckBW6niI5\nyaezhL4ZJzd4smrqoH3fPYPgLcb7+Lb4fsMfavRrallMrHP612bLm0mOpXKcwHos\nqBdC3OW2v64MnBdla3ZcPKFG8ThcdJoD9sym1EtKsm3MbyT9d8r3D+L2+xqZOjww\nacElCLmZ8Ep4aQVx0GRbJoDEA1Yy7A9YC4E+SObW7daquTX+zymeK0k1mACmOwvo\nJOrjLIhUbjJDtQIDAQABoAAwDQYJKoZIhvcNAQELBQADggEBANBGBu55iuzTYc4S\nZW3F8flSd0cO8ubKII6WcwHJrk8NIlAgfduAuNRuG9CAba0e72Ea0xKIhXSzxbDi\ncq9Yl0rkovY95ZyRayxl9AC4d7grJnncmKk2aUtarRq0pOaYfWuKwjaVPknGaGu6\nwCnGI/7nMCZA77ZH2s+rberHO+/6GCt+9pqSqY4u+2r83WMWMrVT/4jNBxKVErAk\n99iAC69+/N/afaryLoiAAtuaUPOAOD3fW4FXtjvvfht8xeU1AvYPOr0IfYdMH/Yq\n1EzRUsoxnhNG3Lb6YaQ0K59iFoBESSN5JHmLSLFEPb1i36Gx4kQMGJH8FM5tlPma\nySUlLeY=\n-----END CERTIFICATE REQUEST-----", "domain_validation_methods": [ { "host_name": "example.com", "method": "https" } ], "domain_validation_statuses": { "ca_operation": "request", "ca_order_status": "in_progress", "ca_status": "requested", "status": "open" }, "email_approver": "admin@example.com", "email_reissue": "admin@example.com", "expiration_date": "2021-01-01 0:00:01", "features": "", "host_names": [ "www.example.com" ], "id": 123456789, "intermediate_certificate": "", "options": { "features": "" }, "order_date": "2019-01-01 0:00:01", "order_ends_at": "2019-01-01 0:00:01", "organization_handle": "TH000001-NL", "period": 2, "product_id": 5, "product_name": "EssentialSSL", "reissue_at": "2019-01-01 0:00:01", "root_certificate": "", "software": "linux", "sslinhva_order_id": "11111111-1111-1111-1111-111111111111", "status": "REQ", "technical_handle": "TH000001-NL", "validation_method": "domain", "vendor_order_id": "123456789", "vendor_reference_id": "123456789" } ], "total": 999 }, "desc": "" } }, "orderListOrdersResponseData": { "type": "object", "title": "ListOrdersResponseData", "properties": { "results": { "type": "array", "title": "Results list", "items": { "$ref": "#/definitions/orderSslOrder" } }, "total": { "type": "integer", "format": "int32", "title": "Results count" } }, "example": { "results": [ { "active_date": "2019-01-01 0:00:01", "additional_data": [ { "dns": "73d01a1232214f96ebf08d6f9d0af6f9", "dns_record": "example.com", "dns_value": "0453ff12343c6d5e24466832668aa13658e5893c917b9486d7c59a5727074c9c", "domain": "example.com", "file_content": "73d01a1232214f96ebf08d6f9d0af6f9", "file_contents": "0453ff12343c6d5e24466832668aa13658e5893c917b9486d7c59a5727074c9c", "file_location": "example.com/.well-known/pki-validation/fileauth.txt", "file_name": "fileauth.txt", "md5": "73d01a1232214f96ebf08d6f9d0af6f9", "old_cert_format": [ "dywtgtjttvdk5v4ncd8231yl6v5ji8pv" ], "sha1": "0453ff12343c6d5e24466832668aa13658e5893c917b9486d7c59a5727074c9c", "sha256": "0453ff12343c6d5e24466832668aa13658e5893c917b9486d7c59a5727074c9c", "token": "a9a5775036334709b3c04e0e4a095f15", "url": "http://3.example.com/.well-known/pki-validation/12345e32k4j32kljlkfsdjlkfjsdlk333.txt" } ], "administrative_handle": "XX123456-XX", "autorenew": "off", "billing_handle": "XX123456-XX", "brand_name": "Comodo", "certificate": "", "common_name": "example.com", "csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIIC0TCCAbkCAQAwgYsxCzAJBgNVBAYTAkFVMREwDwYDVQQIDAhleGFtcGxlczER\nMA8GA1UEBwwIZXhhbXBsZXMxETAPBgNVBAoMCGV4YW1wbGVzMQswCQYDVQQLDAJp\ndDEUMBIGA1UEAwwLZXhhbXBsZS5jb20xIDAeBgkqhkiG9w0BCQEWEWFkbWluQGV4\nYW1wbGUuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA6XbdNhvH\nRldtqE8iNm1Da0z+rkmAJlEtKUjqz5CDGcA9ByCLQ4qBIsSAkRgElBonMyR8lLDK\nh5Ac9jrkg40zrrXCl8TQ4sW5GFavwBPKCTHQu0EhovGWdV490+oOTVBckBW6niI5\nyaezhL4ZJzd4smrqoH3fPYPgLcb7+Lb4fsMfavRrallMrHP612bLm0mOpXKcwHos\nqBdC3OW2v64MnBdla3ZcPKFG8ThcdJoD9sym1EtKsm3MbyT9d8r3D+L2+xqZOjww\nacElCLmZ8Ep4aQVx0GRbJoDEA1Yy7A9YC4E+SObW7daquTX+zymeK0k1mACmOwvo\nJOrjLIhUbjJDtQIDAQABoAAwDQYJKoZIhvcNAQELBQADggEBANBGBu55iuzTYc4S\nZW3F8flSd0cO8ubKII6WcwHJrk8NIlAgfduAuNRuG9CAba0e72Ea0xKIhXSzxbDi\ncq9Yl0rkovY95ZyRayxl9AC4d7grJnncmKk2aUtarRq0pOaYfWuKwjaVPknGaGu6\nwCnGI/7nMCZA77ZH2s+rberHO+/6GCt+9pqSqY4u+2r83WMWMrVT/4jNBxKVErAk\n99iAC69+/N/afaryLoiAAtuaUPOAOD3fW4FXtjvvfht8xeU1AvYPOr0IfYdMH/Yq\n1EzRUsoxnhNG3Lb6YaQ0K59iFoBESSN5JHmLSLFEPb1i36Gx4kQMGJH8FM5tlPma\nySUlLeY=\n-----END CERTIFICATE REQUEST-----", "domain_validation_methods": [ { "host_name": "example.com", "method": "https" } ], "domain_validation_statuses": { "ca_operation": "request", "ca_order_status": "in_progress", "ca_status": "requested", "status": "open" }, "email_approver": "admin@example.com", "email_reissue": "admin@example.com", "expiration_date": "2021-01-01 0:00:01", "features": "", "host_names": [ "www.example.com" ], "id": 123456789, "intermediate_certificate": "", "options": { "features": "" }, "order_date": "2019-01-01 0:00:01", "order_ends_at": "2019-01-01 0:00:01", "organization_handle": "TH000001-NL", "period": 2, "product_id": 5, "product_name": "EssentialSSL", "reissue_at": "2019-01-01 0:00:01", "root_certificate": "", "software": "linux", "sslinhva_order_id": "11111111-1111-1111-1111-111111111111", "status": "REQ", "technical_handle": "TH000001-NL", "validation_method": "domain", "vendor_order_id": "123456789", "vendor_reference_id": "123456789" } ], "total": 999 } }, "orderRecentEasyDmarcAction": { "type": "object", "title": "RecentEasyDmarcAction", "properties": { "message": { "type": "string", "title": "Additional information of last action if failed" }, "recent_action": { "type": "string", "title": "Recently triggered action on EasyDmarc API" } }, "example": { "message": "", "recent_action": "enabled" } }, "orderReissueOrderRequest": { "type": "object", "title": "ReissueOrderRequest", "properties": { "approver_email": { "description": "Email for domain ownership verification. Should start with well-known generic name like admin@, hostmater@, administrator@, etc.", "type": "string" }, "csr": { "type": "string", "title": "Certificate signing request" }, "domain_validation_methods": { "type": "array", "title": "Method of domain validation", "items": { "$ref": "#/definitions/orderSslOrderDomainValidationMethods" } }, "enable_dns_automation": { "type": "boolean", "format": "boolean", "title": "Indicates whether the automatic DNS validation will be applied to the certificate", "default": false }, "host_names": { "type": "array", "title": "List of domain names to protect", "items": { "type": "string" } }, "id": { "type": "integer", "format": "int32", "title": "Object id" }, "organization_handle": { "type": "string", "title": "Handle of the organization contact" }, "signature_hash_algorithm": { "type": "string", "title": "Certificate has algorithm. Set to sha2 or leave blank" }, "software_id": { "type": "string", "title": "Software used on host where certificate will be installed" } }, "example": { "approver_email": "admin@example.com", "csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIIC0TCCAbkCAQAwgYsxCzAJBgNVBAYTAkFVMREwDwYDVQQIDAhleGFtcGxlczER\nMA8GA1UEBwwIZXhhbXBsZXMxETAPBgNVBAoMCGV4YW1wbGVzMQswCQYDVQQLDAJp\ndDEUMBIGA1UEAwwLZXhhbXBsZS5jb20xIDAeBgkqhkiG9w0BCQEWEWFkbWluQGV4\nYW1wbGUuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA6XbdNhvH\nRldtqE8iNm1Da0z+rkmAJlEtKUjqz5CDGcA9ByCLQ4qBIsSAkRgElBonMyR8lLDK\nh5Ac9jrkg40zrrXCl8TQ4sW5GFavwBPKCTHQu0EhovGWdV490+oOTVBckBW6niI5\nyaezhL4ZJzd4smrqoH3fPYPgLcb7+Lb4fsMfavRrallMrHP612bLm0mOpXKcwHos\nqBdC3OW2v64MnBdla3ZcPKFG8ThcdJoD9sym1EtKsm3MbyT9d8r3D+L2+xqZOjww\nacElCLmZ8Ep4aQVx0GRbJoDEA1Yy7A9YC4E+SObW7daquTX+zymeK0k1mACmOwvo\nJOrjLIhUbjJDtQIDAQABoAAwDQYJKoZIhvcNAQELBQADggEBANBGBu55iuzTYc4S\nZW3F8flSd0cO8ubKII6WcwHJrk8NIlAgfduAuNRuG9CAba0e72Ea0xKIhXSzxbDi\ncq9Yl0rkovY95ZyRayxl9AC4d7grJnncmKk2aUtarRq0pOaYfWuKwjaVPknGaGu6\nwCnGI/7nMCZA77ZH2s+rberHO+/6GCt+9pqSqY4u+2r83WMWMrVT/4jNBxKVErAk\n99iAC69+/N/afaryLoiAAtuaUPOAOD3fW4FXtjvvfht8xeU1AvYPOr0IfYdMH/Yq\n1EzRUsoxnhNG3Lb6YaQ0K59iFoBESSN5JHmLSLFEPb1i36Gx4kQMGJH8FM5tlPma\nySUlLeY=\n-----END CERTIFICATE REQUEST-----", "domain_validation_methods": [ { "host_name": "example.com", "method": "https" } ], "enable_dns_automation": false, "host_names": [ "www.example.com" ], "id": 1, "organization_handle": "TH000001-NL", "signature_hash_algorithm": "sha2", "software_id": "linux" } }, "orderReissueOrderResponse": { "type": "object", "title": "ReissueOrderResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/orderReissueOrderResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "id": 1 }, "desc": "" } }, "orderReissueOrderResponseData": { "type": "object", "title": "ReissueOrderResponseData", "properties": { "id": { "type": "integer", "format": "int32", "title": "Object id" } }, "example": { "id": 1 } }, "orderRenewOrderRequest": { "type": "object", "title": "RenewOrderRequest", "properties": { "enable_dns_automation": { "type": "boolean", "format": "boolean", "title": "Indicates whether the automatic DNS validation will be applied to the certificate", "default": false }, "id": { "type": "integer", "format": "int32", "title": "Object id" } }, "example": { "enable_dns_automation": false, "id": 1 } }, "orderRenewOrderResponse": { "type": "object", "title": "RenewOrderResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/orderRenewOrderResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "id": 1 }, "desc": "" } }, "orderRenewOrderResponseData": { "type": "object", "title": "RenewOrderResponseData", "properties": { "id": { "type": "integer", "format": "int32", "title": "Object id" } }, "example": { "id": 1 } }, "orderRetryEasyDmarcRequest": { "type": "object", "title": "RetryEasyDmarcRequest", "properties": { "id": { "type": "integer", "format": "int32", "title": "Easydmarc id (order number)" } }, "example": { "id": 123456789 } }, "orderRetryEasyDmarcResponse": { "type": "object", "title": "RetryEasyDmarcResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/orderEasyDmarcOrder" }, "desc": { "type": "string", "title": "Response description" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "activated_at": "2019-01-01 0:00:01", "domain": { "extension": "london", "name": "test4" }, "easydmarc_email_address": "", "expired_at": "2019-01-01 0:00:01", "id": 123456789, "recent_easydmarc_action": { "message": "", "recent_action": "enabled" }, "record_host": "", "record_type": "", "record_value": "", "renew_at": "2019-01-01 0:00:01", "status": "" }, "desc": "" } }, "orderSslOrder": { "type": "object", "title": "SslOrder", "properties": { "active_date": { "type": "string", "title": "Date the certificate became active" }, "additional_data": { "type": "array", "title": "Additional data for DNS and HTTP validation methods", "items": { "$ref": "#/definitions/orderSslOrderAdditionalData" } }, "administrative_handle": { "type": "string", "title": "Handle of the administrative contact" }, "autorenew": { "type": "string", "title": "Certificate autorenew property" }, "billing_handle": { "type": "string", "title": "Handle of the billing contact" }, "brand_name": { "type": "string", "title": "Product brand" }, "certificate": { "type": "string", "title": "Issued SSL certificate" }, "common_name": { "type": "string", "title": "List of domain names" }, "csr": { "type": "string", "title": "Certificate signing request" }, "domain_validation_methods": { "type": "array", "title": "Domain validation method", "items": { "$ref": "#/definitions/orderSslOrderDomainValidationMethods" } }, "domain_validation_statuses": { "title": "List of order validation statuses", "$ref": "#/definitions/orderSslOrderDomainValidationStatuses" }, "email_approver": { "type": "string", "title": "Email used for domain validation" }, "email_reissue": { "type": "string", "title": "Email used for reissue requests" }, "expiration_date": { "type": "string", "title": "Date the certificate expires" }, "features": { "type": "string", "title": "List of SSL order features" }, "host_names": { "type": "array", "title": "List of protected domain anmes", "items": { "type": "string" } }, "id": { "type": "integer", "format": "int32", "title": "Object id" }, "intermediate_certificate": { "type": "string", "title": "Intermediate certificate" }, "options": { "title": "List of SSL order options", "$ref": "#/definitions/orderSslOrderOptions" }, "order_date": { "type": "string", "title": "Order date" }, "order_ends_at": { "type": "string", "title": "date till which order has been paid" }, "organization_handle": { "type": "string", "title": "Handle of the organization contact" }, "period": { "type": "integer", "format": "int32", "title": "Certificate issuance period" }, "product_id": { "type": "integer", "format": "int32", "title": "ID of the product" }, "product_name": { "type": "string", "title": "Name of the product" }, "reissue_at": { "type": "string", "title": "date when we will request automatic reissue" }, "root_certificate": { "type": "string", "title": "Root certificate" }, "software": { "type": "string", "title": "Software used on host where certificate will be installed" }, "sslinhva_order_id": { "type": "string", "title": "Internal order ID" }, "status": { "type": "string", "title": "Order status" }, "technical_handle": { "type": "string", "title": "Handle of the technical contact" }, "validation_method": { "type": "string", "title": "Certificate validation method" }, "vendor_order_id": { "type": "string", "title": "Order id at the CA" }, "vendor_reference_id": { "type": "string", "title": "Internal vendor reference ID" } }, "example": { "active_date": "2019-01-01 0:00:01", "additional_data": [ { "dns": "73d01a1232214f96ebf08d6f9d0af6f9", "dns_record": "example.com", "dns_value": "0453ff12343c6d5e24466832668aa13658e5893c917b9486d7c59a5727074c9c", "domain": "example.com", "file_content": "73d01a1232214f96ebf08d6f9d0af6f9", "file_contents": "0453ff12343c6d5e24466832668aa13658e5893c917b9486d7c59a5727074c9c", "file_location": "example.com/.well-known/pki-validation/fileauth.txt", "file_name": "fileauth.txt", "md5": "73d01a1232214f96ebf08d6f9d0af6f9", "old_cert_format": [ "dywtgtjttvdk5v4ncd8231yl6v5ji8pv" ], "sha1": "0453ff12343c6d5e24466832668aa13658e5893c917b9486d7c59a5727074c9c", "sha256": "0453ff12343c6d5e24466832668aa13658e5893c917b9486d7c59a5727074c9c", "token": "a9a5775036334709b3c04e0e4a095f15", "url": "http://3.example.com/.well-known/pki-validation/12345e32k4j32kljlkfsdjlkfjsdlk333.txt" } ], "administrative_handle": "XX123456-XX", "autorenew": "off", "billing_handle": "XX123456-XX", "brand_name": "Comodo", "certificate": "", "common_name": "example.com", "csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIIC0TCCAbkCAQAwgYsxCzAJBgNVBAYTAkFVMREwDwYDVQQIDAhleGFtcGxlczER\nMA8GA1UEBwwIZXhhbXBsZXMxETAPBgNVBAoMCGV4YW1wbGVzMQswCQYDVQQLDAJp\ndDEUMBIGA1UEAwwLZXhhbXBsZS5jb20xIDAeBgkqhkiG9w0BCQEWEWFkbWluQGV4\nYW1wbGUuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA6XbdNhvH\nRldtqE8iNm1Da0z+rkmAJlEtKUjqz5CDGcA9ByCLQ4qBIsSAkRgElBonMyR8lLDK\nh5Ac9jrkg40zrrXCl8TQ4sW5GFavwBPKCTHQu0EhovGWdV490+oOTVBckBW6niI5\nyaezhL4ZJzd4smrqoH3fPYPgLcb7+Lb4fsMfavRrallMrHP612bLm0mOpXKcwHos\nqBdC3OW2v64MnBdla3ZcPKFG8ThcdJoD9sym1EtKsm3MbyT9d8r3D+L2+xqZOjww\nacElCLmZ8Ep4aQVx0GRbJoDEA1Yy7A9YC4E+SObW7daquTX+zymeK0k1mACmOwvo\nJOrjLIhUbjJDtQIDAQABoAAwDQYJKoZIhvcNAQELBQADggEBANBGBu55iuzTYc4S\nZW3F8flSd0cO8ubKII6WcwHJrk8NIlAgfduAuNRuG9CAba0e72Ea0xKIhXSzxbDi\ncq9Yl0rkovY95ZyRayxl9AC4d7grJnncmKk2aUtarRq0pOaYfWuKwjaVPknGaGu6\nwCnGI/7nMCZA77ZH2s+rberHO+/6GCt+9pqSqY4u+2r83WMWMrVT/4jNBxKVErAk\n99iAC69+/N/afaryLoiAAtuaUPOAOD3fW4FXtjvvfht8xeU1AvYPOr0IfYdMH/Yq\n1EzRUsoxnhNG3Lb6YaQ0K59iFoBESSN5JHmLSLFEPb1i36Gx4kQMGJH8FM5tlPma\nySUlLeY=\n-----END CERTIFICATE REQUEST-----", "domain_validation_methods": [ { "host_name": "example.com", "method": "https" } ], "domain_validation_statuses": { "ca_operation": "request", "ca_order_status": "in_progress", "ca_status": "requested", "status": "open" }, "email_approver": "admin@example.com", "email_reissue": "admin@example.com", "expiration_date": "2021-01-01 0:00:01", "features": "", "host_names": [ "www.example.com" ], "id": 123456789, "intermediate_certificate": "", "options": { "features": "" }, "order_date": "2019-01-01 0:00:01", "order_ends_at": "2019-01-01 0:00:01", "organization_handle": "TH000001-NL", "period": 2, "product_id": 5, "product_name": "EssentialSSL", "reissue_at": "2019-01-01 0:00:01", "root_certificate": "", "software": "linux", "sslinhva_order_id": "11111111-1111-1111-1111-111111111111", "status": "REQ", "technical_handle": "TH000001-NL", "validation_method": "domain", "vendor_order_id": "123456789", "vendor_reference_id": "123456789" } }, "orderSslOrderAdditionalData": { "type": "object", "title": "SslOrderAdditionalData", "properties": { "dns": { "type": "string", "title": "DNS content for Symantec order" }, "dns_record": { "type": "string", "title": "DNS record that should be added to host" }, "dns_value": { "type": "string", "title": "DNS values that should be added to host to process validation" }, "domain": { "type": "string", "title": "Domain host name with which certificate is associated" }, "file_content": { "type": "string", "title": "File content for Symantec orders" }, "file_contents": { "type": "string", "title": "Indicates what contents should be added to domain validation file" }, "file_location": { "type": "string", "title": "Indicates where domain validation file should be placed" }, "file_name": { "type": "string", "title": "File name for Symantec orders" }, "md5": { "type": "string", "title": "Order MD5 checksum" }, "old_cert_format": { "type": "array", "title": "This old format (before transition to digicert)", "items": { "type": "string" } }, "sha1": { "type": "string", "title": "Order SHA1 checksum" }, "sha256": { "type": "string", "title": "Order SHA256 checksum" }, "token": { "type": "string", "title": "The token" }, "url": { "type": "string", "title": "The url" } }, "example": { "dns": "73d01a1232214f96ebf08d6f9d0af6f9", "dns_record": "example.com", "dns_value": "0453ff12343c6d5e24466832668aa13658e5893c917b9486d7c59a5727074c9c", "domain": "example.com", "file_content": "73d01a1232214f96ebf08d6f9d0af6f9", "file_contents": "0453ff12343c6d5e24466832668aa13658e5893c917b9486d7c59a5727074c9c", "file_location": "example.com/.well-known/pki-validation/fileauth.txt", "file_name": "fileauth.txt", "md5": "73d01a1232214f96ebf08d6f9d0af6f9", "old_cert_format": [ "dywtgtjttvdk5v4ncd8231yl6v5ji8pv" ], "sha1": "0453ff12343c6d5e24466832668aa13658e5893c917b9486d7c59a5727074c9c", "sha256": "0453ff12343c6d5e24466832668aa13658e5893c917b9486d7c59a5727074c9c", "token": "a9a5775036334709b3c04e0e4a095f15", "url": "http://3.example.com/.well-known/pki-validation/12345e32k4j32kljlkfsdjlkfjsdlk333.txt" } }, "orderSslOrderDomainValidationMethods": { "type": "object", "title": "SslOrderDomainValidationMethods", "properties": { "host_name": { "type": "string", "title": "List of domain names to protect" }, "method": { "type": "string", "title": "Indicates the validation method required for certificate issuance (domain, organization or extended)" } }, "example": { "host_name": "example.com", "method": "https" } }, "orderSslOrderDomainValidationStatuses": { "type": "object", "title": "SslOrderDomainValidationStatuses", "properties": { "ca_operation": { "type": "string", "title": "Operation performed at the CA" }, "ca_order_status": { "type": "string", "title": "Order status at the CA" }, "ca_status": { "type": "string", "title": "Certificate status at the CA" }, "status": { "type": "string", "title": "Validation status" } }, "example": { "ca_operation": "request", "ca_order_status": "in_progress", "ca_status": "requested", "status": "open" } }, "orderSslOrderOptions": { "type": "object", "title": "SslOrderOptions", "properties": { "features": { "type": "string", "title": "Certificate features list (if present)" } }, "example": { "features": "" } }, "orderUpdateOrderRequest": { "type": "object", "title": "UpdateOrderRequest", "properties": { "approver_email": { "description": "Email for domain ownership verification. Should start with well-known generic name like admin@, hostmater@, administrator@, etc.", "type": "string" }, "autorenew": { "type": "string", "title": "Indicates, whether the certificate should be renewed automatically once its expiration date is reached" }, "csr": { "type": "string", "title": "Certificate signing request" }, "domain_validation_methods": { "type": "array", "title": "Method of domain validation", "items": { "$ref": "#/definitions/orderSslOrderDomainValidationMethods" } }, "enable_dns_automation": { "type": "boolean", "format": "boolean", "title": "Indicates whether the automatic DNS validation will be applied to the certificate", "default": false }, "host_names": { "type": "array", "title": "List of domain names to protect", "items": { "type": "string" } }, "id": { "type": "integer", "format": "int32", "title": "Object id" }, "organization_handle": { "type": "string", "title": "Handle of the organization contact" }, "signature_hash_algorithm": { "type": "string", "title": "Certificate hash algorithm. Set to sha2 or leave blank" }, "software_id": { "type": "string", "title": "Software used on host where certificate will be installed" }, "start_provision": { "type": "boolean", "format": "boolean", "title": "Indicates, whether a validation request should be sent to CA. If false, UpdateOrder method should be used later to change the setting and begin validation" }, "technical_handle": { "type": "string", "title": "Handle of the technical contact" } }, "example": { "approver_email": "admin@example.com", "autorenew": "off", "csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIIC0TCCAbkCAQAwgYsxCzAJBgNVBAYTAkFVMREwDwYDVQQIDAhleGFtcGxlczER\nMA8GA1UEBwwIZXhhbXBsZXMxETAPBgNVBAoMCGV4YW1wbGVzMQswCQYDVQQLDAJp\ndDEUMBIGA1UEAwwLZXhhbXBsZS5jb20xIDAeBgkqhkiG9w0BCQEWEWFkbWluQGV4\nYW1wbGUuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA6XbdNhvH\nRldtqE8iNm1Da0z+rkmAJlEtKUjqz5CDGcA9ByCLQ4qBIsSAkRgElBonMyR8lLDK\nh5Ac9jrkg40zrrXCl8TQ4sW5GFavwBPKCTHQu0EhovGWdV490+oOTVBckBW6niI5\nyaezhL4ZJzd4smrqoH3fPYPgLcb7+Lb4fsMfavRrallMrHP612bLm0mOpXKcwHos\nqBdC3OW2v64MnBdla3ZcPKFG8ThcdJoD9sym1EtKsm3MbyT9d8r3D+L2+xqZOjww\nacElCLmZ8Ep4aQVx0GRbJoDEA1Yy7A9YC4E+SObW7daquTX+zymeK0k1mACmOwvo\nJOrjLIhUbjJDtQIDAQABoAAwDQYJKoZIhvcNAQELBQADggEBANBGBu55iuzTYc4S\nZW3F8flSd0cO8ubKII6WcwHJrk8NIlAgfduAuNRuG9CAba0e72Ea0xKIhXSzxbDi\ncq9Yl0rkovY95ZyRayxl9AC4d7grJnncmKk2aUtarRq0pOaYfWuKwjaVPknGaGu6\nwCnGI/7nMCZA77ZH2s+rberHO+/6GCt+9pqSqY4u+2r83WMWMrVT/4jNBxKVErAk\n99iAC69+/N/afaryLoiAAtuaUPOAOD3fW4FXtjvvfht8xeU1AvYPOr0IfYdMH/Yq\n1EzRUsoxnhNG3Lb6YaQ0K59iFoBESSN5JHmLSLFEPb1i36Gx4kQMGJH8FM5tlPma\nySUlLeY=\n-----END CERTIFICATE REQUEST-----", "domain_validation_methods": [ { "host_name": "example.com", "method": "https" } ], "enable_dns_automation": false, "host_names": [ "www.example.com" ], "id": 1, "organization_handle": "TH000001-NL", "signature_hash_algorithm": "sha2", "software_id": "linux", "start_provision": false, "technical_handle": "TH000001-NL" } }, "orderUpdateOrderResponse": { "type": "object", "title": "UpdateOrderResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/orderUpdateOrderResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "id": 1 }, "desc": "" } }, "orderUpdateOrderResponseData": { "type": "object", "title": "UpdateOrderResponseData", "properties": { "id": { "type": "integer", "format": "int32", "title": "Object id" } }, "example": { "id": 1 } }, "otptokenCreateOtpTokenRequest": { "type": "object", "title": "CreateOtpTokenRequest", "properties": { "id": { "type": "integer", "format": "int32", "title": "Object id" } }, "example": { "id": 1 } }, "otptokenCreateOtpTokenResponse": { "type": "object", "title": "CreateOtpTokenResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/otptokenCreateOtpTokenResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "expire_at": "2019-01-01 0:00:01", "token": "token", "uri": "https://sslpanel.io/auth-order-otp-token" }, "desc": "" } }, "otptokenCreateOtpTokenResponseData": { "type": "object", "title": "CreateOtpTokenResponseData", "properties": { "expire_at": { "type": "string", "title": "Link expiration date" }, "token": { "type": "string", "title": "Unique token" }, "uri": { "type": "string", "title": "Unique link" } }, "example": { "expire_at": "2019-01-01 0:00:01", "token": "token", "uri": "https://sslpanel.io/auth-order-otp-token" } }, "paymentListPaymentsResponse": { "type": "object", "title": "ListPaymentsResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "The code" }, "data": { "title": "The data", "$ref": "#/definitions/paymentListPaymentsResponseData" }, "desc": { "type": "string", "title": "The desc" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "The maintenance" }, "warnings": { "type": "array", "title": "The warnings", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "results": [ { "amount": { "product": { "currency": "EUR", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } }, "confirmation_date": "", "creation_date": "2006-09-15 14:19:30", "id": 123, "is_processed": false, "method": "", "payment_date": "2006-09-15 14:25:30", "status": "new", "type": "online" } ], "total": 0 }, "desc": "" } }, "paymentListPaymentsResponseData": { "type": "object", "title": "ListPaymentsResponseData", "properties": { "results": { "type": "array", "title": "The results", "items": { "$ref": "#/definitions/paymentListPaymentsResponseDataResults" } }, "total": { "type": "integer", "format": "int32", "title": "The total" } }, "example": { "results": [ { "amount": { "product": { "currency": "EUR", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } }, "confirmation_date": "", "creation_date": "2006-09-15 14:19:30", "id": 123, "is_processed": false, "method": "", "payment_date": "2006-09-15 14:25:30", "status": "new", "type": "online" } ], "total": 0 } }, "paymentListPaymentsResponseDataResults": { "type": "object", "title": "ListPaymentsResponseDataResults", "properties": { "amount": { "title": "The amount", "$ref": "#/definitions/paymentPrices" }, "confirmation_date": { "type": "string", "title": "The confirmation date" }, "creation_date": { "type": "string", "title": "The creation date" }, "id": { "type": "integer", "format": "int32", "title": "The id" }, "is_processed": { "type": "boolean", "format": "boolean", "title": "Is processed" }, "method": { "type": "string", "title": "The method" }, "payment_date": { "type": "string", "title": "The payment date" }, "status": { "type": "string", "title": "The status" }, "type": { "type": "string", "title": "The type" } }, "example": { "amount": { "product": { "currency": "EUR", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } }, "confirmation_date": "", "creation_date": "2006-09-15 14:19:30", "id": 123, "is_processed": false, "method": "", "payment_date": "2006-09-15 14:25:30", "status": "new", "type": "online" } }, "paymentPrice": { "type": "object", "title": "Price", "properties": { "currency": { "type": "string", "title": "The currency" }, "price": { "type": "number", "format": "double", "title": "The price" } }, "example": { "currency": "EUR", "price": 0 } }, "paymentPrices": { "type": "object", "title": "Prices", "properties": { "product": { "title": "Price in product currency", "$ref": "#/definitions/paymentPrice" }, "reseller": { "title": "Price in reseller currency", "$ref": "#/definitions/paymentPrice" } }, "example": { "product": { "currency": "EUR", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } } }, "personcontactContact": { "type": "object", "title": "Contact", "properties": { "additional_data": { "title": "Collection of data fields that contain additional customer information", "$ref": "#/definitions/contactAdditionalData" }, "address": { "title": "Address", "$ref": "#/definitions/contactAddress" }, "api_access_enabled": { "type": "boolean", "format": "boolean", "title": "Indicates if API access is enabled for the contact" }, "api_client_ip_list": { "title": "API access IP whitelist / blacklist", "$ref": "#/definitions/contactClientIpList" }, "auth_type": { "type": "string", "title": "Autherntication type" }, "comments": { "type": "string", "title": "Custom notes to the specified handle" }, "company_name": { "type": "string", "title": "Company name" }, "email": { "type": "string", "title": "Email address" }, "hash_changed_at": { "type": "string", "title": "Date of last hash update" }, "id": { "type": "integer", "format": "int32", "title": "Object ID" }, "is_active": { "type": "boolean", "format": "boolean", "title": "Indicates if contact is active" }, "last_api_call_at": { "type": "string", "title": "Last API call date" }, "last_login_at": { "type": "string", "title": "Last login date" }, "locale": { "type": "string", "title": "Customer's language" }, "name": { "title": "Full name", "$ref": "#/definitions/contactName" }, "password_change_declined_at": { "type": "string", "title": "Password change declined date" }, "password_changed_at": { "type": "string", "title": "Last password change date" }, "phone": { "title": "Phone number", "$ref": "#/definitions/contactPhone" }, "rcp_client_ip_list": { "title": "RCP access IP whitelist / blacklist", "$ref": "#/definitions/contactClientIpList" }, "reseller_id": { "type": "integer", "format": "int32", "title": "Reseller ID" }, "role": { "type": "string", "title": "Contact's role" }, "secret_key": { "type": "string", "title": "The secret key" }, "username": { "type": "string", "title": "Username" }, "vat": { "type": "string", "title": "VAT (value-added tax) number of the customer" } }, "example": { "additional_data": { "birth_city": "Test city", "birth_date": "1969-12-31", "social_security_number": "12326178T" }, "address": { "city": "Test city", "country": "NL", "number": "123", "state": "Testprovince", "street": "Test street", "suffix": "A", "zipcode": "1235 XX" }, "api_access_enabled": true, "api_client_ip_list": { "allow": [ "127.0.0.1" ], "deny": [ "127.0.0.1" ] }, "auth_type": "simple", "comments": "", "company_name": "Example company", "email": "test@mail.tld", "hash_changed_at": "2019-03-25 10:17:02", "id": 123456789, "is_active": false, "last_api_call_at": "2019-03-25 10:17:01", "last_login_at": "2019-04-12 11:58:39", "locale": "nl_NL", "name": { "first_name": "Test", "full_name": "Test Person", "initials": "T P", "last_name": "Person", "prefix": "Mr" }, "password_change_declined_at": "2019-03-23 12:32:15", "password_changed_at": "2019-03-25 10:17:00", "phone": { "area_code": "111", "country_code": "+03", "subscriber_number": "123456" }, "rcp_client_ip_list": { "allow": [ "127.0.0.1" ], "deny": [ "127.0.0.1" ] }, "reseller_id": 12345, "role": "admin", "secret_key": "SECRETKEYVALUE", "username": "user_name", "vat": "XX123456789X12" } }, "priceGetPriceResponse": { "type": "object", "title": "GetPriceResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "The data", "$ref": "#/definitions/priceGetPriceResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "is_premium": false, "is_promotion": false, "membership_price": { "product": { "currency": "USD", "price": 8.06 }, "reseller": { "currency": "USD", "price": 8.06 } }, "price": { "product": { "currency": "USD", "price": 8.06 }, "reseller": { "currency": "USD", "price": 8.06 } }, "promotion_data": { "end_date": "1589932800", "start_date": "1582156800" }, "tier_price": { "product": { "currency": "USD", "price": 8.06 }, "reseller": { "currency": "USD", "price": 8.06 } } }, "desc": "" } }, "priceGetPriceResponseData": { "type": "object", "title": "GetPriceResponseData", "properties": { "is_premium": { "type": "boolean", "format": "boolean", "title": "Indicates whether domain is premium or not" }, "is_promotion": { "type": "boolean", "format": "boolean", "title": "Indicates whether price is promotion or not" }, "membership_price": { "title": "Operation membership price", "$ref": "#/definitions/domainPriceGroup" }, "price": { "title": "Operation price", "$ref": "#/definitions/domainPriceGroup" }, "promotion_data": { "title": "Promotion data", "$ref": "#/definitions/pricePromotionData" }, "tier_price": { "title": "Operation price without promo", "$ref": "#/definitions/domainPriceGroup" } }, "example": { "is_premium": false, "is_promotion": false, "membership_price": { "product": { "currency": "USD", "price": 8.06 }, "reseller": { "currency": "USD", "price": 8.06 } }, "price": { "product": { "currency": "USD", "price": 8.06 }, "reseller": { "currency": "USD", "price": 8.06 } }, "promotion_data": { "end_date": "1589932800", "start_date": "1582156800" }, "tier_price": { "product": { "currency": "USD", "price": 8.06 }, "reseller": { "currency": "USD", "price": 8.06 } } } }, "pricePromotionData": { "type": "object", "title": "PromotionData", "properties": { "end_date": { "type": "string", "title": "Date when promotion is end" }, "start_date": { "type": "string", "title": "Date when promotion is start" } }, "example": { "end_date": "1589932800", "start_date": "1582156800" } }, "productGetProductResponse": { "type": "object", "title": "GetProductResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/productSslProduct" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "brand_name": "Comodo", "bypass_san": false, "category": "domain_validation", "delivery_time": "10m", "description": "An EssentialSSL certificate from Comodo is an affordable solution for securing your lite website or intranet. No hassle with paperworks, as the issuance is based on realtime domain checks.", "encryption": "40/256 bits", "free_refund_period": "30d", "free_reissue_period": "lifetime", "id": 123456789, "included_domains_count": 1, "is_extended_validation_supported": false, "is_idn_supported": false, "is_mobile_supported": false, "is_sgc_supported": false, "is_wildcard_multidomain_supported": false, "is_wildcard_supported": false, "level_prices": [ { "level": 1, "name": "EssentialSSL", "prices": [ { "extra_domain_price": { "product": { "currency": "USD", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } }, "extra_wildcard_domain_price": { "product": { "currency": "USD", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } }, "period": 1, "price": { "product": { "currency": "USD", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } } } ] } ], "max_domains": 1, "max_period": 2, "name": "EssentialSSL", "number_of_domains": 1, "order_module": "comodo", "prices": [ { "extra_domain_price": { "product": { "currency": "USD", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } }, "extra_wildcard_domain_price": { "product": { "currency": "USD", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } }, "period": 1, "price": { "product": { "currency": "USD", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } } } ], "root": "Chained root", "sub_category": "", "supported_software": [ { "id": "linux", "title": "Linux" } ], "validation_method": "domain", "warranty": { "product": { "currency": "USD", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } } }, "desc": "" } }, "productListProductsRequestOrderBy": { "type": "object", "title": "ListProductsRequestOrderBy", "properties": { "brand_name": { "type": "string", "title": "Sorting type (asc/desc)" }, "brand_seqno": { "type": "string", "title": "Sorting type (asc/desc)" }, "category": { "type": "string", "title": "Sorting type (asc/desc)" }, "name": { "type": "string", "title": "Sorting type (asc/desc)" }, "product_seqno": { "type": "string", "title": "Sorting type (asc/desc)" }, "sub_category": { "type": "string", "title": "Sorting type (asc/desc)" } } }, "productListProductsResponse": { "type": "object", "title": "ListProductsResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/productListProductsResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "results": [ { "brand_name": "Comodo", "bypass_san": false, "category": "domain_validation", "delivery_time": "10m", "description": "An EssentialSSL certificate from Comodo is an affordable solution for securing your lite website or intranet. No hassle with paperworks, as the issuance is based on realtime domain checks.", "encryption": "40/256 bits", "free_refund_period": "30d", "free_reissue_period": "lifetime", "id": 123456789, "included_domains_count": 1, "is_extended_validation_supported": false, "is_idn_supported": false, "is_mobile_supported": false, "is_sgc_supported": false, "is_wildcard_multidomain_supported": false, "is_wildcard_supported": false, "level_prices": [ { "level": 1, "name": "EssentialSSL", "prices": [ { "extra_domain_price": { "product": { "currency": "USD", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } }, "extra_wildcard_domain_price": { "product": { "currency": "USD", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } }, "period": 1, "price": { "product": { "currency": "USD", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } } } ] } ], "max_domains": 1, "max_period": 2, "name": "EssentialSSL", "number_of_domains": 1, "order_module": "comodo", "prices": [ { "extra_domain_price": { "product": { "currency": "USD", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } }, "extra_wildcard_domain_price": { "product": { "currency": "USD", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } }, "period": 1, "price": { "product": { "currency": "USD", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } } } ], "root": "Chained root", "sub_category": "", "supported_software": [ { "id": "linux", "title": "Linux" } ], "validation_method": "domain", "warranty": { "product": { "currency": "USD", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } } } ], "total": 999 }, "desc": "" } }, "productListProductsResponseData": { "type": "object", "title": "ListProductsResponseData", "properties": { "results": { "type": "array", "title": "Results list", "items": { "$ref": "#/definitions/productSslProduct" } }, "total": { "type": "integer", "format": "int32", "title": "Results count" } }, "example": { "results": [ { "brand_name": "Comodo", "bypass_san": false, "category": "domain_validation", "delivery_time": "10m", "description": "An EssentialSSL certificate from Comodo is an affordable solution for securing your lite website or intranet. No hassle with paperworks, as the issuance is based on realtime domain checks.", "encryption": "40/256 bits", "free_refund_period": "30d", "free_reissue_period": "lifetime", "id": 123456789, "included_domains_count": 1, "is_extended_validation_supported": false, "is_idn_supported": false, "is_mobile_supported": false, "is_sgc_supported": false, "is_wildcard_multidomain_supported": false, "is_wildcard_supported": false, "level_prices": [ { "level": 1, "name": "EssentialSSL", "prices": [ { "extra_domain_price": { "product": { "currency": "USD", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } }, "extra_wildcard_domain_price": { "product": { "currency": "USD", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } }, "period": 1, "price": { "product": { "currency": "USD", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } } } ] } ], "max_domains": 1, "max_period": 2, "name": "EssentialSSL", "number_of_domains": 1, "order_module": "comodo", "prices": [ { "extra_domain_price": { "product": { "currency": "USD", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } }, "extra_wildcard_domain_price": { "product": { "currency": "USD", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } }, "period": 1, "price": { "product": { "currency": "USD", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } } } ], "root": "Chained root", "sub_category": "", "supported_software": [ { "id": "linux", "title": "Linux" } ], "validation_method": "domain", "warranty": { "product": { "currency": "USD", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } } } ], "total": 999 } }, "productSslProduct": { "type": "object", "title": "SslProduct", "properties": { "brand_name": { "type": "string", "title": "Product brand" }, "bypass_san": { "type": "boolean", "format": "boolean", "title": "Bypass SAN (Subject Alternative Name) (deprecated)" }, "category": { "type": "string", "title": "Product category: DV, OV, EV" }, "delivery_time": { "description": "Average period of time between order creation and completion.", "type": "string" }, "description": { "type": "string", "title": "Marketing description (if exists)" }, "encryption": { "type": "string", "title": "Indicates the encryption level of the root certificate (40/256 bits or 128/256 bits)" }, "free_refund_period": { "type": "string", "title": "The period during which cancellation of the product can be refunded" }, "free_reissue_period": { "type": "string", "title": "The period during which cancellation of the product can be refunded" }, "id": { "type": "integer", "format": "int32", "title": "Object id" }, "included_domains_count": { "type": "integer", "format": "int32", "title": "The included domains count. '-1' in a case of Wildcard product or 1,2,3 in a case of Single/Multidomain product" }, "is_extended_validation_supported": { "type": "boolean", "format": "boolean", "title": "Indicates if product supports Extended Validation" }, "is_idn_supported": { "type": "boolean", "format": "boolean", "title": "Indicates if IDN domain names are supported" }, "is_mobile_supported": { "type": "boolean", "format": "boolean", "title": "Indicates, if mobile devices are supported (deprecated)" }, "is_sgc_supported": { "type": "boolean", "format": "boolean", "title": "Indicates, if Server Gated Cryptography supported (deprecated)" }, "is_wildcard_multidomain_supported": { "type": "boolean", "format": "boolean", "title": "Indicates, if product supports wildcard domains" }, "is_wildcard_supported": { "type": "boolean", "format": "boolean", "title": "Indicates, if product supports wildcard certificates" }, "level_prices": { "type": "array", "title": "List of level prices", "items": { "$ref": "#/definitions/productSslProductLevelPrices" } }, "max_domains": { "description": "Applies only to multi-domain certificates.", "type": "integer", "format": "int32" }, "max_period": { "type": "integer", "format": "int32", "title": "Max period certificate can be issued for" }, "name": { "type": "string", "title": "Product name" }, "number_of_domains": { "type": "integer", "format": "int32", "title": "Indicates domain(s) quantity included in the regular price. Extends in a case of Multi-domain products but for an additional fee" }, "order_module": { "type": "string", "title": "Indicates module that is related to the current product (Comodo, Symantec)" }, "prices": { "type": "array", "title": "Array of price parameters and values", "items": { "$ref": "#/definitions/productSslProductPrices" } }, "root": { "type": "string", "title": "Default: chained root" }, "sub_category": { "type": "string", "title": "A sub-category of the product (deprecated field)" }, "supported_software": { "type": "array", "title": "Include a list of supported platforms", "items": { "$ref": "#/definitions/productSslProductSupportedSoftware" } }, "validation_method": { "type": "string", "title": "Certificate validation method" }, "warranty": { "title": "Returns an array of warranty in USD and reseller currency", "$ref": "#/definitions/productSslProductWarranty" } }, "example": { "brand_name": "Comodo", "bypass_san": false, "category": "domain_validation", "delivery_time": "10m", "description": "An EssentialSSL certificate from Comodo is an affordable solution for securing your lite website or intranet. No hassle with paperworks, as the issuance is based on realtime domain checks.", "encryption": "40/256 bits", "free_refund_period": "30d", "free_reissue_period": "lifetime", "id": 123456789, "included_domains_count": 1, "is_extended_validation_supported": false, "is_idn_supported": false, "is_mobile_supported": false, "is_sgc_supported": false, "is_wildcard_multidomain_supported": false, "is_wildcard_supported": false, "level_prices": [ { "level": 1, "name": "EssentialSSL", "prices": [ { "extra_domain_price": { "product": { "currency": "USD", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } }, "extra_wildcard_domain_price": { "product": { "currency": "USD", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } }, "period": 1, "price": { "product": { "currency": "USD", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } } } ] } ], "max_domains": 1, "max_period": 2, "name": "EssentialSSL", "number_of_domains": 1, "order_module": "comodo", "prices": [ { "extra_domain_price": { "product": { "currency": "USD", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } }, "extra_wildcard_domain_price": { "product": { "currency": "USD", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } }, "period": 1, "price": { "product": { "currency": "USD", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } } } ], "root": "Chained root", "sub_category": "", "supported_software": [ { "id": "linux", "title": "Linux" } ], "validation_method": "domain", "warranty": { "product": { "currency": "USD", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } } } }, "productSslProductLevelPrices": { "type": "object", "title": "SslProductLevelPrices", "properties": { "level": { "type": "integer", "format": "int32", "title": "Price level" }, "name": { "type": "string", "title": "Product name" }, "prices": { "type": "array", "title": "Array of price parameters and values", "items": { "$ref": "#/definitions/productSslProductPrices" } } }, "example": { "level": 1, "name": "EssentialSSL", "prices": [ { "extra_domain_price": { "product": { "currency": "USD", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } }, "extra_wildcard_domain_price": { "product": { "currency": "USD", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } }, "period": 1, "price": { "product": { "currency": "USD", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } } } ] } }, "productSslProductPrice": { "type": "object", "title": "SslProductPrice", "properties": { "currency": { "type": "string", "title": "Currency" }, "price": { "type": "number", "format": "double", "title": "Product price" } }, "example": { "currency": "USD", "price": 0 } }, "productSslProductPriceGroup": { "type": "object", "title": "SslProductPriceGroup", "properties": { "product": { "title": "Price in product currency", "$ref": "#/definitions/productSslProductPrice" }, "reseller": { "title": "Price in reseller currency", "$ref": "#/definitions/productSslProductReseller" } }, "example": { "product": { "currency": "USD", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } } }, "productSslProductPrices": { "type": "object", "title": "SslProductPrices", "properties": { "extra_domain_price": { "title": "Group of parameters indicating price for additional (extra) domains", "$ref": "#/definitions/productSslProductPriceGroup" }, "extra_wildcard_domain_price": { "title": "Group of parameters indicating price for additional (extra) wildcard domains", "$ref": "#/definitions/productSslProductPriceGroup" }, "period": { "type": "integer", "format": "int32", "title": "Certificate issuance period" }, "price": { "title": "Product price", "$ref": "#/definitions/productSslProductPriceGroup" } }, "example": { "extra_domain_price": { "product": { "currency": "USD", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } }, "extra_wildcard_domain_price": { "product": { "currency": "USD", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } }, "period": 1, "price": { "product": { "currency": "USD", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } } } }, "productSslProductReseller": { "type": "object", "title": "SslProductReseller", "properties": { "currency": { "type": "string", "title": "Currency" }, "price": { "type": "number", "format": "double", "title": "Product price" } }, "example": { "currency": "EUR", "price": 0 } }, "productSslProductSupportedSoftware": { "type": "object", "title": "SslProductSupportedSoftware", "properties": { "id": { "type": "string", "title": "Object id" }, "title": { "type": "string", "title": "Platform title" } }, "example": { "id": "linux", "title": "Linux" } }, "productSslProductWarranty": { "type": "object", "title": "SslProductWarranty", "properties": { "product": { "title": "Price in product currency", "$ref": "#/definitions/productSslProductPrice" }, "reseller": { "title": "Price in reseller currency", "$ref": "#/definitions/productSslProductReseller" } }, "example": { "product": { "currency": "USD", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } } }, "recordListZoneRecordsOrderBy": { "type": "object", "title": "ListZoneRecordsOrderBy", "properties": { "name": { "type": "string", "title": "Sorting type (asc/desc)", "default": "asc" }, "prio": { "type": "string", "title": "Sorting type (asc/desc)" }, "ttl": { "type": "string", "title": "Sorting type (asc/desc)" }, "type": { "type": "string", "title": "Sorting type (asc/desc)", "default": "asc" }, "value": { "type": "string", "title": "Sorting type (asc/desc)" } }, "example": { "name": "asc", "prio": "", "ttl": "", "type": "asc", "value": "" } }, "recordListZoneRecordsResponse": { "type": "object", "title": "ListZoneRecordsResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/recordListZoneRecordsResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "results": [ { "creation_date": "", "ip": "127.0.0.1", "modification_date": "", "name": "domain.com", "prio": 1, "ttl": 900, "type": "CNAME", "value": "abcd.domain.com" } ], "total": 6 }, "desc": "" } }, "recordListZoneRecordsResponseData": { "type": "object", "title": "ListZoneRecordsResponseData", "properties": { "results": { "type": "array", "title": "Array of search results", "items": { "$ref": "#/definitions/recordRecordInfo" } }, "total": { "type": "integer", "format": "int32", "title": "Number of search results" } }, "example": { "results": [ { "creation_date": "", "ip": "127.0.0.1", "modification_date": "", "name": "domain.com", "prio": 1, "ttl": 900, "type": "CNAME", "value": "abcd.domain.com" } ], "total": 6 } }, "recordRecordInfo": { "type": "object", "title": "RecordInfo", "properties": { "creation_date": { "type": "string", "title": "DNS record creation date" }, "ip": { "type": "string", "title": "DNS record IP address" }, "modification_date": { "type": "string", "title": "DNS record last modification date" }, "name": { "type": "string", "title": "DNS record name" }, "prio": { "type": "integer", "format": "int32", "title": "DNS record priority" }, "ttl": { "type": "integer", "format": "int32", "title": "DNS record priority" }, "type": { "type": "string", "title": "DNS record type" }, "value": { "type": "string", "title": "DNS record value" } }, "example": { "creation_date": "", "ip": "127.0.0.1", "modification_date": "", "name": "domain.com", "prio": 1, "ttl": 900, "type": "CNAME", "value": "abcd.domain.com" } }, "resellerGetResellerResponse": { "type": "object", "title": "GetResellerResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/resellerReseller" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "additional_data": { "cif_nif_number": "12345678", "gstin": "123456789aaa", "internal_reference": "" }, "address": { "city": "Test city", "country": "NL", "number": "123", "state": "Testprovince", "street": "Test street", "suffix": "A", "zipcode": "1235 XX" }, "balance": 99999, "comments": "Some comment here", "company_name": "Example company", "contacts": [ { "additional_data": { "birth_city": "Test city", "birth_date": "1969-12-31", "social_security_number": "12326178T" }, "address": { "city": "Test city", "country": "NL", "number": "123", "state": "Testprovince", "street": "Test street", "suffix": "A", "zipcode": "1235 XX" }, "api_access_enabled": true, "api_client_ip_list": { "allow": [ "127.0.0.1" ], "deny": [ "127.0.0.1" ] }, "auth_type": "simple", "comments": "", "company_name": "Example company", "email": "test@mail.tld", "hash_changed_at": "2019-03-25 10:17:02", "id": 123456789, "is_active": false, "last_api_call_at": "2019-03-25 10:17:01", "last_login_at": "2019-04-12 11:58:39", "locale": "nl_NL", "name": { "first_name": "Test", "full_name": "Test Person", "initials": "T P", "last_name": "Person", "prefix": "Mr" }, "password_change_declined_at": "2019-03-23 12:32:15", "password_changed_at": "2019-03-25 10:17:00", "phone": { "area_code": "111", "country_code": "+03", "subscriber_number": "123456" }, "rcp_client_ip_list": { "allow": [ "127.0.0.1" ], "deny": [ "127.0.0.1" ] }, "reseller_id": 12345, "role": "admin", "secret_key": "SECRETKEYVALUE", "username": "user_name", "vat": "XX123456789X12" } ], "email": "", "fax": { "area_code": "", "country_code": "", "subscriber_number": "" }, "id": 123456789, "locale": "nl_NL", "name": { "first_name": "Test", "full_name": "Test Person", "initials": "T P", "last_name": "Person", "prefix": "Mr" }, "phone": { "area_code": "111", "country_code": "+03", "subscriber_number": "123456" }, "reserved_balance": 1111.11, "settings": { "av_handle": "XX123456-XX", "claims_confirm_url": "http://www.domain.tld/confirm-tm_claims.php?domainId=%%domainId%%&domain=%%domain%%&code=%%authCode%%", "claims_email_subject": "Hi there! You need to accept registration for %%domain%%!", "claims_reseller_name": "Jon Doe's Webhosting!!", "claims_sender_email": "test@mail.tld", "currency": "EUR", "default_domain_billing_handle": "XX123456-XX", "default_domain_reseller_handle": "XX123456-XX", "foa_confirm_url": "", "foa_email_subject": "", "foa_reseller_name": "", "foa_sender_email": "", "foa_terms_conditions_url": "", "is_auto_renew_enabled": false, "is_custom_nses_enabled": false, "ive2_customized_body": "", "ive2_email_subject": "[URGENT REMINDER] Request for e-mail address verification", "ive_confirm_url": "http://icann-verification.registrar.eu/?email=%%email%%&authCode=%%authCode%%", "ive_customized_body": "", "ive_email_subject": "Request for e-mail address verification", "ive_reseller_name": "sdasd", "ive_sender_email": "do-not-reply@registrar.eu", "jurisdiction": "EU", "language": "EN", "maximum_credit": 20000, "maximum_credit_card_payment": 15000, "maximum_i_deal_payment": 1000000, "maximum_western_union_payment": 1000, "minimum_payment": 20, "minimum_western_union_payment": 500, "pay_methods": [ "ideal" ], "payment_methods": [ { "name": "ideal", "settings": { "limit": { "maximum": { "aud": 0, "bgn": 0, "brl": 0, "cad": 0, "chf": 0, "cny": 0, "czk": 0, "dkk": 0, "eek": 0, "eur": 0, "gbp": 0, "ghs": 0, "hkd": 0, "hrk": 0, "huf": 0, "idr": 0, "ils": 0, "inr": 0, "jpy": 0, "krw": 0, "lkr": 0, "ltl": 0, "lvl": 0, "mxn": 0, "myr": 0, "nok": 0, "nzd": 0, "php": 0, "pln": 0, "ron": 0, "rub": 0, "sek": 0, "sgd": 0, "thb": 0, "try": 0, "usd": 0, "zar": 0 }, "minimum": { "aud": 0, "bgn": 0, "brl": 0, "cad": 0, "chf": 0, "cny": 0, "czk": 0, "dkk": 0, "eek": 0, "eur": 0, "gbp": 0, "ghs": 0, "hkd": 0, "hrk": 0, "huf": 0, "idr": 0, "ils": 0, "inr": 0, "jpy": 0, "krw": 0, "lkr": 0, "ltl": 0, "lvl": 0, "mxn": 0, "myr": 0, "nok": 0, "nzd": 0, "php": 0, "pln": 0, "ron": 0, "rub": 0, "sek": 0, "sgd": 0, "thb": 0, "try": 0, "usd": 0, "zar": 0 } }, "transaction_fee": 0, "transaction_fee_absolute": 0 } } ], "preregistered_domain_priorities": "[]", "recurring_payment_methods": [ { "name": "ideal", "settings": { "limit": { "maximum": { "aud": 0, "bgn": 0, "brl": 0, "cad": 0, "chf": 0, "cny": 0, "czk": 0, "dkk": 0, "eek": 0, "eur": 0, "gbp": 0, "ghs": 0, "hkd": 0, "hrk": 0, "huf": 0, "idr": 0, "ils": 0, "inr": 0, "jpy": 0, "krw": 0, "lkr": 0, "ltl": 0, "lvl": 0, "mxn": 0, "myr": 0, "nok": 0, "nzd": 0, "php": 0, "pln": 0, "ron": 0, "rub": 0, "sek": 0, "sgd": 0, "thb": 0, "try": 0, "usd": 0, "zar": 0 }, "minimum": { "aud": 0, "bgn": 0, "brl": 0, "cad": 0, "chf": 0, "cny": 0, "czk": 0, "dkk": 0, "eek": 0, "eur": 0, "gbp": 0, "ghs": 0, "hkd": 0, "hrk": 0, "huf": 0, "idr": 0, "ils": 0, "inr": 0, "jpy": 0, "krw": 0, "lkr": 0, "ltl": 0, "lvl": 0, "mxn": 0, "myr": 0, "nok": 0, "nzd": 0, "php": 0, "pln": 0, "ron": 0, "rub": 0, "sek": 0, "sgd": 0, "thb": 0, "try": 0, "usd": 0, "zar": 0 } }, "transaction_fee": 0, "transaction_fee_absolute": 0 } } ], "renew_notification_days": [ 1 ], "renew_notification_every_week": false, "tac_contract": { "is_signed": false, "name": "opensign_terms_and_conditions", "signed_at": "2014-07-16 15:22:48", "type": "opensign" }, "tags": [ "VIPCUSTOMER" ], "transaction_fee": { "bank": 0, "credit_card": 3, "ideal": 0, "paypal": 5, "western_union": 0, "yandex": 5 }, "type": "normal" }, "statistics": { "currency": { "modified": "2010-08-01 9:30:54" }, "customer": { "modified": "2019-05-03 13:23:01", "total": 999 }, "dns": { "total": 999 }, "domain": { "by_status": { "act": 7, "fai": 419, "nsr": 0, "pen": 0, "rej": 5, "req": 15 }, "total": 999 }, "level": 3, "license": { "total": 999 }, "spam_experts": { "activated_at": "2012-10-29 10:48:30", "created_at": "2012-10-29 10:48:30", "exists": false, "expired_at": "2016-04-05 8:50:34", "incoming_count": 0, "incoming_limit": 10, "outgoing_count": 0, "outgoing_limit": 1, "status": "deleted", "with_outgoing_filter": false }, "ssl": { "by_status": { "act": 7, "fai": 419, "nsr": 0, "pen": 0, "rej": 5, "req": 15 }, "total": 999 } }, "status": "new", "tier": 3, "vat": "", "vatperc": 21 }, "desc": "" } }, "resellerReseller": { "type": "object", "title": "Reseller", "properties": { "additional_data": { "title": "Collection of data fields that contain additional customer information", "$ref": "#/definitions/resellerResellerAdditionalData" }, "address": { "title": "Address", "$ref": "#/definitions/contactAddress" }, "balance": { "type": "number", "format": "double", "title": "Available account balance" }, "comments": { "type": "string", "title": "Custom notes to the specified handle" }, "company_name": { "type": "string", "title": "Company name" }, "contacts": { "type": "array", "title": "Reseller contacts list", "items": { "$ref": "#/definitions/personcontactContact" } }, "email": { "type": "string", "title": "Email address" }, "fax": { "title": "Fax number", "$ref": "#/definitions/customerFax" }, "id": { "type": "integer", "format": "int32", "title": "Object ID" }, "locale": { "type": "string", "title": "Customer's language" }, "name": { "title": "The name", "$ref": "#/definitions/contactName" }, "phone": { "title": "Phone number", "$ref": "#/definitions/contactPhone" }, "reserved_balance": { "type": "number", "format": "double", "title": "Balance, reserved in reseller's account for pending transactions" }, "settings": { "title": "Array of settings", "$ref": "#/definitions/resellerSettings" }, "statistics": { "title": "Reseller statistics", "$ref": "#/definitions/resellerStatistics" }, "status": { "type": "string", "title": "The status" }, "tier": { "type": "integer", "format": "int32", "title": "Openprovider discount tier" }, "vat": { "type": "string", "title": "Domain owner's VAT number" }, "vatperc": { "type": "number", "format": "double", "title": "VAT percentage" } }, "example": { "additional_data": { "cif_nif_number": "12345678", "gstin": "123456789aaa", "internal_reference": "" }, "address": { "city": "Test city", "country": "NL", "number": "123", "state": "Testprovince", "street": "Test street", "suffix": "A", "zipcode": "1235 XX" }, "balance": 99999, "comments": "Some comment here", "company_name": "Example company", "contacts": [ { "additional_data": { "birth_city": "Test city", "birth_date": "1969-12-31", "social_security_number": "12326178T" }, "address": { "city": "Test city", "country": "NL", "number": "123", "state": "Testprovince", "street": "Test street", "suffix": "A", "zipcode": "1235 XX" }, "api_access_enabled": true, "api_client_ip_list": { "allow": [ "127.0.0.1" ], "deny": [ "127.0.0.1" ] }, "auth_type": "simple", "comments": "", "company_name": "Example company", "email": "test@mail.tld", "hash_changed_at": "2019-03-25 10:17:02", "id": 123456789, "is_active": false, "last_api_call_at": "2019-03-25 10:17:01", "last_login_at": "2019-04-12 11:58:39", "locale": "nl_NL", "name": { "first_name": "Test", "full_name": "Test Person", "initials": "T P", "last_name": "Person", "prefix": "Mr" }, "password_change_declined_at": "2019-03-23 12:32:15", "password_changed_at": "2019-03-25 10:17:00", "phone": { "area_code": "111", "country_code": "+03", "subscriber_number": "123456" }, "rcp_client_ip_list": { "allow": [ "127.0.0.1" ], "deny": [ "127.0.0.1" ] }, "reseller_id": 12345, "role": "admin", "secret_key": "SECRETKEYVALUE", "username": "user_name", "vat": "XX123456789X12" } ], "email": "", "fax": { "area_code": "", "country_code": "", "subscriber_number": "" }, "id": 123456789, "locale": "nl_NL", "name": { "first_name": "Test", "full_name": "Test Person", "initials": "T P", "last_name": "Person", "prefix": "Mr" }, "phone": { "area_code": "111", "country_code": "+03", "subscriber_number": "123456" }, "reserved_balance": 1111.11, "settings": { "av_handle": "XX123456-XX", "claims_confirm_url": "http://www.domain.tld/confirm-tm_claims.php?domainId=%%domainId%%&domain=%%domain%%&code=%%authCode%%", "claims_email_subject": "Hi there! You need to accept registration for %%domain%%!", "claims_reseller_name": "Jon Doe's Webhosting!!", "claims_sender_email": "test@mail.tld", "currency": "EUR", "default_domain_billing_handle": "XX123456-XX", "default_domain_reseller_handle": "XX123456-XX", "foa_confirm_url": "", "foa_email_subject": "", "foa_reseller_name": "", "foa_sender_email": "", "foa_terms_conditions_url": "", "is_auto_renew_enabled": false, "is_custom_nses_enabled": false, "ive2_customized_body": "", "ive2_email_subject": "[URGENT REMINDER] Request for e-mail address verification", "ive_confirm_url": "http://icann-verification.registrar.eu/?email=%%email%%&authCode=%%authCode%%", "ive_customized_body": "", "ive_email_subject": "Request for e-mail address verification", "ive_reseller_name": "sdasd", "ive_sender_email": "do-not-reply@registrar.eu", "jurisdiction": "EU", "language": "EN", "maximum_credit": 20000, "maximum_credit_card_payment": 15000, "maximum_i_deal_payment": 1000000, "maximum_western_union_payment": 1000, "minimum_payment": 20, "minimum_western_union_payment": 500, "pay_methods": [ "ideal" ], "payment_methods": [ { "name": "ideal", "settings": { "limit": { "maximum": { "aud": 0, "bgn": 0, "brl": 0, "cad": 0, "chf": 0, "cny": 0, "czk": 0, "dkk": 0, "eek": 0, "eur": 0, "gbp": 0, "ghs": 0, "hkd": 0, "hrk": 0, "huf": 0, "idr": 0, "ils": 0, "inr": 0, "jpy": 0, "krw": 0, "lkr": 0, "ltl": 0, "lvl": 0, "mxn": 0, "myr": 0, "nok": 0, "nzd": 0, "php": 0, "pln": 0, "ron": 0, "rub": 0, "sek": 0, "sgd": 0, "thb": 0, "try": 0, "usd": 0, "zar": 0 }, "minimum": { "aud": 0, "bgn": 0, "brl": 0, "cad": 0, "chf": 0, "cny": 0, "czk": 0, "dkk": 0, "eek": 0, "eur": 0, "gbp": 0, "ghs": 0, "hkd": 0, "hrk": 0, "huf": 0, "idr": 0, "ils": 0, "inr": 0, "jpy": 0, "krw": 0, "lkr": 0, "ltl": 0, "lvl": 0, "mxn": 0, "myr": 0, "nok": 0, "nzd": 0, "php": 0, "pln": 0, "ron": 0, "rub": 0, "sek": 0, "sgd": 0, "thb": 0, "try": 0, "usd": 0, "zar": 0 } }, "transaction_fee": 0, "transaction_fee_absolute": 0 } } ], "preregistered_domain_priorities": "[]", "recurring_payment_methods": [ { "name": "ideal", "settings": { "limit": { "maximum": { "aud": 0, "bgn": 0, "brl": 0, "cad": 0, "chf": 0, "cny": 0, "czk": 0, "dkk": 0, "eek": 0, "eur": 0, "gbp": 0, "ghs": 0, "hkd": 0, "hrk": 0, "huf": 0, "idr": 0, "ils": 0, "inr": 0, "jpy": 0, "krw": 0, "lkr": 0, "ltl": 0, "lvl": 0, "mxn": 0, "myr": 0, "nok": 0, "nzd": 0, "php": 0, "pln": 0, "ron": 0, "rub": 0, "sek": 0, "sgd": 0, "thb": 0, "try": 0, "usd": 0, "zar": 0 }, "minimum": { "aud": 0, "bgn": 0, "brl": 0, "cad": 0, "chf": 0, "cny": 0, "czk": 0, "dkk": 0, "eek": 0, "eur": 0, "gbp": 0, "ghs": 0, "hkd": 0, "hrk": 0, "huf": 0, "idr": 0, "ils": 0, "inr": 0, "jpy": 0, "krw": 0, "lkr": 0, "ltl": 0, "lvl": 0, "mxn": 0, "myr": 0, "nok": 0, "nzd": 0, "php": 0, "pln": 0, "ron": 0, "rub": 0, "sek": 0, "sgd": 0, "thb": 0, "try": 0, "usd": 0, "zar": 0 } }, "transaction_fee": 0, "transaction_fee_absolute": 0 } } ], "renew_notification_days": [ 1 ], "renew_notification_every_week": false, "tac_contract": { "is_signed": false, "name": "opensign_terms_and_conditions", "signed_at": "2014-07-16 15:22:48", "type": "opensign" }, "tags": [ "VIPCUSTOMER" ], "transaction_fee": { "bank": 0, "credit_card": 3, "ideal": 0, "paypal": 5, "western_union": 0, "yandex": 5 }, "type": "normal" }, "statistics": { "currency": { "modified": "2010-08-01 9:30:54" }, "customer": { "modified": "2019-05-03 13:23:01", "total": 999 }, "dns": { "total": 999 }, "domain": { "by_status": { "act": 7, "fai": 419, "nsr": 0, "pen": 0, "rej": 5, "req": 15 }, "total": 999 }, "level": 3, "license": { "total": 999 }, "spam_experts": { "activated_at": "2012-10-29 10:48:30", "created_at": "2012-10-29 10:48:30", "exists": false, "expired_at": "2016-04-05 8:50:34", "incoming_count": 0, "incoming_limit": 10, "outgoing_count": 0, "outgoing_limit": 1, "status": "deleted", "with_outgoing_filter": false }, "ssl": { "by_status": { "act": 7, "fai": 419, "nsr": 0, "pen": 0, "rej": 5, "req": 15 }, "total": 999 } }, "status": "new", "tier": 3, "vat": "", "vatperc": 21 } }, "resellerResellerAdditionalData": { "type": "object", "title": "ResellerAdditionalData", "properties": { "cif_nif_number": { "type": "string", "title": "Custom invoice information" }, "gstin": { "type": "string", "title": "The gstin" }, "internal_reference": { "type": "string", "title": "Custom invoice information" } }, "example": { "cif_nif_number": "12345678", "gstin": "123456789aaa", "internal_reference": "" } }, "resellerSettings": { "type": "object", "title": "Settings", "properties": { "av_handle": { "type": "string", "title": "Account administrative handle" }, "claims_confirm_url": { "type": "string", "title": "Trademark claims confirmation URL" }, "claims_email_subject": { "type": "string", "title": "Trademark claims email subject" }, "claims_reseller_name": { "type": "string", "title": "Trademark claims reseller name" }, "claims_sender_email": { "type": "string", "title": "Trademark claims sender email address" }, "currency": { "type": "string", "title": "The currency" }, "default_domain_billing_handle": { "type": "string", "title": "BIlling handle used by default for domain registrations" }, "default_domain_reseller_handle": { "type": "string", "title": "Reseller handle used by default for domain registrations" }, "foa_confirm_url": { "type": "string", "title": "Form of authorization confirmation URL" }, "foa_email_subject": { "type": "string", "title": "Form of authorization email subject" }, "foa_reseller_name": { "type": "string", "title": "Reseller name to display in form of authorization emails" }, "foa_sender_email": { "type": "string", "title": "Sender email to display in form of authorization emails" }, "foa_terms_conditions_url": { "type": "string", "title": "URL to form of authorization T&Cs to display" }, "is_auto_renew_enabled": { "type": "boolean", "format": "boolean", "title": "Global autorenew setting status" }, "is_custom_nses_enabled": { "type": "boolean", "format": "boolean", "title": "Indicates if custom NS records allowed for reseller's DNS zones" }, "ive2_customized_body": { "type": "string", "title": "Customized subject of email verification reminder messages" }, "ive2_email_subject": { "type": "string", "title": "Customized subject of email verification reminder messages" }, "ive_confirm_url": { "type": "string", "title": "Email verification confirmation URL" }, "ive_customized_body": { "type": "string", "title": "Customized contents of email verification messages" }, "ive_email_subject": { "type": "string", "title": "Customized subject of email verification messages" }, "ive_reseller_name": { "type": "string", "title": "Reseller name to display in email verification messages" }, "ive_sender_email": { "type": "string", "title": "Sender email address to display in email verification messages" }, "jurisdiction": { "type": "string", "title": "Reseller's jurisdiction" }, "language": { "type": "string", "title": "The language" }, "maximum_credit": { "type": "number", "format": "double", "title": "Maximum credit allowed for reseller" }, "maximum_credit_card_payment": { "type": "number", "format": "double", "title": "Maximum amount allowed to be paid using specified payment method" }, "maximum_i_deal_payment": { "type": "number", "format": "double", "title": "Maximum amount allowed to be paid using specified payment method" }, "maximum_western_union_payment": { "type": "number", "format": "double", "title": "Maximum amount allowed to be paid using specified payment method" }, "minimum_payment": { "type": "number", "format": "double", "title": "Minimal payment" }, "minimum_western_union_payment": { "type": "number", "format": "double", "title": "Minimal amount allowed to be paid using specified payment method" }, "pay_methods": { "type": "array", "title": "Payment methods", "items": { "type": "string" } }, "payment_methods": { "type": "array", "title": "Reseller recurring payment methods settings", "items": { "$ref": "#/definitions/settingsPaymentMethods" } }, "preregistered_domain_priorities": { "type": "string", "title": "The preregistered domain priorities" }, "recurring_payment_methods": { "type": "array", "title": "Reseller payment methods settings", "items": { "$ref": "#/definitions/settingsPaymentMethods" } }, "renew_notification_days": { "type": "array", "title": "Days before renewal reminder messages are sent", "items": { "type": "integer", "format": "int32" } }, "renew_notification_every_week": { "type": "boolean", "format": "boolean", "title": "Renew notification every week setting" }, "tac_contract": { "title": "Openprovider T&C contract", "$ref": "#/definitions/settingsTacContract" }, "tags": { "type": "array", "title": "Custom tags applied to entity", "items": { "type": "string" } }, "transaction_fee": { "title": "Additional fee per payment", "$ref": "#/definitions/settingsTransactionFee" }, "type": { "type": "string", "title": "The type" } }, "example": { "av_handle": "XX123456-XX", "claims_confirm_url": "http://www.domain.tld/confirm-tm_claims.php?domainId=%%domainId%%&domain=%%domain%%&code=%%authCode%%", "claims_email_subject": "Hi there! You need to accept registration for %%domain%%!", "claims_reseller_name": "Jon Doe's Webhosting!!", "claims_sender_email": "test@mail.tld", "currency": "EUR", "default_domain_billing_handle": "XX123456-XX", "default_domain_reseller_handle": "XX123456-XX", "foa_confirm_url": "", "foa_email_subject": "", "foa_reseller_name": "", "foa_sender_email": "", "foa_terms_conditions_url": "", "is_auto_renew_enabled": false, "is_custom_nses_enabled": false, "ive2_customized_body": "", "ive2_email_subject": "[URGENT REMINDER] Request for e-mail address verification", "ive_confirm_url": "http://icann-verification.registrar.eu/?email=%%email%%&authCode=%%authCode%%", "ive_customized_body": "", "ive_email_subject": "Request for e-mail address verification", "ive_reseller_name": "sdasd", "ive_sender_email": "do-not-reply@registrar.eu", "jurisdiction": "EU", "language": "EN", "maximum_credit": 20000, "maximum_credit_card_payment": 15000, "maximum_i_deal_payment": 1000000, "maximum_western_union_payment": 1000, "minimum_payment": 20, "minimum_western_union_payment": 500, "pay_methods": [ "ideal" ], "payment_methods": [ { "name": "ideal", "settings": { "limit": { "maximum": { "aud": 0, "bgn": 0, "brl": 0, "cad": 0, "chf": 0, "cny": 0, "czk": 0, "dkk": 0, "eek": 0, "eur": 0, "gbp": 0, "ghs": 0, "hkd": 0, "hrk": 0, "huf": 0, "idr": 0, "ils": 0, "inr": 0, "jpy": 0, "krw": 0, "lkr": 0, "ltl": 0, "lvl": 0, "mxn": 0, "myr": 0, "nok": 0, "nzd": 0, "php": 0, "pln": 0, "ron": 0, "rub": 0, "sek": 0, "sgd": 0, "thb": 0, "try": 0, "usd": 0, "zar": 0 }, "minimum": { "aud": 0, "bgn": 0, "brl": 0, "cad": 0, "chf": 0, "cny": 0, "czk": 0, "dkk": 0, "eek": 0, "eur": 0, "gbp": 0, "ghs": 0, "hkd": 0, "hrk": 0, "huf": 0, "idr": 0, "ils": 0, "inr": 0, "jpy": 0, "krw": 0, "lkr": 0, "ltl": 0, "lvl": 0, "mxn": 0, "myr": 0, "nok": 0, "nzd": 0, "php": 0, "pln": 0, "ron": 0, "rub": 0, "sek": 0, "sgd": 0, "thb": 0, "try": 0, "usd": 0, "zar": 0 } }, "transaction_fee": 0, "transaction_fee_absolute": 0 } } ], "preregistered_domain_priorities": "[]", "recurring_payment_methods": [ { "name": "ideal", "settings": { "limit": { "maximum": { "aud": 0, "bgn": 0, "brl": 0, "cad": 0, "chf": 0, "cny": 0, "czk": 0, "dkk": 0, "eek": 0, "eur": 0, "gbp": 0, "ghs": 0, "hkd": 0, "hrk": 0, "huf": 0, "idr": 0, "ils": 0, "inr": 0, "jpy": 0, "krw": 0, "lkr": 0, "ltl": 0, "lvl": 0, "mxn": 0, "myr": 0, "nok": 0, "nzd": 0, "php": 0, "pln": 0, "ron": 0, "rub": 0, "sek": 0, "sgd": 0, "thb": 0, "try": 0, "usd": 0, "zar": 0 }, "minimum": { "aud": 0, "bgn": 0, "brl": 0, "cad": 0, "chf": 0, "cny": 0, "czk": 0, "dkk": 0, "eek": 0, "eur": 0, "gbp": 0, "ghs": 0, "hkd": 0, "hrk": 0, "huf": 0, "idr": 0, "ils": 0, "inr": 0, "jpy": 0, "krw": 0, "lkr": 0, "ltl": 0, "lvl": 0, "mxn": 0, "myr": 0, "nok": 0, "nzd": 0, "php": 0, "pln": 0, "ron": 0, "rub": 0, "sek": 0, "sgd": 0, "thb": 0, "try": 0, "usd": 0, "zar": 0 } }, "transaction_fee": 0, "transaction_fee_absolute": 0 } } ], "renew_notification_days": [ 1 ], "renew_notification_every_week": false, "tac_contract": { "is_signed": false, "name": "opensign_terms_and_conditions", "signed_at": "2014-07-16 15:22:48", "type": "opensign" }, "tags": [ "VIPCUSTOMER" ], "transaction_fee": { "bank": 0, "credit_card": 3, "ideal": 0, "paypal": 5, "western_union": 0, "yandex": 5 }, "type": "normal" } }, "resellerStatistics": { "type": "object", "title": "Statistics", "properties": { "currency": { "title": "The currency", "$ref": "#/definitions/statisticsCurrencyStatistics" }, "customer": { "title": "The customer", "$ref": "#/definitions/statisticsCustomerStatistics" }, "dns": { "title": "Total count of DNS zones", "$ref": "#/definitions/statisticsDnsStatistics" }, "domain": { "title": "Statistics for domains", "$ref": "#/definitions/statisticsDomainStatistics" }, "level": { "type": "integer", "format": "int32", "title": "Openprovider discount tier" }, "license": { "title": "Statistics for Plesk / Virtuozzo licenses", "$ref": "#/definitions/statisticsLicenseStatistics" }, "spam_experts": { "title": "Statistics for Spamexperts bundles", "$ref": "#/definitions/statisticsSpamExpertsStatistics" }, "ssl": { "title": "Statistics for SSL", "$ref": "#/definitions/statisticsSslStatistics" } }, "example": { "currency": { "modified": "2010-08-01 9:30:54" }, "customer": { "modified": "2019-05-03 13:23:01", "total": 999 }, "dns": { "total": 999 }, "domain": { "by_status": { "act": 7, "fai": 419, "nsr": 0, "pen": 0, "rej": 5, "req": 15 }, "total": 999 }, "level": 3, "license": { "total": 999 }, "spam_experts": { "activated_at": "2012-10-29 10:48:30", "created_at": "2012-10-29 10:48:30", "exists": false, "expired_at": "2016-04-05 8:50:34", "incoming_count": 0, "incoming_limit": 10, "outgoing_count": 0, "outgoing_limit": 1, "status": "deleted", "with_outgoing_filter": false }, "ssl": { "by_status": { "act": 7, "fai": 419, "nsr": 0, "pen": 0, "rej": 5, "req": 15 }, "total": 999 } } }, "resellerUpdateResellerRequest": { "type": "object", "title": "UpdateResellerRequest", "properties": { "additional_data": { "title": "Collection of data fields that contain additional customer information", "$ref": "#/definitions/resellerResellerAdditionalData" }, "address": { "title": "Address", "$ref": "#/definitions/contactAddress" }, "comments": { "type": "string", "title": "Custom notes to the specified handle" }, "company_name": { "type": "string", "title": "Company name" }, "company_size": { "title": "Current company size", "$ref": "#/definitions/attributesCompanySize" }, "designation": { "title": "Designation", "$ref": "#/definitions/attributesDesignation" }, "fax": { "title": "Fax number", "$ref": "#/definitions/customerFax" }, "id": { "type": "integer", "format": "int32", "title": "Object ID" }, "industry": { "title": "Reseller's industry", "$ref": "#/definitions/attributesIndustry" }, "inn": { "type": "string", "title": "Customer's individual tax number (for Russian customers only)" }, "kpp": { "type": "string", "title": "KPP number. For Russian customers only" }, "locale": { "type": "string", "title": "Customer's language" }, "name": { "title": "The name", "$ref": "#/definitions/contactName" }, "phone": { "title": "Phone number", "$ref": "#/definitions/contactPhone" }, "referral_source": { "title": "Referral source", "$ref": "#/definitions/attributesReferralSource" }, "vat": { "type": "string", "title": "Domain owner's VAT number" } }, "example": { "additional_data": { "cif_nif_number": "12345678", "gstin": "123456789aaa", "internal_reference": "" }, "address": { "city": "Test city", "country": "NL", "number": "123", "state": "Testprovince", "street": "Test street", "suffix": "A", "zipcode": "1235 XX" }, "comments": "", "company_name": "Example company", "company_size": "MORE_THAN_1000", "designation": "UNKNOWN_DESIGNATION", "fax": { "area_code": "", "country_code": "", "subscriber_number": "" }, "id": 123456789, "industry": "UNKNOWN_INDUSTRY", "inn": "", "kpp": "", "locale": "", "name": { "first_name": "Test", "full_name": "Test Person", "initials": "T P", "last_name": "Person", "prefix": "Mr" }, "phone": { "area_code": "111", "country_code": "+03", "subscriber_number": "123456" }, "referral_source": "UNKNOWN_REFERRAL_SOURCE", "vat": "XX123456789X13" } }, "resellerUpdateResellerResponse": { "type": "object", "title": "UpdateResellerResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/resellerUpdateResellerResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "success": false }, "desc": "" } }, "resellerUpdateResellerResponseData": { "type": "object", "title": "UpdateResellerResponseData", "properties": { "success": { "type": "boolean", "format": "boolean", "title": "Indicates if operation was successful" } }, "example": { "success": false } }, "responseBoolResponse": { "type": "object", "title": "BoolResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/responseBoolResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "success": false }, "desc": "" } }, "responseBoolResponseData": { "type": "object", "title": "BoolResponseData", "properties": { "success": { "type": "boolean", "format": "boolean", "title": "Indicates if operation was successful" } }, "example": { "success": false } }, "se_domainAliasUpdates": { "type": "object", "title": "AliasUpdates", "properties": { "add": { "type": "array", "title": "Array of aliases to add", "items": { "type": "string" } }, "remove": { "type": "array", "title": "Array of aliases to remove", "items": { "type": "string" } } }, "example": { "add": [ "alias-to-add-example.com" ], "remove": [ "alias-to-remove-example.com" ] } }, "se_domainCreateDomainRequest": { "type": "object", "title": "CreateDomainRequest", "properties": { "aliases": { "type": "array", "title": "Array of aliases", "items": { "type": "string" } }, "bundle": { "type": "boolean", "format": "boolean", "title": "Indicates if old subscriptions backward compatibility is used" }, "destinations": { "type": "array", "title": "Array of destinations", "items": { "$ref": "#/definitions/se_domainDestination" } }, "domain_name": { "type": "string", "title": "Domain full name" }, "products": { "title": "Indicates which products are enabled", "$ref": "#/definitions/se_domainProducts" } }, "example": { "aliases": [ "alias.example.com" ], "bundle": false, "destinations": [ { "hostname": "dest.example.com", "port": 25 } ], "domain_name": "example.com", "products": { "archiving": false, "incoming": false, "outgoing": false } } }, "se_domainDestination": { "type": "object", "title": "Destination", "properties": { "hostname": { "type": "string", "title": "Destination host name" }, "port": { "type": "integer", "format": "int32", "title": "Destination port" } }, "example": { "hostname": "dest.example.com", "port": 25 } }, "se_domainDomain": { "type": "object", "title": "Domain", "properties": { "bundle": { "type": "boolean", "format": "boolean", "title": "The bundle" }, "domain_name": { "type": "string", "title": "Domain full name" }, "expiration_date": { "type": "string", "title": "Expiration date" }, "id": { "type": "integer", "format": "int32", "title": "Domain ID" }, "is_active": { "type": "boolean", "format": "boolean", "title": "Indicates if it is active" }, "order_id": { "type": "integer", "format": "int32", "title": "Order ID" }, "products": { "title": "Indicates which products are enabled", "$ref": "#/definitions/se_domainProducts" }, "records": { "title": "Array of records", "$ref": "#/definitions/se_domainRecords" }, "reseller_id": { "type": "integer", "format": "int32", "title": "Reseller ID" }, "smtp_password": { "type": "string", "title": "SMTP password" }, "user_email": { "type": "string", "title": "User email" }, "user_password": { "type": "string", "title": "User password" }, "with_outgoing_filter": { "type": "boolean", "format": "boolean", "title": "With outgoing filter" } }, "example": { "bundle": false, "domain_name": "example-filter.nl", "expiration_date": "2018-08-21 09:03:38", "id": 0, "is_active": false, "order_id": 0, "products": { "archiving": false, "incoming": false, "outgoing": false }, "records": { "aliases": [ "alias.example.com" ], "destinations": [ { "hostname": "dest.example.com", "port": 25 } ], "outgoing_user_ips": [ "123.123.123.123" ] }, "reseller_id": 0, "smtp_password": "567example912", "user_email": "admin@example-filter.nl", "user_password": "123example567", "with_outgoing_filter": false } }, "se_domainGetDomainResponse": { "type": "object", "title": "GetDomainResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/se_domainDomain" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates that the Openprovider system is temporarily unavailable because of maintenance" }, "warnings": { "type": "array", "title": "Contains warning responses if any", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "bundle": false, "domain_name": "example-filter.nl", "expiration_date": "2018-08-21 09:03:38", "id": 0, "is_active": false, "order_id": 0, "products": { "archiving": false, "incoming": false, "outgoing": false }, "records": { "aliases": [ "alias.example.com" ], "destinations": [ { "hostname": "dest.example.com", "port": 25 } ], "outgoing_user_ips": [ "123.123.123.123" ] }, "reseller_id": 0, "smtp_password": "567example912", "user_email": "admin@example-filter.nl", "user_password": "123example567", "with_outgoing_filter": false }, "desc": "" } }, "se_domainProducts": { "type": "object", "title": "Products", "properties": { "archiving": { "type": "boolean", "format": "boolean", "title": "Indicates if archiving enabled" }, "incoming": { "type": "boolean", "format": "boolean", "title": "Indicates if incoming enabled" }, "outgoing": { "type": "boolean", "format": "boolean", "title": "Indicates if outgoing enabled" } }, "example": { "archiving": false, "incoming": false, "outgoing": false } }, "se_domainRecords": { "type": "object", "title": "Records", "properties": { "aliases": { "type": "array", "title": "Array of aliases", "items": { "type": "string" } }, "destinations": { "type": "array", "title": "Array of destinations", "items": { "$ref": "#/definitions/se_domainDestination" } }, "outgoing_user_ips": { "type": "array", "title": "Array of outgoing user IP addresses", "items": { "type": "string" } } }, "example": { "aliases": [ "alias.example.com" ], "destinations": [ { "hostname": "dest.example.com", "port": 25 } ], "outgoing_user_ips": [ "123.123.123.123" ] } }, "se_domainUpdateDomainRequest": { "type": "object", "title": "UpdateDomainRequest", "properties": { "aliases": { "title": "Aliases grouped by action", "$ref": "#/definitions/se_domainAliasUpdates" }, "bundle": { "type": "boolean", "format": "boolean", "title": "Indicates if old subscriptions backward compatibility is used" }, "destinations": { "type": "array", "title": "Array of destinations", "items": { "$ref": "#/definitions/se_domainDestination" } }, "domain_name": { "type": "string", "title": "Domain full name" }, "products": { "title": "Indicates which products are enabled", "$ref": "#/definitions/se_domainProducts" } }, "example": { "aliases": { "add": [ "alias-to-add-example.com" ], "remove": [ "alias-to-remove-example.com" ] }, "bundle": false, "destinations": [ { "hostname": "dest.example.com", "port": 25 } ], "domain_name": "example.com", "products": { "archiving": false, "incoming": false, "outgoing": false } } }, "settingsGetSettingsResponse": { "type": "object", "title": "GetSettingsResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/settingsGetSettingsResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "av_handle": "XX123456-XX", "claims_confirm_url": "http://www.domain.tld/confirm-tm_claims.php?domainId=%%domainId%%&domain=%%domain%%&code=%%authCode%%", "claims_email_subject": "Hi there! You need to accept registration for %%domain%%!", "claims_reseller_name": "Jon Doe's Webhosting!!", "claims_sender_email": "test@mail.tld", "currency": "EUR", "default_domain_billing_handle": "XX123456-XX", "default_domain_reseller_handle": "XX123456-XX", "foa_confirm_url": "", "foa_email_subject": "", "foa_reseller_name": "", "foa_sender_email": "", "foa_terms_conditions_url": "", "is_auto_renew_enabled": false, "is_custom_nses_enabled": false, "ive2_customized_body": "", "ive2_email_subject": "[URGENT REMINDER] Request for e-mail address verification", "ive_confirm_url": "http://icann-verification.registrar.eu/?email=%%email%%&authCode=%%authCode%%", "ive_customized_body": "", "ive_email_subject": "Request for e-mail address verification", "ive_reseller_name": "sdasd", "ive_sender_email": "do-not-reply@registrar.eu", "jurisdiction": "EU", "language": "EN", "maximum_credit": 20000, "maximum_credit_card_payment": 15000, "maximum_i_deal_payment": 1000000, "maximum_western_union_payment": 1000, "minimum_payment": 20, "minimum_western_union_payment": 500, "pay_methods": [ "ideal" ], "payment_methods": [ { "name": "ideal", "settings": { "limit": { "maximum": { "aud": 0, "bgn": 0, "brl": 0, "cad": 0, "chf": 0, "cny": 0, "czk": 0, "dkk": 0, "eek": 0, "eur": 0, "gbp": 0, "ghs": 0, "hkd": 0, "hrk": 0, "huf": 0, "idr": 0, "ils": 0, "inr": 0, "jpy": 0, "krw": 0, "lkr": 0, "ltl": 0, "lvl": 0, "mxn": 0, "myr": 0, "nok": 0, "nzd": 0, "php": 0, "pln": 0, "ron": 0, "rub": 0, "sek": 0, "sgd": 0, "thb": 0, "try": 0, "usd": 0, "zar": 0 }, "minimum": { "aud": 0, "bgn": 0, "brl": 0, "cad": 0, "chf": 0, "cny": 0, "czk": 0, "dkk": 0, "eek": 0, "eur": 0, "gbp": 0, "ghs": 0, "hkd": 0, "hrk": 0, "huf": 0, "idr": 0, "ils": 0, "inr": 0, "jpy": 0, "krw": 0, "lkr": 0, "ltl": 0, "lvl": 0, "mxn": 0, "myr": 0, "nok": 0, "nzd": 0, "php": 0, "pln": 0, "ron": 0, "rub": 0, "sek": 0, "sgd": 0, "thb": 0, "try": 0, "usd": 0, "zar": 0 } }, "transaction_fee": 0, "transaction_fee_absolute": 0 } } ], "preregistered_domain_priorities": "[]", "recurring_payment_methods": [ { "name": "ideal", "settings": { "limit": { "maximum": { "aud": 0, "bgn": 0, "brl": 0, "cad": 0, "chf": 0, "cny": 0, "czk": 0, "dkk": 0, "eek": 0, "eur": 0, "gbp": 0, "ghs": 0, "hkd": 0, "hrk": 0, "huf": 0, "idr": 0, "ils": 0, "inr": 0, "jpy": 0, "krw": 0, "lkr": 0, "ltl": 0, "lvl": 0, "mxn": 0, "myr": 0, "nok": 0, "nzd": 0, "php": 0, "pln": 0, "ron": 0, "rub": 0, "sek": 0, "sgd": 0, "thb": 0, "try": 0, "usd": 0, "zar": 0 }, "minimum": { "aud": 0, "bgn": 0, "brl": 0, "cad": 0, "chf": 0, "cny": 0, "czk": 0, "dkk": 0, "eek": 0, "eur": 0, "gbp": 0, "ghs": 0, "hkd": 0, "hrk": 0, "huf": 0, "idr": 0, "ils": 0, "inr": 0, "jpy": 0, "krw": 0, "lkr": 0, "ltl": 0, "lvl": 0, "mxn": 0, "myr": 0, "nok": 0, "nzd": 0, "php": 0, "pln": 0, "ron": 0, "rub": 0, "sek": 0, "sgd": 0, "thb": 0, "try": 0, "usd": 0, "zar": 0 } }, "transaction_fee": 0, "transaction_fee_absolute": 0 } } ], "renew_notification_days": [ 1 ], "renew_notification_every_week": false, "signed_contracts": [ { "contents": "content for ac", "id": 1, "is_signed": false, "modification_date": "2009-02-19 10:59:32", "sign_on_date": "2009-02-19 10:59:32", "title": ".ac", "type": "ac", "version_id": 1 } ], "tac_contract": { "is_signed": false, "name": "opensign_terms_and_conditions", "signed_at": "2014-07-16 15:22:48", "type": "opensign" }, "tags": [ "VIPCUSTOMER" ], "transaction_fee": { "bank": 0, "credit_card": 3, "ideal": 0, "paypal": 5, "western_union": 0, "yandex": 5 }, "type": "normal" }, "desc": "" } }, "settingsGetSettingsResponseData": { "type": "object", "title": "GetSettingsResponseData", "properties": { "av_handle": { "type": "string", "title": "Account administrative handle" }, "claims_confirm_url": { "type": "string", "title": "Trademark claims confirmation URL" }, "claims_email_subject": { "type": "string", "title": "Trademark claims email subject" }, "claims_reseller_name": { "type": "string", "title": "Trademark claims reseller name" }, "claims_sender_email": { "type": "string", "title": "Trademark claims sender email address" }, "currency": { "type": "string", "title": "The currency" }, "default_domain_billing_handle": { "type": "string", "title": "BIlling handle used by default for domain registrations" }, "default_domain_reseller_handle": { "type": "string", "title": "Reseller handle used by default for domain registrations" }, "foa_confirm_url": { "type": "string", "title": "Form of authorization confirmation URL" }, "foa_email_subject": { "type": "string", "title": "Form of authorization email subject" }, "foa_reseller_name": { "type": "string", "title": "Reseller name to display in form of authorization emails" }, "foa_sender_email": { "type": "string", "title": "Sender email to display in form of authorization emails" }, "foa_terms_conditions_url": { "type": "string", "title": "URL to form of authorization T&Cs to display" }, "is_auto_renew_enabled": { "type": "boolean", "format": "boolean", "title": "Global autorenew setting status" }, "is_custom_nses_enabled": { "type": "boolean", "format": "boolean", "title": "Indicates if custom NS records allowed for reseller's DNS zones" }, "ive2_customized_body": { "type": "string", "title": "Customized subject of email verification reminder messages" }, "ive2_email_subject": { "type": "string", "title": "Customized subject of email verification reminder messages" }, "ive_confirm_url": { "type": "string", "title": "Email verification confirmation URL" }, "ive_customized_body": { "type": "string", "title": "Customized contents of email verification messages" }, "ive_email_subject": { "type": "string", "title": "Customized subject of email verification messages" }, "ive_reseller_name": { "type": "string", "title": "Reseller name to display in email verification messages" }, "ive_sender_email": { "type": "string", "title": "Sender email address to display in email verification messages" }, "jurisdiction": { "type": "string", "title": "Reseller's jurisdiction" }, "language": { "type": "string", "title": "The language" }, "maximum_credit": { "type": "number", "format": "double", "title": "Maximum credit allowed for reseller" }, "maximum_credit_card_payment": { "type": "number", "format": "double", "title": "Maximum amount allowed to be paid using specified payment method" }, "maximum_i_deal_payment": { "type": "number", "format": "double", "title": "Maximum amount allowed to be paid using specified payment method" }, "maximum_western_union_payment": { "type": "number", "format": "double", "title": "Maximum amount allowed to be paid using specified payment method" }, "minimum_payment": { "type": "number", "format": "double", "title": "Minimal payment" }, "minimum_western_union_payment": { "type": "number", "format": "double", "title": "Minimal amount allowed to be paid using specified payment method" }, "pay_methods": { "type": "array", "title": "Payment methods", "items": { "type": "string" } }, "payment_methods": { "type": "array", "title": "Reseller payment methods settings", "items": { "$ref": "#/definitions/settingsPaymentMethods" } }, "preregistered_domain_priorities": { "type": "string", "title": "The preregistered domain priorities" }, "recurring_payment_methods": { "type": "array", "title": "Reseller recurring payment methods settings", "items": { "$ref": "#/definitions/settingsPaymentMethods" } }, "renew_notification_days": { "type": "array", "title": "Days before renewal reminder messages are sent", "items": { "type": "integer", "format": "int32" } }, "renew_notification_every_week": { "type": "boolean", "format": "boolean", "title": "Renew notification every week setting" }, "signed_contracts": { "type": "array", "title": "List of signed contracts", "items": { "$ref": "#/definitions/settingsSignedContracts" } }, "tac_contract": { "title": "Openprovider T&C contract", "$ref": "#/definitions/settingsTacContract" }, "tags": { "type": "array", "title": "Custom tags applied to entity", "items": { "type": "string" } }, "transaction_fee": { "title": "Additional fee per payment", "$ref": "#/definitions/settingsTransactionFee" }, "type": { "type": "string", "title": "The type" } }, "example": { "av_handle": "XX123456-XX", "claims_confirm_url": "http://www.domain.tld/confirm-tm_claims.php?domainId=%%domainId%%&domain=%%domain%%&code=%%authCode%%", "claims_email_subject": "Hi there! You need to accept registration for %%domain%%!", "claims_reseller_name": "Jon Doe's Webhosting!!", "claims_sender_email": "test@mail.tld", "currency": "EUR", "default_domain_billing_handle": "XX123456-XX", "default_domain_reseller_handle": "XX123456-XX", "foa_confirm_url": "", "foa_email_subject": "", "foa_reseller_name": "", "foa_sender_email": "", "foa_terms_conditions_url": "", "is_auto_renew_enabled": false, "is_custom_nses_enabled": false, "ive2_customized_body": "", "ive2_email_subject": "[URGENT REMINDER] Request for e-mail address verification", "ive_confirm_url": "http://icann-verification.registrar.eu/?email=%%email%%&authCode=%%authCode%%", "ive_customized_body": "", "ive_email_subject": "Request for e-mail address verification", "ive_reseller_name": "sdasd", "ive_sender_email": "do-not-reply@registrar.eu", "jurisdiction": "EU", "language": "EN", "maximum_credit": 20000, "maximum_credit_card_payment": 15000, "maximum_i_deal_payment": 1000000, "maximum_western_union_payment": 1000, "minimum_payment": 20, "minimum_western_union_payment": 500, "pay_methods": [ "ideal" ], "payment_methods": [ { "name": "ideal", "settings": { "limit": { "maximum": { "aud": 0, "bgn": 0, "brl": 0, "cad": 0, "chf": 0, "cny": 0, "czk": 0, "dkk": 0, "eek": 0, "eur": 0, "gbp": 0, "ghs": 0, "hkd": 0, "hrk": 0, "huf": 0, "idr": 0, "ils": 0, "inr": 0, "jpy": 0, "krw": 0, "lkr": 0, "ltl": 0, "lvl": 0, "mxn": 0, "myr": 0, "nok": 0, "nzd": 0, "php": 0, "pln": 0, "ron": 0, "rub": 0, "sek": 0, "sgd": 0, "thb": 0, "try": 0, "usd": 0, "zar": 0 }, "minimum": { "aud": 0, "bgn": 0, "brl": 0, "cad": 0, "chf": 0, "cny": 0, "czk": 0, "dkk": 0, "eek": 0, "eur": 0, "gbp": 0, "ghs": 0, "hkd": 0, "hrk": 0, "huf": 0, "idr": 0, "ils": 0, "inr": 0, "jpy": 0, "krw": 0, "lkr": 0, "ltl": 0, "lvl": 0, "mxn": 0, "myr": 0, "nok": 0, "nzd": 0, "php": 0, "pln": 0, "ron": 0, "rub": 0, "sek": 0, "sgd": 0, "thb": 0, "try": 0, "usd": 0, "zar": 0 } }, "transaction_fee": 0, "transaction_fee_absolute": 0 } } ], "preregistered_domain_priorities": "[]", "recurring_payment_methods": [ { "name": "ideal", "settings": { "limit": { "maximum": { "aud": 0, "bgn": 0, "brl": 0, "cad": 0, "chf": 0, "cny": 0, "czk": 0, "dkk": 0, "eek": 0, "eur": 0, "gbp": 0, "ghs": 0, "hkd": 0, "hrk": 0, "huf": 0, "idr": 0, "ils": 0, "inr": 0, "jpy": 0, "krw": 0, "lkr": 0, "ltl": 0, "lvl": 0, "mxn": 0, "myr": 0, "nok": 0, "nzd": 0, "php": 0, "pln": 0, "ron": 0, "rub": 0, "sek": 0, "sgd": 0, "thb": 0, "try": 0, "usd": 0, "zar": 0 }, "minimum": { "aud": 0, "bgn": 0, "brl": 0, "cad": 0, "chf": 0, "cny": 0, "czk": 0, "dkk": 0, "eek": 0, "eur": 0, "gbp": 0, "ghs": 0, "hkd": 0, "hrk": 0, "huf": 0, "idr": 0, "ils": 0, "inr": 0, "jpy": 0, "krw": 0, "lkr": 0, "ltl": 0, "lvl": 0, "mxn": 0, "myr": 0, "nok": 0, "nzd": 0, "php": 0, "pln": 0, "ron": 0, "rub": 0, "sek": 0, "sgd": 0, "thb": 0, "try": 0, "usd": 0, "zar": 0 } }, "transaction_fee": 0, "transaction_fee_absolute": 0 } } ], "renew_notification_days": [ 1 ], "renew_notification_every_week": false, "signed_contracts": [ { "contents": "content for ac", "id": 1, "is_signed": false, "modification_date": "2009-02-19 10:59:32", "sign_on_date": "2009-02-19 10:59:32", "title": ".ac", "type": "ac", "version_id": 1 } ], "tac_contract": { "is_signed": false, "name": "opensign_terms_and_conditions", "signed_at": "2014-07-16 15:22:48", "type": "opensign" }, "tags": [ "VIPCUSTOMER" ], "transaction_fee": { "bank": 0, "credit_card": 3, "ideal": 0, "paypal": 5, "western_union": 0, "yandex": 5 }, "type": "normal" } }, "settingsPaymentMethodLimit": { "type": "object", "title": "PaymentMethodLimit", "properties": { "AUD": { "type": "number", "format": "double", "title": "Currency" }, "BGN": { "type": "number", "format": "double", "title": "Currency" }, "BRL": { "type": "number", "format": "double", "title": "Currency" }, "CAD": { "type": "number", "format": "double", "title": "Currency" }, "CHF": { "type": "number", "format": "double", "title": "Currency" }, "CNY": { "type": "number", "format": "double", "title": "Currency" }, "CZK": { "type": "number", "format": "double", "title": "Currency" }, "DKK": { "type": "number", "format": "double", "title": "Currency" }, "EEK": { "type": "number", "format": "double", "title": "Currency" }, "EUR": { "type": "number", "format": "double", "title": "Currency" }, "GBP": { "type": "number", "format": "double", "title": "Currency" }, "GHS": { "type": "number", "format": "double", "title": "Currency" }, "HKD": { "type": "number", "format": "double", "title": "Currency" }, "HRK": { "type": "number", "format": "double", "title": "Currency" }, "HUF": { "type": "number", "format": "double", "title": "Currency" }, "IDR": { "type": "number", "format": "double", "title": "Currency" }, "ILS": { "type": "number", "format": "double", "title": "Currency" }, "INR": { "type": "number", "format": "double", "title": "Currency" }, "JPY": { "type": "number", "format": "double", "title": "Currency" }, "KRW": { "type": "number", "format": "double", "title": "Currency" }, "LKR": { "type": "number", "format": "double", "title": "Currency" }, "LTL": { "type": "number", "format": "double", "title": "Currency" }, "LVL": { "type": "number", "format": "double", "title": "Currency" }, "MXN": { "type": "number", "format": "double", "title": "Currency" }, "MYR": { "type": "number", "format": "double", "title": "Currency" }, "NOK": { "type": "number", "format": "double", "title": "Currency" }, "NZD": { "type": "number", "format": "double", "title": "Currency" }, "PHP": { "type": "number", "format": "double", "title": "Currency" }, "PLN": { "type": "number", "format": "double", "title": "Currency" }, "RON": { "type": "number", "format": "double", "title": "Currency" }, "RUB": { "type": "number", "format": "double", "title": "Currency" }, "SEK": { "type": "number", "format": "double", "title": "Currency" }, "SGD": { "type": "number", "format": "double", "title": "Currency" }, "THB": { "type": "number", "format": "double", "title": "Currency" }, "TRY": { "type": "number", "format": "double", "title": "Currency" }, "USD": { "type": "number", "format": "double", "title": "Currency" }, "ZAR": { "type": "number", "format": "double", "title": "Currency" } }, "example": { "aud": 0, "bgn": 0, "brl": 0, "cad": 0, "chf": 0, "cny": 0, "czk": 0, "dkk": 0, "eek": 0, "eur": 0, "gbp": 0, "ghs": 0, "hkd": 0, "hrk": 0, "huf": 0, "idr": 0, "ils": 0, "inr": 0, "jpy": 0, "krw": 0, "lkr": 0, "ltl": 0, "lvl": 0, "mxn": 0, "myr": 0, "nok": 0, "nzd": 0, "php": 0, "pln": 0, "ron": 0, "rub": 0, "sek": 0, "sgd": 0, "thb": 0, "try": 0, "usd": 0, "zar": 0 } }, "settingsPaymentMethodLimits": { "type": "object", "title": "PaymentMethodLimits", "properties": { "maximum": { "title": "Maximal payment", "$ref": "#/definitions/settingsPaymentMethodLimit" }, "minimum": { "title": "Minimal payment", "$ref": "#/definitions/settingsPaymentMethodLimit" } }, "example": { "maximum": { "aud": 0, "bgn": 0, "brl": 0, "cad": 0, "chf": 0, "cny": 0, "czk": 0, "dkk": 0, "eek": 0, "eur": 0, "gbp": 0, "ghs": 0, "hkd": 0, "hrk": 0, "huf": 0, "idr": 0, "ils": 0, "inr": 0, "jpy": 0, "krw": 0, "lkr": 0, "ltl": 0, "lvl": 0, "mxn": 0, "myr": 0, "nok": 0, "nzd": 0, "php": 0, "pln": 0, "ron": 0, "rub": 0, "sek": 0, "sgd": 0, "thb": 0, "try": 0, "usd": 0, "zar": 0 }, "minimum": { "aud": 0, "bgn": 0, "brl": 0, "cad": 0, "chf": 0, "cny": 0, "czk": 0, "dkk": 0, "eek": 0, "eur": 0, "gbp": 0, "ghs": 0, "hkd": 0, "hrk": 0, "huf": 0, "idr": 0, "ils": 0, "inr": 0, "jpy": 0, "krw": 0, "lkr": 0, "ltl": 0, "lvl": 0, "mxn": 0, "myr": 0, "nok": 0, "nzd": 0, "php": 0, "pln": 0, "ron": 0, "rub": 0, "sek": 0, "sgd": 0, "thb": 0, "try": 0, "usd": 0, "zar": 0 } } }, "settingsPaymentMethodSettings": { "type": "object", "title": "PaymentMethodSettings", "properties": { "limit": { "title": "Payment limits", "$ref": "#/definitions/settingsPaymentMethodLimits" }, "transaction_fee": { "type": "number", "format": "double", "title": "Additional percentage fee per payment" }, "transaction_fee_absolute": { "type": "number", "format": "double", "title": "Additional absolute fee per payment" } }, "example": { "limit": { "maximum": { "aud": 0, "bgn": 0, "brl": 0, "cad": 0, "chf": 0, "cny": 0, "czk": 0, "dkk": 0, "eek": 0, "eur": 0, "gbp": 0, "ghs": 0, "hkd": 0, "hrk": 0, "huf": 0, "idr": 0, "ils": 0, "inr": 0, "jpy": 0, "krw": 0, "lkr": 0, "ltl": 0, "lvl": 0, "mxn": 0, "myr": 0, "nok": 0, "nzd": 0, "php": 0, "pln": 0, "ron": 0, "rub": 0, "sek": 0, "sgd": 0, "thb": 0, "try": 0, "usd": 0, "zar": 0 }, "minimum": { "aud": 0, "bgn": 0, "brl": 0, "cad": 0, "chf": 0, "cny": 0, "czk": 0, "dkk": 0, "eek": 0, "eur": 0, "gbp": 0, "ghs": 0, "hkd": 0, "hrk": 0, "huf": 0, "idr": 0, "ils": 0, "inr": 0, "jpy": 0, "krw": 0, "lkr": 0, "ltl": 0, "lvl": 0, "mxn": 0, "myr": 0, "nok": 0, "nzd": 0, "php": 0, "pln": 0, "ron": 0, "rub": 0, "sek": 0, "sgd": 0, "thb": 0, "try": 0, "usd": 0, "zar": 0 } }, "transaction_fee": 0, "transaction_fee_absolute": 0 } }, "settingsPaymentMethods": { "type": "object", "title": "PaymentMethods", "properties": { "name": { "type": "string", "title": "Payment method name" }, "settings": { "title": "Payment method settings", "$ref": "#/definitions/settingsPaymentMethodSettings" } }, "example": { "name": "ideal", "settings": { "limit": { "maximum": { "aud": 0, "bgn": 0, "brl": 0, "cad": 0, "chf": 0, "cny": 0, "czk": 0, "dkk": 0, "eek": 0, "eur": 0, "gbp": 0, "ghs": 0, "hkd": 0, "hrk": 0, "huf": 0, "idr": 0, "ils": 0, "inr": 0, "jpy": 0, "krw": 0, "lkr": 0, "ltl": 0, "lvl": 0, "mxn": 0, "myr": 0, "nok": 0, "nzd": 0, "php": 0, "pln": 0, "ron": 0, "rub": 0, "sek": 0, "sgd": 0, "thb": 0, "try": 0, "usd": 0, "zar": 0 }, "minimum": { "aud": 0, "bgn": 0, "brl": 0, "cad": 0, "chf": 0, "cny": 0, "czk": 0, "dkk": 0, "eek": 0, "eur": 0, "gbp": 0, "ghs": 0, "hkd": 0, "hrk": 0, "huf": 0, "idr": 0, "ils": 0, "inr": 0, "jpy": 0, "krw": 0, "lkr": 0, "ltl": 0, "lvl": 0, "mxn": 0, "myr": 0, "nok": 0, "nzd": 0, "php": 0, "pln": 0, "ron": 0, "rub": 0, "sek": 0, "sgd": 0, "thb": 0, "try": 0, "usd": 0, "zar": 0 } }, "transaction_fee": 0, "transaction_fee_absolute": 0 } } }, "settingsSignedContracts": { "type": "object", "title": "SignedContracts", "properties": { "contents": { "type": "string", "title": "Contract contents" }, "id": { "type": "integer", "format": "int32", "title": "Object ID" }, "is_signed": { "type": "boolean", "format": "boolean", "title": "Indicates if contract is signed" }, "modification_date": { "type": "string", "title": "The modification date" }, "sign_on_date": { "type": "string", "title": "Contract signing date" }, "title": { "type": "string", "title": "The title" }, "type": { "type": "string", "title": "The type" }, "version_id": { "type": "integer", "format": "int32", "title": "Contract version ID" } }, "example": { "contents": "content for ac", "id": 1, "is_signed": false, "modification_date": "2009-02-19 10:59:32", "sign_on_date": "2009-02-19 10:59:32", "title": ".ac", "type": "ac", "version_id": 1 } }, "settingsTacContract": { "type": "object", "title": "TacContract", "properties": { "is_signed": { "type": "boolean", "format": "boolean", "title": "Indicates if contract is signed" }, "name": { "type": "string", "title": "The name" }, "signed_at": { "type": "string", "title": "Contract signing date" }, "type": { "type": "string", "title": "The type" } }, "example": { "is_signed": false, "name": "opensign_terms_and_conditions", "signed_at": "2014-07-16 15:22:48", "type": "opensign" } }, "settingsTransactionFee": { "type": "object", "title": "TransactionFee", "properties": { "bank": { "type": "number", "format": "double", "title": "Payment method" }, "credit_card": { "type": "number", "format": "double", "title": "Payment method" }, "ideal": { "type": "number", "format": "double", "title": "Payment method" }, "paypal": { "type": "number", "format": "double", "title": "Payment method" }, "western_union": { "type": "number", "format": "double", "title": "Payment method" }, "yandex": { "type": "number", "format": "double", "title": "Payment method" } }, "example": { "bank": 0, "credit_card": 3, "ideal": 0, "paypal": 5, "western_union": 0, "yandex": 5 } }, "spam_expertGenerateLoginURLRequest": { "type": "object", "title": "GenerateLoginURLRequest", "properties": { "bundle": { "description": "If you use the new, individually purchased, filters then set this to false. If you use the old bundled variant, then set this to true.", "type": "boolean", "format": "boolean" }, "domain_or_email": { "type": "string", "title": "Domain or email connected with the spam filter" } }, "example": { "bundle": false, "domain_or_email": "example.com" } }, "spam_expertGenerateLoginURLResponse": { "type": "object", "title": "GenerateLoginURLResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/spam_expertGenerateLoginURLResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "url": "http://spamexperts.example.com//?authticket=fdsaffdkaj3432fjkfjdslkjflk345435433fdfe" }, "desc": "" } }, "spam_expertGenerateLoginURLResponseData": { "type": "object", "title": "GenerateLoginURLResponseData", "properties": { "url": { "type": "string", "title": "An url that can be used for logging in to the SpamExperts control panel. If you want you can whitelabel the hostname by taking the auth at the end of the URL and replacing the part in front of it by your own URL, as long as it leads to our platform via DNS" } }, "example": { "url": "http://spamexperts.example.com//?authticket=fdsaffdkaj3432fjkfjdslkjflk345435433fdfe" } }, "statisticsCurrencyStatistics": { "type": "object", "title": "CurrencyStatistics", "properties": { "modified": { "type": "string", "title": "The modified" } }, "example": { "modified": "2010-08-01 9:30:54" } }, "statisticsCustomerStatistics": { "type": "object", "title": "CustomerStatistics", "properties": { "modified": { "type": "string", "title": "The modified" }, "total": { "type": "integer", "format": "int32", "title": "Total number of entities matching search criteria" } }, "example": { "modified": "2019-05-03 13:23:01", "total": 999 } }, "statisticsDnsStatistics": { "type": "object", "title": "DnsStatistics", "properties": { "total": { "type": "integer", "format": "int32", "title": "Total number of entities matching search criteria" } }, "example": { "total": 999 } }, "statisticsDomainStatistics": { "type": "object", "title": "DomainStatistics", "properties": { "by_status": { "title": "Sort output by status", "$ref": "#/definitions/statisticsDomainStatisticsByStatus" }, "total": { "type": "integer", "format": "int32", "title": "Total number of entities matching search criteria" } }, "example": { "by_status": { "act": 7, "fai": 419, "nsr": 0, "pen": 0, "rej": 5, "req": 15 }, "total": 999 } }, "statisticsDomainStatisticsByStatus": { "type": "object", "title": "DomainStatisticsByStatus", "properties": { "ACT": { "type": "integer", "format": "int32", "title": "Active domains count" }, "FAI": { "type": "integer", "format": "int32", "title": "Fax number" }, "NSR": { "type": "integer", "format": "int32", "title": "The nsr" }, "PEN": { "type": "integer", "format": "int32", "title": "Pending status" }, "REJ": { "type": "integer", "format": "int32", "title": "Rejected status" }, "REQ": { "type": "integer", "format": "int32", "title": "Requested status" } }, "example": { "act": 7, "fai": 419, "nsr": 0, "pen": 0, "rej": 5, "req": 15 } }, "statisticsGetStatisticsResponse": { "type": "object", "title": "GetStatisticsResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/statisticsGetStatisticsResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "currency": { "modified": "2010-08-01 9:30:54" }, "customer": { "modified": "2019-05-03 13:23:01", "total": 999 }, "dns": { "total": 999 }, "domain": { "by_status": { "act": 7, "fai": 419, "nsr": 0, "pen": 0, "rej": 5, "req": 15 }, "total": 999 }, "license": { "total": 999 }, "spam_experts": { "activated_at": "2012-10-29 10:48:30", "created_at": "2012-10-29 10:48:30", "exists": false, "expired_at": "2016-04-05 8:50:34", "incoming_count": 0, "incoming_limit": 10, "outgoing_count": 0, "outgoing_limit": 1, "status": "deleted", "with_outgoing_filter": false }, "ssl": { "by_status": { "act": 7, "fai": 419, "nsr": 0, "pen": 0, "rej": 5, "req": 15 }, "total": 999 } }, "desc": "" } }, "statisticsGetStatisticsResponseData": { "type": "object", "title": "GetStatisticsResponseData", "properties": { "currency": { "title": "The currency", "$ref": "#/definitions/statisticsCurrencyStatistics" }, "customer": { "title": "The customer", "$ref": "#/definitions/statisticsCustomerStatistics" }, "dns": { "title": "Total count of DNS zones", "$ref": "#/definitions/statisticsDnsStatistics" }, "domain": { "title": "Total count of domains", "$ref": "#/definitions/statisticsDomainStatistics" }, "license": { "title": "Statistics for Plesk / Virtuozzo licenses", "$ref": "#/definitions/statisticsLicenseStatistics" }, "spam_experts": { "title": "Statistics for Spamexperts bundles", "$ref": "#/definitions/statisticsSpamExpertsStatistics" }, "ssl": { "title": "Statistics for SSL", "$ref": "#/definitions/statisticsSslStatistics" } }, "example": { "currency": { "modified": "2010-08-01 9:30:54" }, "customer": { "modified": "2019-05-03 13:23:01", "total": 999 }, "dns": { "total": 999 }, "domain": { "by_status": { "act": 7, "fai": 419, "nsr": 0, "pen": 0, "rej": 5, "req": 15 }, "total": 999 }, "license": { "total": 999 }, "spam_experts": { "activated_at": "2012-10-29 10:48:30", "created_at": "2012-10-29 10:48:30", "exists": false, "expired_at": "2016-04-05 8:50:34", "incoming_count": 0, "incoming_limit": 10, "outgoing_count": 0, "outgoing_limit": 1, "status": "deleted", "with_outgoing_filter": false }, "ssl": { "by_status": { "act": 7, "fai": 419, "nsr": 0, "pen": 0, "rej": 5, "req": 15 }, "total": 999 } } }, "statisticsLicenseStatistics": { "type": "object", "title": "LicenseStatistics", "properties": { "total": { "type": "integer", "format": "int32", "title": "Total number of entities matching search criteria" } }, "example": { "total": 999 } }, "statisticsSpamExpertsStatistics": { "type": "object", "title": "SpamExpertsStatistics", "properties": { "activated_at": { "type": "string", "title": "Spamexperts bundle activation date" }, "created_at": { "type": "string", "title": "Date of Spamexperts bundle creation" }, "exists": { "type": "boolean", "format": "boolean", "title": "Indicates if Spamexperts bundle exists" }, "expired_at": { "type": "string", "title": "Date of Spamexperts bundle expiration" }, "incoming_count": { "type": "integer", "format": "int32", "title": "Incoming filters count" }, "incoming_limit": { "type": "integer", "format": "int32", "title": "Incoming filters limit" }, "outgoing_count": { "type": "integer", "format": "int32", "title": "Outgoing filters count" }, "outgoing_limit": { "type": "integer", "format": "int32", "title": "Outgoing filters limit" }, "status": { "type": "string", "title": "The status" }, "with_outgoing_filter": { "type": "boolean", "format": "boolean", "title": "Indicates if Spamexperts bundle supports outgoing filtering" } }, "example": { "activated_at": "2012-10-29 10:48:30", "created_at": "2012-10-29 10:48:30", "exists": false, "expired_at": "2016-04-05 8:50:34", "incoming_count": 0, "incoming_limit": 10, "outgoing_count": 0, "outgoing_limit": 1, "status": "deleted", "with_outgoing_filter": false } }, "statisticsSslStatistics": { "type": "object", "title": "SslStatistics", "properties": { "by_status": { "title": "Sort output by status", "$ref": "#/definitions/statisticsSslStatisticsByStatus" }, "total": { "type": "integer", "format": "int32", "title": "Total number of entities matching search criteria" } }, "example": { "by_status": { "act": 7, "fai": 419, "nsr": 0, "pen": 0, "rej": 5, "req": 15 }, "total": 999 } }, "statisticsSslStatisticsByStatus": { "type": "object", "title": "SslStatisticsByStatus", "properties": { "ACT": { "type": "integer", "format": "int32", "title": "Active SSL certificates count" }, "FAI": { "type": "integer", "format": "int32", "title": "Fax number" }, "NSR": { "type": "integer", "format": "int32", "title": "The nsr" }, "PEN": { "type": "integer", "format": "int32", "title": "Pending status" }, "REJ": { "type": "integer", "format": "int32", "title": "Rejected status" }, "REQ": { "type": "integer", "format": "int32", "title": "Requested status" } }, "example": { "act": 7, "fai": 419, "nsr": 0, "pen": 0, "rej": 5, "req": 15 } }, "tagCreateTagResponse": { "type": "object", "title": "CreateTagResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/tagCreateTagResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates, if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "success": false }, "desc": "" } }, "tagCreateTagResponseData": { "type": "object", "title": "CreateTagResponseData", "properties": { "success": { "type": "boolean", "format": "boolean", "title": "Indicates, if operation is successful" } }, "example": { "success": false } }, "tagDeleteTagResponse": { "type": "object", "title": "DeleteTagResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/tagDeleteTagResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates, if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "success": false }, "desc": "" } }, "tagDeleteTagResponseData": { "type": "object", "title": "DeleteTagResponseData", "properties": { "success": { "type": "boolean", "format": "boolean", "title": "Indicates, if operation is successful" } }, "example": { "success": false } }, "tagListTagsResponse": { "type": "object", "title": "ListTagsResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/tagListTagsResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates, if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "results": [ { "key": "customer", "value": "example" } ], "total": 999 }, "desc": "" } }, "tagListTagsResponseData": { "type": "object", "title": "ListTagsResponseData", "properties": { "results": { "type": "array", "title": "Array of results", "items": { "$ref": "#/definitions/helperstagTag" } }, "total": { "type": "integer", "format": "int32", "title": "Results count" } }, "example": { "results": [ { "key": "customer", "value": "example" } ], "total": 999 } }, "templateCreateTemplateRequest": { "type": "object", "title": "CreateTemplateRequest", "properties": { "is_spamexperts_enabled": { "type": "boolean", "format": "boolean", "title": "Idicates if spamfiltering is enabled for the DNS zone" }, "name": { "type": "string", "title": "The name" }, "records": { "type": "array", "title": "The records", "items": { "$ref": "#/definitions/templateRecord" } } }, "example": { "is_spamexperts_enabled": false, "name": "MyTemplate", "records": [ { "id": 67377, "name": "ns1.domain.com", "prio": 10, "ttl": 86400, "type": "MX", "value": "abc.example.com" } ] } }, "templateCreateTemplateResponse": { "type": "object", "title": "CreateTemplateResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "The data", "$ref": "#/definitions/templateCreateTemplateResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "The warnings", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "id": 39238 }, "desc": "" } }, "templateCreateTemplateResponseData": { "type": "object", "title": "CreateTemplateResponseData", "properties": { "id": { "type": "integer", "format": "int32", "title": "Template ID" } }, "example": { "id": 39238 } }, "templateGetTemplateResponse": { "type": "object", "title": "GetTemplateResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "The data", "$ref": "#/definitions/templateTemplate" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "The warnings", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "id": 1, "is_spamexperts_enabled": false, "name": "MyTemplate", "records": [ { "id": 67377, "name": "ns1.domain.com", "prio": 10, "ttl": 86400, "type": "MX", "value": "abc.example.com" } ] }, "desc": "" } }, "templateListTemplatesResponse": { "type": "object", "title": "ListTemplatesResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "The data", "$ref": "#/definitions/templateListTemplatesResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "The warnings", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "results": [ { "id": 1, "is_spamexperts_enabled": false, "name": "MyTemplate", "records": [ { "id": 67377, "name": "ns1.domain.com", "prio": 10, "ttl": 86400, "type": "MX", "value": "abc.example.com" } ] } ], "total": 20 }, "desc": "" } }, "templateListTemplatesResponseData": { "type": "object", "title": "ListTemplatesResponseData", "properties": { "results": { "type": "array", "title": "Array of results", "items": { "$ref": "#/definitions/templateTemplate" } }, "total": { "type": "integer", "format": "int32", "title": "Results count" } }, "example": { "results": [ { "id": 1, "is_spamexperts_enabled": false, "name": "MyTemplate", "records": [ { "id": 67377, "name": "ns1.domain.com", "prio": 10, "ttl": 86400, "type": "MX", "value": "abc.example.com" } ] } ], "total": 20 } }, "templateRecord": { "type": "object", "title": "Record", "properties": { "id": { "type": "integer", "format": "int32", "title": "DNS record ID" }, "name": { "type": "string", "title": "DNS record name" }, "prio": { "type": "integer", "format": "int32", "title": "DNS record priority" }, "ttl": { "type": "integer", "format": "int32", "title": "DNS record TTL" }, "type": { "type": "string", "title": "DNS record tyoe" }, "value": { "type": "string", "title": "DNS record value" } }, "example": { "id": 67377, "name": "ns1.domain.com", "prio": 10, "ttl": 86400, "type": "MX", "value": "abc.example.com" } }, "templateTemplate": { "type": "object", "title": "Template", "properties": { "id": { "type": "integer", "format": "int32", "title": "Template ID" }, "is_spamexperts_enabled": { "type": "boolean", "format": "boolean", "title": "Indicates if spam filtering is enabled for the DNS zone" }, "name": { "type": "string", "title": "Template name" }, "records": { "type": "array", "title": "Array of DNS zone records", "items": { "$ref": "#/definitions/templateRecord" } } }, "example": { "id": 1, "is_spamexperts_enabled": false, "name": "MyTemplate", "records": [ { "id": 67377, "name": "ns1.domain.com", "prio": 10, "ttl": 86400, "type": "MX", "value": "abc.example.com" } ] } }, "templateTemplateBoolResponse": { "type": "object", "title": "TemplateBoolResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "The data", "$ref": "#/definitions/templateTemplateBoolResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "The warnings", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "success": false }, "desc": "" } }, "templateTemplateBoolResponseData": { "type": "object", "title": "TemplateBoolResponseData", "properties": { "success": { "type": "boolean", "format": "boolean", "title": "Indicates if request was successful" } }, "example": { "success": false } }, "tldApplicationMode": { "type": "object", "title": "ApplicationMode", "properties": { "name": { "type": "string", "title": "Application mode name" }, "title": { "type": "string", "title": "Pre-registration mode title" } }, "example": { "name": "claims", "title": "General Availability" } }, "tldDescription": { "type": "object", "title": "Description", "properties": { "text": { "type": "string", "title": "Description text" }, "url": { "type": "string", "title": "Url" } }, "example": { "text": "

La extensión de nombre de dominio .BIZ es el dominio de primer nivel orientado al sector de los negocios. La extensión de dominio .BIZ es utilizada por empresas que desean una única presencia en Internet. La extensión .BIZ ha sido desarrollada para promocionar la nueva generación de comercio electrónico, y de aplicaciones Internet.

", "url": "http://www.neustarregistry.biz" } }, "tldGetTldResponse": { "type": "object", "title": "GetTldResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/tldTld" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates, if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "admin_handle_supported": false, "billing_handle_enabled": false, "billing_handle_supported": false, "description": { "text": "

La extensión de nombre de dominio .BIZ es el dominio de primer nivel orientado al sector de los negocios. La extensión de dominio .BIZ es utilizada por empresas que desean una única presencia en Internet. La extensión .BIZ ha sido desarrollada para promocionar la nueva generación de comercio electrónico, y de aplicaciones Internet.

", "url": "http://www.neustarregistry.biz" }, "dnssec_algorithms": [ 3 ], "dnssec_allowed": false, "dnssec_digests_allowed": false, "dnssec_keys_allowed": false, "dnssec_max_records_amount": 0, "domicile_available": false, "is_auth_code_available": false, "is_auth_code_changeable": false, "is_auth_code_requested": false, "is_private_whois_allowed": false, "is_trade_auth_code_required": true, "is_transfer_auth_code_required": true, "level_prices": [ { "level": 1, "price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } } } ], "max_period": 10, "min_period": 1, "name": "eu", "owner_handle_supported": false, "prices": { "create_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "domicile_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "max_period": 10, "min_period": 1, "renew_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "reseller_price": { "product": { "currency": "USD", "price": 226 }, "promotion_details": { "end_date": "1589932800", "non_promo_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "start_date": "1582156800" }, "reseller": { "currency": "USD", "price": 226 } }, "restore_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "setup_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "soft_restore_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "trade_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "transfer_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "update_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } } }, "quarantine_period": 38, "renew_available": false, "reseller_handle_enabled": false, "reseller_handle_supported": false, "restrictions": [ "Los dominios premium (cortos y nombres gen\u00e9ricos) son m\u00e1s caros para registros y renovaciones" ], "soft_quarantine_period": 44, "status": "ACT", "supported_application_mode": [ { "name": "claims", "title": "General Availability" } ], "supported_idn_scripts": [ { "description": "Afrikaans", "value": "AFR" } ], "tech_handle_supported": false, "trade_available": false, "transfer_available": false, "usage_count": 0 }, "desc": "" } }, "tldIdnScript": { "type": "object", "title": "IdnScript", "properties": { "description": { "type": "string", "title": "IDN script description" }, "value": { "type": "string", "title": "IDN script parameter value" } }, "example": { "description": "Afrikaans", "value": "AFR" } }, "tldLevelPrice": { "type": "object", "title": "LevelPrice", "properties": { "level": { "type": "integer", "format": "int32", "title": "Openprovider discount tier" }, "price": { "title": "Tiered price", "$ref": "#/definitions/tldPrice" } }, "example": { "level": 1, "price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } } } }, "tldListTldsResponse": { "type": "object", "title": "ListTldsResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/tldListTldsResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates, if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "results": [ { "admin_handle_supported": false, "billing_handle_enabled": false, "billing_handle_supported": false, "description": { "text": "

La extensión de nombre de dominio .BIZ es el dominio de primer nivel orientado al sector de los negocios. La extensión de dominio .BIZ es utilizada por empresas que desean una única presencia en Internet. La extensión .BIZ ha sido desarrollada para promocionar la nueva generación de comercio electrónico, y de aplicaciones Internet.

", "url": "http://www.neustarregistry.biz" }, "dnssec_algorithms": [ 3 ], "dnssec_allowed": false, "dnssec_digests_allowed": false, "dnssec_keys_allowed": false, "dnssec_max_records_amount": 0, "domicile_available": false, "is_auth_code_available": false, "is_auth_code_changeable": false, "is_auth_code_requested": false, "is_private_whois_allowed": false, "is_trade_auth_code_required": true, "is_transfer_auth_code_required": true, "level_prices": [ { "level": 1, "price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } } } ], "max_period": 10, "min_period": 1, "name": "eu", "owner_handle_supported": false, "prices": { "create_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "domicile_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "max_period": 10, "min_period": 1, "renew_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "reseller_price": { "product": { "currency": "USD", "price": 226 }, "promotion_details": { "end_date": "1589932800", "non_promo_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "start_date": "1582156800" }, "reseller": { "currency": "USD", "price": 226 } }, "restore_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "setup_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "soft_restore_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "trade_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "transfer_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "update_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } } }, "quarantine_period": 38, "renew_available": false, "reseller_handle_enabled": false, "reseller_handle_supported": false, "restrictions": [ "Los dominios premium (cortos y nombres gen\u00e9ricos) son m\u00e1s caros para registros y renovaciones" ], "soft_quarantine_period": 44, "status": "ACT", "supported_application_mode": [ { "name": "claims", "title": "General Availability" } ], "supported_idn_scripts": [ { "description": "Afrikaans", "value": "AFR" } ], "tech_handle_supported": false, "trade_available": false, "transfer_available": false, "usage_count": 0 } ], "total": 999 }, "desc": "" } }, "tldListTldsResponseData": { "type": "object", "title": "ListTldsResponseData", "properties": { "results": { "type": "array", "title": "Array of results", "items": { "$ref": "#/definitions/tldTld" } }, "total": { "type": "integer", "format": "int32", "title": "Results count" } }, "example": { "results": [ { "admin_handle_supported": false, "billing_handle_enabled": false, "billing_handle_supported": false, "description": { "text": "

La extensión de nombre de dominio .BIZ es el dominio de primer nivel orientado al sector de los negocios. La extensión de dominio .BIZ es utilizada por empresas que desean una única presencia en Internet. La extensión .BIZ ha sido desarrollada para promocionar la nueva generación de comercio electrónico, y de aplicaciones Internet.

", "url": "http://www.neustarregistry.biz" }, "dnssec_algorithms": [ 3 ], "dnssec_allowed": false, "dnssec_digests_allowed": false, "dnssec_keys_allowed": false, "dnssec_max_records_amount": 0, "domicile_available": false, "is_auth_code_available": false, "is_auth_code_changeable": false, "is_auth_code_requested": false, "is_private_whois_allowed": false, "is_trade_auth_code_required": true, "is_transfer_auth_code_required": true, "level_prices": [ { "level": 1, "price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } } } ], "max_period": 10, "min_period": 1, "name": "eu", "owner_handle_supported": false, "prices": { "create_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "domicile_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "max_period": 10, "min_period": 1, "renew_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "reseller_price": { "product": { "currency": "USD", "price": 226 }, "promotion_details": { "end_date": "1589932800", "non_promo_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "start_date": "1582156800" }, "reseller": { "currency": "USD", "price": 226 } }, "restore_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "setup_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "soft_restore_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "trade_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "transfer_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "update_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } } }, "quarantine_period": 38, "renew_available": false, "reseller_handle_enabled": false, "reseller_handle_supported": false, "restrictions": [ "Los dominios premium (cortos y nombres gen\u00e9ricos) son m\u00e1s caros para registros y renovaciones" ], "soft_quarantine_period": 44, "status": "ACT", "supported_application_mode": [ { "name": "claims", "title": "General Availability" } ], "supported_idn_scripts": [ { "description": "Afrikaans", "value": "AFR" } ], "tech_handle_supported": false, "trade_available": false, "transfer_available": false, "usage_count": 0 } ], "total": 999 } }, "tldPrice": { "type": "object", "title": "Price", "properties": { "product": { "title": "Price in product currency", "$ref": "#/definitions/tldPriceInCurrency" }, "reseller": { "title": "Price in reseller's currency", "$ref": "#/definitions/tldPriceInCurrency" } }, "example": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } } }, "tldPriceInCurrency": { "type": "object", "title": "PriceInCurrency", "properties": { "currency": { "type": "string", "title": "Price currency" }, "price": { "type": "number", "format": "double", "title": "Price in specified currency" } }, "example": { "currency": "USD", "price": 226 } }, "tldPriceWithPromoInfo": { "type": "object", "title": "PriceWithPromoInfo", "properties": { "product": { "title": "Price in product currency", "$ref": "#/definitions/tldPriceInCurrency" }, "promotion_details": { "title": "Additional info about current promotion", "$ref": "#/definitions/tldPromoDetails" }, "reseller": { "title": "Price in reseller's currency", "$ref": "#/definitions/tldPriceInCurrency" } }, "example": { "product": { "currency": "USD", "price": 226 }, "promotion_details": { "end_date": "1589932800", "non_promo_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "start_date": "1582156800" }, "reseller": { "currency": "USD", "price": 226 } } }, "tldPrices": { "type": "object", "title": "Prices", "properties": { "create_price": { "title": "Domain registration price", "$ref": "#/definitions/tldPrice" }, "domicile_price": { "title": "Local presence service (domicile) price", "$ref": "#/definitions/tldPrice" }, "max_period": { "type": "integer", "format": "int32", "title": "Maximal operation period" }, "min_period": { "type": "integer", "format": "int32", "title": "Minimal operation period" }, "renew_price": { "title": "Domain renewal price", "$ref": "#/definitions/tldPrice" }, "reseller_price": { "title": "Reseller's price with personal discounts or promo", "$ref": "#/definitions/tldPriceWithPromoInfo" }, "restore_price": { "title": "Domain restoration price", "$ref": "#/definitions/tldPrice" }, "setup_price": { "title": "Domain setup price", "$ref": "#/definitions/tldPrice" }, "soft_restore_price": { "title": "Price of domain restoration during soft quarantine or grace period", "$ref": "#/definitions/tldPrice" }, "trade_price": { "title": "Domain trade price", "$ref": "#/definitions/tldPrice" }, "transfer_price": { "title": "Domain transfer price", "$ref": "#/definitions/tldPrice" }, "update_price": { "title": "Domain update price", "$ref": "#/definitions/tldPrice" } }, "example": { "create_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "domicile_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "max_period": 10, "min_period": 1, "renew_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "reseller_price": { "product": { "currency": "USD", "price": 226 }, "promotion_details": { "end_date": "1589932800", "non_promo_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "start_date": "1582156800" }, "reseller": { "currency": "USD", "price": 226 } }, "restore_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "setup_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "soft_restore_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "trade_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "transfer_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "update_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } } } }, "tldPromoDetails": { "type": "object", "title": "PromoDetails", "properties": { "end_date": { "type": "string", "title": "Date when promotion is end" }, "non_promo_price": { "title": "Domain regular price without promotions", "$ref": "#/definitions/tldPrice" }, "start_date": { "type": "string", "title": "Date when promotion is start" } }, "example": { "end_date": "1589932800", "non_promo_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "start_date": "1582156800" } }, "tldTld": { "type": "object", "title": "Tld", "properties": { "admin_handle_supported": { "type": "boolean", "format": "boolean", "title": "Indicates, if administrative domain handle is supported in specified extension" }, "billing_handle_enabled": { "type": "boolean", "format": "boolean", "title": "Indicates, if billing domain handle is supported in specified extension" }, "billing_handle_supported": { "type": "boolean", "format": "boolean", "title": "Indicates, if billing domain handle is supported in specified extension" }, "description": { "title": "Extension description", "$ref": "#/definitions/tldDescription" }, "dnssec_algorithms": { "type": "array", "title": "List of supported DNSSEC algorithms", "items": { "type": "integer", "format": "int32" } }, "dnssec_allowed": { "type": "boolean", "format": "boolean", "title": "Indicates, if DNSSEC is supported by entension" }, "dnssec_digests_allowed": { "type": "boolean", "format": "boolean", "title": "Indicates, if DNSSEC digests are supported by entension" }, "dnssec_keys_allowed": { "type": "boolean", "format": "boolean", "title": "Indicates, if DNSSEC keys are supported by entension" }, "dnssec_max_records_amount": { "type": "integer", "format": "int32", "title": "Indicates, how many DNSSEC records are allowed for the extension" }, "domicile_available": { "type": "boolean", "format": "boolean", "title": "Indicates, if local presence service (domicile) is available for the extension" }, "is_auth_code_available": { "type": "boolean", "format": "boolean", "title": "Indicates, if authcodes are supported by extension" }, "is_auth_code_changeable": { "type": "boolean", "format": "boolean", "title": "Indicates, if authcode can be changed" }, "is_auth_code_requested": { "type": "boolean", "format": "boolean", "title": "Indicates, if authcode can be requested" }, "is_private_whois_allowed": { "type": "boolean", "format": "boolean", "title": "Indicates, if whois privacy protection service is available for the extension" }, "is_trade_auth_code_required": { "type": "boolean", "format": "boolean", "title": "Indicates, if authcode is required for domain trade operation" }, "is_transfer_auth_code_required": { "type": "boolean", "format": "boolean", "title": "Indicates, if authcode is required for domain transfer operation" }, "level_prices": { "type": "array", "title": "List of prices by discount tier", "items": { "$ref": "#/definitions/tldLevelPrice" } }, "max_period": { "type": "integer", "format": "int32", "title": "Maximal operation period" }, "min_period": { "type": "integer", "format": "int32", "title": "Minimal operation period" }, "name": { "type": "string", "title": "Extension name" }, "owner_handle_supported": { "type": "boolean", "format": "boolean", "title": "Indicates, if domain owner handle is supported in specified extension" }, "prices": { "title": "Array of prices", "$ref": "#/definitions/tldPrices" }, "quarantine_period": { "type": "integer", "format": "int32", "title": "Extension hard quarantine period" }, "renew_available": { "type": "boolean", "format": "boolean", "title": "Indicates, if domain renew is supported by extension" }, "reseller_handle_enabled": { "type": "boolean", "format": "boolean", "title": "Indicates, if domain reseller handle is supported in specified extension" }, "reseller_handle_supported": { "type": "boolean", "format": "boolean", "title": "Indicates, if domain reseller handle is supported in specified extension" }, "restrictions": { "type": "array", "title": "Extension restrictions", "items": { "type": "string" } }, "soft_quarantine_period": { "type": "integer", "format": "int32", "title": "Extension soft quarantine period" }, "status": { "type": "string", "title": "Extension status" }, "supported_application_mode": { "type": "array", "title": "List of supported pre-regitration modes", "items": { "$ref": "#/definitions/tldApplicationMode" } }, "supported_idn_scripts": { "type": "array", "title": "List of supported IDN scripts", "items": { "$ref": "#/definitions/tldIdnScript" } }, "tech_handle_supported": { "type": "boolean", "format": "boolean", "title": "Indicates, if domain technical handle is supported in specified extension" }, "trade_available": { "type": "boolean", "format": "boolean", "title": "Indicates, if domain trade is supported by extension" }, "transfer_available": { "type": "boolean", "format": "boolean", "title": "Indicates, if domain transfer is supported by extension" }, "usage_count": { "type": "integer", "format": "int32", "title": "Returns count of domains using specified extension" } }, "example": { "admin_handle_supported": false, "billing_handle_enabled": false, "billing_handle_supported": false, "description": { "text": "

La extensión de nombre de dominio .BIZ es el dominio de primer nivel orientado al sector de los negocios. La extensión de dominio .BIZ es utilizada por empresas que desean una única presencia en Internet. La extensión .BIZ ha sido desarrollada para promocionar la nueva generación de comercio electrónico, y de aplicaciones Internet.

", "url": "http://www.neustarregistry.biz" }, "dnssec_algorithms": [ 3 ], "dnssec_allowed": false, "dnssec_digests_allowed": false, "dnssec_keys_allowed": false, "dnssec_max_records_amount": 0, "domicile_available": false, "is_auth_code_available": false, "is_auth_code_changeable": false, "is_auth_code_requested": false, "is_private_whois_allowed": false, "is_trade_auth_code_required": true, "is_transfer_auth_code_required": true, "level_prices": [ { "level": 1, "price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } } } ], "max_period": 10, "min_period": 1, "name": "eu", "owner_handle_supported": false, "prices": { "create_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "domicile_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "max_period": 10, "min_period": 1, "renew_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "reseller_price": { "product": { "currency": "USD", "price": 226 }, "promotion_details": { "end_date": "1589932800", "non_promo_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "start_date": "1582156800" }, "reseller": { "currency": "USD", "price": 226 } }, "restore_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "setup_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "soft_restore_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "trade_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "transfer_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } }, "update_price": { "product": { "currency": "USD", "price": 226 }, "reseller": { "currency": "USD", "price": 226 } } }, "quarantine_period": 38, "renew_available": false, "reseller_handle_enabled": false, "reseller_handle_supported": false, "restrictions": [ "Los dominios premium (cortos y nombres gen\u00e9ricos) son m\u00e1s caros para registros y renovaciones" ], "soft_quarantine_period": 44, "status": "ACT", "supported_application_mode": [ { "name": "claims", "title": "General Availability" } ], "supported_idn_scripts": [ { "description": "Afrikaans", "value": "AFR" } ], "tech_handle_supported": false, "trade_available": false, "transfer_available": false, "usage_count": 0 } }, "transactionListTransactionsResponse": { "type": "object", "title": "ListTransactionsResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "The code" }, "data": { "title": "The data", "$ref": "#/definitions/transactionListTransactionsResponseData" }, "desc": { "type": "string", "title": "The desc" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "The maintenance" }, "warnings": { "type": "array", "title": "The warnings", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "results": [ { "action": "NEW", "creation_date": "2006-09-13 16:19:05", "discount": 0, "exchange_rate": 0, "object_type": "", "price": { "product": { "currency": "EUR", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } }, "quantity": 1, "reference_id": 1, "setup": { "product": { "currency": "EUR", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } }, "subject": "", "total": { "product": { "currency": "EUR", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } }, "type": "transaction", "vat": 1 } ], "total": 5389 }, "desc": "" } }, "transactionListTransactionsResponseData": { "type": "object", "title": "ListTransactionsResponseData", "properties": { "results": { "type": "array", "title": "The results", "items": { "$ref": "#/definitions/transactionListTransactionsResponseDataResults" } }, "total": { "type": "integer", "format": "int32", "title": "The total" } }, "example": { "results": [ { "action": "NEW", "creation_date": "2006-09-13 16:19:05", "discount": 0, "exchange_rate": 0, "object_type": "", "price": { "product": { "currency": "EUR", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } }, "quantity": 1, "reference_id": 1, "setup": { "product": { "currency": "EUR", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } }, "subject": "", "total": { "product": { "currency": "EUR", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } }, "type": "transaction", "vat": 1 } ], "total": 5389 } }, "transactionListTransactionsResponseDataResults": { "type": "object", "title": "ListTransactionsResponseDataResults", "properties": { "action": { "type": "string", "title": "The action" }, "creation_date": { "type": "string", "title": "The creation date" }, "discount": { "type": "number", "format": "double", "title": "The discount" }, "exchange_rate": { "type": "number", "format": "double", "title": "The exchange rate" }, "object_type": { "type": "string", "title": "The object type" }, "price": { "title": "The price", "$ref": "#/definitions/transactionPrices" }, "quantity": { "type": "integer", "format": "int32", "title": "The quantity" }, "reference_id": { "type": "integer", "format": "int32", "title": "The reference id" }, "setup": { "title": "The setup", "$ref": "#/definitions/transactionPrices" }, "subject": { "type": "string", "title": "The subject" }, "total": { "title": "The total", "$ref": "#/definitions/transactionPrices" }, "type": { "type": "string", "title": "The type" }, "vat": { "type": "integer", "format": "int32", "title": "The vat" } }, "example": { "action": "NEW", "creation_date": "2006-09-13 16:19:05", "discount": 0, "exchange_rate": 0, "object_type": "", "price": { "product": { "currency": "EUR", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } }, "quantity": 1, "reference_id": 1, "setup": { "product": { "currency": "EUR", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } }, "subject": "", "total": { "product": { "currency": "EUR", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } }, "type": "transaction", "vat": 1 } }, "transactionPrice": { "type": "object", "title": "Price", "properties": { "currency": { "type": "string", "title": "The currency" }, "price": { "type": "number", "format": "double", "title": "The price" } }, "example": { "currency": "EUR", "price": 0 } }, "transactionPrices": { "type": "object", "title": "Prices", "properties": { "product": { "title": "Price in product currency", "$ref": "#/definitions/transactionPrice" }, "reseller": { "title": "Price in reseller currency", "$ref": "#/definitions/transactionPrice" } }, "example": { "product": { "currency": "EUR", "price": 0 }, "reseller": { "currency": "EUR", "price": 0 } } }, "zoneCreateZoneRequest": { "type": "object", "title": "CreateZoneRequest", "properties": { "domain": { "title": "Name of the domain to which DNS zone corresponds. Represented by array of domain name and extension", "$ref": "#/definitions/zoneDomain" }, "is_spamexperts_enabled": { "type": "string", "title": "Used to enable spam filtering for this DNS zone" }, "master_ip": { "type": "string", "title": "IP of the master nameserver for this DNS zone. Required if DNS zone type = slave" }, "provider": { "type": "string", "title": "Name of the DNS provider. Set provider=sectigo in case of sectigo premium DNS zone should be created" }, "records": { "type": "array", "title": "Array of DNS records", "items": { "$ref": "#/definitions/zoneRecord" } }, "secured": { "type": "boolean", "format": "boolean", "title": "Used to enable or disable DNSSEC for this DNS zone" }, "template_name": { "type": "string", "title": "Name of the DNS template to use with this DNS zone" }, "type": { "type": "string", "title": "DNS zone type (master or slave)" } }, "example": { "domain": { "extension": "com", "name": "domain" }, "is_spamexperts_enabled": "on", "master_ip": "127.0.0.1", "provider": "sectigo", "records": [ { "name": "domain.com", "prio": 1, "ttl": 900, "type": "CNAME", "value": "abcd.domain.com" } ], "secured": false, "template_name": "default", "type": "master" } }, "zoneDomain": { "type": "object", "title": "Domain", "properties": { "extension": { "type": "string", "title": "Domain extension" }, "name": { "type": "string", "title": "Domain name without extension" } }, "example": { "extension": "com", "name": "domain" } }, "zoneGetZoneResponse": { "type": "object", "title": "GetZoneResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/zoneZone" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "active": true, "creation_date": "2012-02-05 7:37:28", "dnskey": "", "history": [ { "date": "2019-06-19 17:40:09", "is": true, "source": "", "was": "" } ], "id": 12345, "ip": "127.0.0.1", "is_deleted": false, "is_shadow": false, "is_spamexperts_enabled": false, "modification_date": "2018-11-28 6:57:05", "name": "domain.com", "premium_dns": { "sectigo": { "autorenew": false, "order_date": "2021-08-05 7:37:28", "renewal_date": "2022-11-28 6:57:05", "secured": false, "website_id": 123456 } }, "provider": "sectigo", "records": [ { "creation_date": "", "ip": "127.0.0.1", "modification_date": "", "name": "domain.com", "prio": 1, "ttl": 900, "type": "CNAME", "value": "abcd.domain.com" } ], "reseller_id": 123456, "type": "master" }, "desc": "" } }, "zoneListZonesOrderBy": { "type": "object", "title": "ListZonesOrderBy", "properties": { "creation_date": { "type": "string", "title": "Sorting type (asc/desc)", "default": "desc" }, "modification_date": { "type": "string", "title": "Sorting type (asc/desc)" }, "name": { "type": "string", "title": "Sorting type (asc/desc)" } }, "example": { "creation_date": "desc", "modification_date": "", "name": "" } }, "zoneListZonesResponse": { "type": "object", "title": "ListZonesResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/zoneListZonesResponseData" }, "desc": { "type": "string", "title": "Response description" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "results": [ { "active": true, "creation_date": "2012-02-05 7:37:28", "dnskey": "", "history": [ { "date": "2019-06-19 17:40:09", "is": true, "source": "", "was": "" } ], "id": 12345, "ip": "127.0.0.1", "is_deleted": false, "is_shadow": false, "is_spamexperts_enabled": false, "modification_date": "2018-11-28 6:57:05", "name": "domain.com", "premium_dns": { "sectigo": { "autorenew": false, "order_date": "2021-08-05 7:37:28", "renewal_date": "2022-11-28 6:57:05", "secured": false, "website_id": 123456 } }, "provider": "sectigo", "records": [ { "creation_date": "", "ip": "127.0.0.1", "modification_date": "", "name": "domain.com", "prio": 1, "ttl": 900, "type": "CNAME", "value": "abcd.domain.com" } ], "reseller_id": 123456, "type": "master" } ], "total": 1888 }, "desc": "" } }, "zoneListZonesResponseData": { "type": "object", "title": "ListZonesResponseData", "properties": { "results": { "type": "array", "title": "Array of search results", "items": { "$ref": "#/definitions/zoneZone" } }, "total": { "type": "integer", "format": "int32", "title": "Number of search results" } }, "example": { "results": [ { "active": true, "creation_date": "2012-02-05 7:37:28", "dnskey": "", "history": [ { "date": "2019-06-19 17:40:09", "is": true, "source": "", "was": "" } ], "id": 12345, "ip": "127.0.0.1", "is_deleted": false, "is_shadow": false, "is_spamexperts_enabled": false, "modification_date": "2018-11-28 6:57:05", "name": "domain.com", "premium_dns": { "sectigo": { "autorenew": false, "order_date": "2021-08-05 7:37:28", "renewal_date": "2022-11-28 6:57:05", "secured": false, "website_id": 123456 } }, "provider": "sectigo", "records": [ { "creation_date": "", "ip": "127.0.0.1", "modification_date": "", "name": "domain.com", "prio": 1, "ttl": 900, "type": "CNAME", "value": "abcd.domain.com" } ], "reseller_id": 123456, "type": "master" } ], "total": 1888 } }, "zonePremiumDnsData": { "type": "object", "title": "PremiumDnsData", "properties": { "sectigo": { "title": "Additional data related to premium DNS zone managed by Sectigo", "$ref": "#/definitions/zoneSectigoData" } }, "example": { "sectigo": { "autorenew": false, "order_date": "2021-08-05 7:37:28", "renewal_date": "2022-11-28 6:57:05", "secured": false, "website_id": 123456 } } }, "zoneRecord": { "type": "object", "title": "Record", "properties": { "name": { "type": "string", "title": "DNS record name" }, "prio": { "type": "integer", "format": "int32", "title": "DNS record priority" }, "ttl": { "type": "integer", "format": "int32", "title": "DNS record priority" }, "type": { "type": "string", "title": "DNS record type" }, "value": { "type": "string", "title": "DNS record value" } }, "example": { "name": "domain.com", "prio": 1, "ttl": 900, "type": "CNAME", "value": "abcd.domain.com" } }, "zoneRecordUpdates": { "type": "object", "title": "RecordUpdates", "properties": { "add": { "type": "array", "title": "Array of DNS records to add", "items": { "$ref": "#/definitions/zoneRecord" } }, "remove": { "type": "array", "title": "Array of DNS records to remove", "items": { "$ref": "#/definitions/zoneRecord" } }, "replace": { "type": "array", "title": "Array of DNS records to replace", "items": { "$ref": "#/definitions/zoneRecord" } }, "update": { "type": "array", "title": "Array of DNS records to update", "items": { "$ref": "#/definitions/zoneRecordWithOriginal" } } }, "example": { "add": [ { "name": "domain.com", "prio": 1, "ttl": 900, "type": "CNAME", "value": "abcd.domain.com" } ], "remove": [ { "name": "domain.com", "prio": 1, "ttl": 900, "type": "CNAME", "value": "abcd.domain.com" } ], "replace": [ { "name": "domain.com", "prio": 1, "ttl": 900, "type": "CNAME", "value": "abcd.domain.com" } ], "update": [ { "original_record": { "name": "domain.com", "prio": 1, "ttl": 900, "type": "CNAME", "value": "abcd.domain.com" }, "record": { "name": "domain.com", "prio": 1, "ttl": 900, "type": "CNAME", "value": "abcd.domain.com" } } ] } }, "zoneRecordWithOriginal": { "type": "object", "title": "RecordWithOriginal", "properties": { "original_record": { "title": "Array of DNS records to update", "$ref": "#/definitions/zoneRecord" }, "record": { "title": "Array of DNS records to update", "$ref": "#/definitions/zoneRecord" } }, "example": { "original_record": { "name": "domain.com", "prio": 1, "ttl": 900, "type": "CNAME", "value": "abcd.domain.com" }, "record": { "name": "domain.com", "prio": 1, "ttl": 900, "type": "CNAME", "value": "abcd.domain.com" } } }, "zoneSectigoData": { "type": "object", "title": "SectigoData", "properties": { "autorenew": { "type": "boolean", "format": "boolean", "title": "Desired autorenew value" }, "order_date": { "type": "string", "title": "Premium DNS order creation date" }, "renewal_date": { "type": "string", "title": "Premium DNS order renewal date" }, "secured": { "type": "boolean", "format": "boolean", "title": "Used to enable or disable DNSSEC for this DNS zone" }, "website_id": { "type": "integer", "format": "int32", "title": "Premium DNS zone external ID" } }, "example": { "autorenew": false, "order_date": "2021-08-05 7:37:28", "renewal_date": "2022-11-28 6:57:05", "secured": false, "website_id": 123456 } }, "zoneUpdateZoneRequest": { "type": "object", "title": "UpdateZoneRequest", "properties": { "domain": { "title": "Name of the domain to which DNS zone corresponds. Represented by array of domain name and extension", "$ref": "#/definitions/zoneDomain" }, "id": { "type": "integer", "format": "int32", "title": "DNS zone ID" }, "is_spamexperts_enabled": { "type": "boolean", "format": "boolean", "title": "Used to enable spam filtering for this DNS zone" }, "master_ip": { "type": "string", "title": "IP of the master nameserver for this DNS zone. Required if DNS zone type = slave" }, "name": { "type": "string", "title": "Name of the domain to which DNS zone corresponds" }, "premium_dns": { "title": "Additional data related to premium DNS zone", "$ref": "#/definitions/zonePremiumDnsData" }, "provider": { "type": "string", "title": "Name of the DNS provider. Set provider=sectigo in case of sectigo premium DNS zone should be updated" }, "records": { "title": "DNS zone records grouped by action", "$ref": "#/definitions/zoneRecordUpdates" }, "type": { "type": "string", "title": "Type of DNS zone (master or slave)" } }, "example": { "domain": { "extension": "com", "name": "domain" }, "id": 1234567, "is_spamexperts_enabled": true, "master_ip": "127.0.0.1", "name": "domain.com", "premium_dns": { "sectigo": { "autorenew": false, "order_date": "2021-08-05 7:37:28", "renewal_date": "2022-11-28 6:57:05", "secured": false, "website_id": 123456 } }, "provider": "sectigo", "records": { "add": [ { "name": "domain.com", "prio": 1, "ttl": 900, "type": "CNAME", "value": "abcd.domain.com" } ], "remove": [ { "name": "domain.com", "prio": 1, "ttl": 900, "type": "CNAME", "value": "abcd.domain.com" } ], "replace": [ { "name": "domain.com", "prio": 1, "ttl": 900, "type": "CNAME", "value": "abcd.domain.com" } ], "update": [ { "original_record": { "name": "domain.com", "prio": 1, "ttl": 900, "type": "CNAME", "value": "abcd.domain.com" }, "record": { "name": "domain.com", "prio": 1, "ttl": 900, "type": "CNAME", "value": "abcd.domain.com" } } ] }, "type": "slave" } }, "zoneZone": { "type": "object", "title": "Zone", "properties": { "active": { "type": "boolean", "format": "boolean", "title": "Indicates whether DNS zone is active or inactive (shadow)" }, "creation_date": { "type": "string", "title": "DNS zone creation date" }, "dnskey": { "type": "string", "title": "DNS zone's DNSSEC signing key" }, "history": { "type": "array", "title": "DNS zone updates history", "items": { "$ref": "#/definitions/historyZoneHistory" } }, "id": { "type": "integer", "format": "int32", "title": "DNS zone ID" }, "ip": { "type": "string", "title": "DNS record IP address" }, "is_deleted": { "type": "boolean", "format": "boolean", "title": "Indicates whether DNS zone is deleted" }, "is_shadow": { "type": "boolean", "format": "boolean", "title": "Indicates whether DNS zone is active or inactive (shadow)" }, "is_spamexperts_enabled": { "type": "boolean", "format": "boolean", "title": "Indicates whether spamfiltering is enabled for the DNS zone" }, "modification_date": { "type": "string", "title": "Date the DNS zone was last modified" }, "name": { "type": "string", "title": "Name of the domain to which DNS zone corresponds" }, "premium_dns": { "title": "Additional data related to premium DNS zone", "$ref": "#/definitions/zonePremiumDnsData" }, "provider": { "type": "string", "title": "Name of the DNS provider" }, "records": { "type": "array", "title": "Array of DNS records", "items": { "$ref": "#/definitions/recordRecordInfo" } }, "reseller_id": { "type": "integer", "format": "int32", "title": "Your reseller ID" }, "type": { "type": "string", "title": "The type" } }, "example": { "active": true, "creation_date": "2012-02-05 7:37:28", "dnskey": "", "history": [ { "date": "2019-06-19 17:40:09", "is": true, "source": "", "was": "" } ], "id": 12345, "ip": "127.0.0.1", "is_deleted": false, "is_shadow": false, "is_spamexperts_enabled": false, "modification_date": "2018-11-28 6:57:05", "name": "domain.com", "premium_dns": { "sectigo": { "autorenew": false, "order_date": "2021-08-05 7:37:28", "renewal_date": "2022-11-28 6:57:05", "secured": false, "website_id": 123456 } }, "provider": "sectigo", "records": [ { "creation_date": "", "ip": "127.0.0.1", "modification_date": "", "name": "domain.com", "prio": 1, "ttl": 900, "type": "CNAME", "value": "abcd.domain.com" } ], "reseller_id": 123456, "type": "master" } }, "zoneZoneBoolResponse": { "type": "object", "title": "ZoneBoolResponse", "properties": { "code": { "type": "integer", "format": "int32", "title": "Response code" }, "data": { "title": "Response data", "$ref": "#/definitions/zoneZoneBoolResponseData" }, "desc": { "type": "string", "title": "Response example" }, "maintenance": { "type": "boolean", "format": "boolean", "title": "Indicates if Openprovider API is on maintenance" }, "warnings": { "type": "array", "title": "Array of warning messages", "items": { "$ref": "#/definitions/errorWarning" } } }, "example": { "code": 0, "data": { "success": false }, "desc": "" } }, "zoneZoneBoolResponseData": { "type": "object", "title": "ZoneBoolResponseData", "properties": { "success": { "type": "boolean", "format": "boolean", "title": "Indicates if request was successful" } }, "example": { "success": false } } }, "securityDefinitions": { "Bearer": { "type": "apiKey", "name": "Authorization", "in": "header", "x-linkTo": "tag/descAuthentication" } }, "security": [ { "Bearer": [] } ], "tags": [ { "description": "Openprovider is a wholesaler of Internet services and products with a unique platform from which you can find and manage all the products you need: Domains, new gTLDs, SSL certificates, licenses for Plesk and Virtuozzo, spam filters, and more!", "name": "descAbout", "x-displayName": "What is Openprovider", "x-traitTag": true }, { "description": "Openprovider API gives access to the entire Openprovider infrastructure via a standardised interface based on [OpenAPI Specification](https://github.com/OAI/OpenAPI-Specification). With the help of Openprovider's API, you can do just about anything you can do in [Reseller Control Panel](https://rcp.openprovider.eu). \n\nThe Openprovider API is a RESTful API based on HTTPS requests and JSON responses. If you have your Openprovider account, you can obtain your API authentication token via the following endpoint:\n\n```\nPOST https://api.openprovider.eu/v1beta/auth/login\n```\n", "name": "descGettingStarted", "x-displayName": "Getting started", "x-traitTag": true }, { "description": "Openprovider API is accessed by making HTTPS requests to a specific version endpoint URL, in which GET, POST, PUT, and DELETE methods dictate how your interact with the available data. Every endpoint is accessed only via the SSL-enabled HTTPS (port 443) protocol.\n\nBe noted that\u00a0in order to maintain compatibility in the future, all requests must specify an API version, which is appended to the URL. The [latest version](http://docs.openprovider.com) is v1beta and the base URL for this version's endpoint is:\n\n```\nhttps://api.openprovider.eu/v1beta/\n```", "name": "descEndpoints", "x-displayName": "Endpoints", "x-traitTag": true }, { "description": "At its current state Openprovider API only supports Bearer Authentication which involves acquiring security tokens that are then passed in a request. This token must be sent in the `Authorization` header when making requests to protected resources:\n\n```\nAuthorization: Bearer \n```\n\n### Bearer authentication\n\n```\ncurl -X POST https://api.openprovider.eu/v1beta/auth/login \\\n -d '{\"username\": \"user\", \"password\": \"******\", \"ip\": \"0.0.0.0\"}'\n```\n\n```\n{\n \"data\": {\n \"token\": \"6f6d86377bc******feb75cea76d8e8b\",\n \"reseller_id\": 100001\n }\n}\n```", "name": "descAuthentication", "x-displayName": "Authentication", "x-traitTag": true }, { "description": "Additional data are any data required by domain registries beyond the basic contact information (company name, contact name, address, telephone number and e-mail address) at the time of domain registration. While most extensions can be registered with just the basic contact data, several extensions require additional contact information in order to register a domain name. \n\nWhile you can find this information in the Openprovider Knowledge base, for automated applications it can be more efficient to retrieve this information via API. \n\nThere are two categories of additional data: **customer additional data** and **domain additional data** \n\n- **Customer additional data** is data which is associated with a customer, but is required for one or more extensions, for example \"company registration number \", \"social security number\" or \"trading name\"\n- **Domain additional data** is data which must be associated with the domain when registering. A common example would be the IDN script. This information is used to specify which language is being used for a domain. This helps registrars prohibit registration of domains which could be used in \"homographic\" or \"scrip spoofing\" attacks\n\n\n\n## Retrieve Customer additional data\n\nRetrieve the list of fields which must be included in the domain \"extension_additional_data\" when creating a domain of the target extension. \n\nIn this example, we query the .eu extension to understand if there are any additional data requirements. See below on how to register a domain using this information\n\n```\nGET {base_url}/domains/additional-data/customers\n```\n\n**REQUEST EXAMPLE**\n\n```bash\ncurl -X GET \\ \n-H 'Authorization: Bearer ' \\\n'https://api.openprovider.eu/v1beta/domains/additional-data/customers?domain.extension=eu'\n```\n\n**Query parameters**\n\n| **Name** | **Type** | **Description** |\n| ---------------- | -------- | ---------------------------------------------------------- |\n| domain.extension | string | The extension for which to retrieve additional data fields |\n\n\n**RESPONSE EXAMPLE**\n\n```json\n{\"code\": 0,\n \"data\": [{\"description\": \"The WHOIS email address of a registrant will only \"\n \"be visible on the web-based WHOIS \"\n \"https://whois.eurid.eu/en/ instead of current email\",\n \"name\": \"whois_email\",\n \"required\": False,\n \"type\": \"text\"},\n {\"description\": \"Country of citizenship (only applicable for natural \"\n \"persons if country of residence is not within the \"\n \"eligible countries)\",\n \"name\": \"country_of_citizenship\",\n \"required\": False,\n \"type\": \"text\"}],\n \"desc\": \"\"}\n```\n\n**RESPONSE VALUES**\n\n| **Name** | **Type** | **Description** |\n| ----------- | -------- | ------------------------------------------------------------ |\n| name | string | The name of the parameter when including it in the \"additional_data\" array of the create domain requet |\n| type | string | the type of data to be included in this parameter |\n| required | boolean | Indicates if this parameter is required for registering the queried extension |\n| description | string | text explanation of the |\n\n## **Creating a customer with additional data**\n\nIn the above example, we have determined that for .eu domains, the \"country_of_citizenship\" parameter is required for potential domain owners who may live outside the EU/EEA geographic area, but nonetheless are a citizen of a country which is a member of the EU.\n\nTake for example an individual residing in the United States, but a resident of the Netherlands. In order to register an .eu domain for this customer, we would need to include the additional data fields as shown in the below example.\n\nNote that in the data fields, we suppose our customer has informed us that they want their company email to be displayed in the .eu whois, so we include that data as well, even though this is an optional parameter.\n\n```bash\ncurl -X POST \\\nhttps://api.cte.openprovider.eu/v1beta/customers/ \\\n-H 'Authorization: Bearer 856481ca5a381e6f44785eb2bb352ae9' \\\n-d '{\"address\": {\"street\": \"fake street\", \"number\": \"123\", \"city\": \"Hollywood\", \"zipcode\": \"90210\", \"state\": \"California\", \"country\": \"US\"}, \"company_name\": \"Hosters with Style\", \"email\": \"example@mail.tld\", \"fax\": {\"area_code\": \"303\", \"country_code\": \"+1\", \"subscriber_number\": \"123456\"}, \"name\": {\"first_name\": \"Carsten\", \"full_name\": \"Carsten G van Noort\", \"initials\": \"C.G.P.\", \"last_name\": \"van Noort\", \"prefix\": \"Dr.\"}, \"phone\": {\"area_code\": \"111\", \"country_code\": \"+1\", \"subscriber_number\": \"123456\"}, \n\n\"extension_additional_data\": [\n\t{\n\t\t\"data\":\n\t\t{\n \t\"country_of_citizenship\": \"NL\",\n \t\"whois_email\":\"company-mail@company-domain.tld\"\n },\n \t\"name\": \"eu\"\n\t}\n]}' \n```\n\n\n\n## Retrieve domain additional data\n\n```\nGET {base_url}/domains/additional-data\n```\n\n**REQUEST EXAMPLE**\n\n```bash\ncurl -X GET \\\n-H 'Authorization: Bearer ' \\\n'https://api.openprovider.eu/v1beta/domains/additional-data?domain.extension=ca'\n```\n\n**REQUEST VALUES**\n\n| **Name** | **Type** | **Description** |\n| ---------------- | -------- | ---------------------------------------------------------- |\n| domain.extension | string | The extension for which to retrieve additional data fields |\n\n\n**RESPONSE EXAMPLE**\n\n```json\n{'code': 0,\n 'data': [{'description': 'Legal type',\n 'name': 'legal_type',\n 'options': [{'description': 'Aboriginal Peoples indigenous to '\n 'Canada',\n 'value': 'ABO'},\n {....several options....}\n {'description': 'Trust established in Canada',\n 'value': 'TRS'}],\n 'required': True,\n 'type': 'select'}],\n 'desc': ''}\n```\n\n**RESPONSE VALUES**\n\n| **Name** | **Type** | **Description** |\n| ----------- | ------------------------------------------------------- | ------------------------------------------------------------ |\n| description | string | an explanation of the data field |\n| name | string | the name of the parameter as it must appear in the domain create API query |\n| options | list of key value arrays with keys (description, value) | list of the possible options which can be selected for this parameter |\n| required | boolean | whether this is a required field |\n| type | string | Indicates the type of parameter, in this case it must be one of the provided options |\n\n**Domain additional data example**\n\nWe see from the above example that the \"legal_type\" is required when registering a .ca domain, and from our communications with the client, we understand that they are representing a \"trust established in Canada\" so we will register the domain with the \"TRS\" value in the \"legal_type\" .\n\n```bash\ncurl -X POST / \nhttps://api.cte.openprovider.eu/v1beta/domains/ \\\n-d '{\"owner_handle\": \"CV904717-NL\", \"billing_handle\": \"CV904717-NL\", \"tech_handle\": \"CV904717-NL\", \"domain\": {\"name\": \"canadian-trust-example\", \"extension\": \"ca\"}, \"ns_group\": \"testin\", \"period\": \"1\", \n\t\n\t\"additional_data\": \n\t\t{\n\t\t\t\"legal_type\": \"TRS\"\n\t\t}\n}' \n```\n\n", "name": "descTLDQuickstart", "x-displayName": "Additional Data", "x-traitTag": true }, { "description": "Customer handles are common throughout products in the Openprovider system. When you successfully create a customer in Openprovider via the API, the response will return a \"handle\" of the form XX123456-XX, Where the first two letters are the initials of the contact, and the last two letters are the country code associated with the address. \n\n## Create a customer\n\nWhile some domain registries require specific data to be provided within the handle object (check the \"[additional data](all#tag/descTLDQuickstart)\" for more details) let's create a customer with the minimum data necessary for registering gTLD domains or ordering SSL certificates.\n\nUse the endpoint path below. Base URL is determined by both the target environment and API version. \n\n```\nPOST {base_url}/customers\n```\n#### REQUEST EXAMPLE\n\n```bash\ncurl -X POST https://api.openprovider.eu/v1beta/customers \\\n-H 'Authorization: Bearer ' \\\n-H 'Content-Type: application/json' \\\n-d '{\"address\": {\"street\": \"Albusstraat\", \"number\": \"83\", \"city\": \"Oosterhout\", \"zipcode\": \"4903 RG\", \"state\": \"Noord-Brabant\", \"country\": \"NL\"},\"company_name\": \"Hosters with Style\", \"email\": \"example@mail.tld\", \"fax\": {\"area_code\": \"111\", \"country_code\": \"+05\", \"subscriber_number\": \"123456\"}, \"name\": {\"first_name\": \"Carsten\", \"full_name\": \"Carsten G van Noort\", \"initials\": \"C.G.P.\", \"last_name\": \"van Noort\", \"prefix\": \"Dr.\"}, \"phone\": {\"area_code\": \"111\", \"country_code\": \"+04\", \"subscriber_number\": \"123456\"}, \"tags\": [{\"key\": \"customer\", \"value\": \"VIP\"}]}'\n```\n\n#### REQUEST VALUES\n\n| **Name** | **Type** | **Description** |\n| ------------ | ------------------------------------------------------------ | --------------- |\n| company_name | string | Optional. |\n| name | array with keys: (initials, first_name, prefix, last_name, full_name) | **Required**. |\n| address | array with keys : (street, number, zipcode, city, country, state) | **Required.** |\n| phone | array with keys: (country_code,area_code,subscriber_number) | **Required.** |\n| fax | array with keys: (country_code, area_code, subscriber_number) | Optional. |\n| email | string | **Required.** |\n| tags | list of array with keys (key, value) | Optional. |\n\n\n#### RESPONSE EXAMPLE\n\n```json\n{\n\"code\": 0,\n\"data\": {\n\"handle\": \"CV904716-NL\"\n},\n\"desc\": \"\"\n}\n```\n\n#### RESPONSE VALUES\n\n| **Name** | **Type** | **Description** |\n| -------- | -------- | -------------------------- |\n| handle | varchar | Customer unique identifier |\n\n## Modifying a handle\n\nIn order to change data of an existing customer handle one has to utilise Update Customer method. This method takes all the input parameters of Create Customer method with the exception of user's name fields (or company name). These ones have to stay the same. If you need to change the name of a customer, you can do so by cloning an existing handle or creating it anew.\n\nUse the endpoint path below. Base URL is determined by both the target environment and API version. \n\n```\nPUT {base_url}/customers/{handle}\n```\n#### REQUEST EXAMPLE\n\n```bash\ncurl -X PUT https://api.openprovider.eu/v1beta/customers/XX123456-XX \\\n-H 'Authorization: Bearer ' \\\n-H 'Content-Type: application/json' \\\n-d '{\"additional_data\": {\"birth_address\": \"test street 45\",\"birth_city\": \"Test city\",\"birth_country\": \"NL\",\"birth_date\": \"1970-01-01\",\"birth_state\": \"Testprovince\",\"birth_zipcode\": \"0123\",\"cif_nif_number\": \"\",\"company_registration_city\": \"Testcity\",\"company_registration_number\": \"12345678\",\"company_registration_subscription_date\": \"2000-01-01\",\"cost_category\": \"\",\"cost_center\": \"\",\"headquarters_address\": \"Test street 5\",\"headquarters_city\": \"Testcity\",\"headquarters_country\": \"NL\",\"headquarters_state\": \"Testprovince\",\"headquarters_zipcode\": \"0123\",\"internal_reference\": \"\",\"passport_number\": \"0123456\",\"project_code\": \"\",\"purchase_order_number\": \"\",\"social_security_number\": \"6543210\"},\"address\": {\"city\": \"Test city\",\"country\": \"NL\",\"number\": \"1\",\"state\": \"Testprovince\",\"street\": \"Test street\",\"suffix\": \"A\",\"zipcode\": \"0123\"},\"comments\": \"Some comment here\",\"email\": \"test@mail.tld\",\"extension_additional_data\": [{\"data\": {\"admin_type\": \"1\",\"applicant_purpose\": \"P3\",\"birth_date\": \"1970-01-01\",\"company_name_cyrillic\": \"Example company\",\"company_name_latin\": \"Example company\",\"company_registration_number\": \"XX123456789X11\",\"contact_title\": \"CEO\",\"ens_auth_id\": \"\",\"ens_key\": \"\",\"first_name_cyrillic\": \"Test\",\"first_name_latin\": \"Test\",\"hr_member\": \"\",\"industry_class\": \"19\",\"is_private_enterpreneur\": \"\",\"last_name_cyrillic\": \"Person\",\"last_name_latin\": \"Person\",\"legal_address_cyrillic\": \"13245 Country, City, street, 2\",\"middle_name_cyrillic\": \"Nikolaevich\",\"middle_name_latin\": \"Nikolaevich\",\"mobile_phone_number\": \"+7 (123) 456-78-90\",\"nexus_category\": \"C31\",\"org_type\": \"1\",\"passport_issue_date\": \"2009-01-11\",\"passport_issuer\": \"Issuer name\",\"passport_number\": \"12345678\",\"passport_series\": \"1234\",\"postal_address_cyrillic\": \"12345 Country, City, street, 1\",\"social_security_number\": \"X123455123X\",\"tax_payer_number\": \"1345678\",\"uin\": \"12345-6\",\"user_type\": \"Individual\",\"vat\": \"12345678\",\"website\": \"http://example.com\",\"whois_email\": \"test@mail.tld\"},\"name\": \"ru\"}],\"fax\": {\"area_code\": \"001\",\"country_code\": \"+01\",\"subscriber_number\": \"123456\"},\"handle\": \"XX123456-XX\",\"locale\": \"nl_NL\",\"phone\": {\"area_code\": \"10\",\"country_code\": \"+01\",\"subscriber_number\": \"123456\"},\"tags\": [{\"key\": \"customer\",\"value\": \"VIP\"}],\"vat\": \"NL123456789X11\"}'\n```\n\n#### REQUEST VALUES\n\n| **Name** | **Type** | **Description** |\n| ------------ | ------------------------------------------------------------ | --------------- |\n| vat | string | Optional. |\n| address | string | Optional. |\n| phone | various | Optional. |\n| fax | various | Optional. |\n| email | various | Optional. |\n| additional_data | various | Optional. |\n| extension_additional_data | various | Required for some TLDs |\n| tags | varchar | Optional. |\n\n\n#### RESPONSE EXAMPLE\n\n```json\n{\n\"code\": 0,\n\"data\": {\n\"success\": \"true\"\n},\n\"desc\": \"\"\n}\n```\n\n#### RESPONSE VALUES\n\n| **Name** | **Type** | **Description** |\n| -------- | -------- | -------------------------- |\n| status | bool | status result |\n\n## Searching and retrieving customer handles\n\nThe Openprovider API has two methods which can return information about an existing customer object. The search method returns a list of customer objects matching a particular criteria.\n\n## Search for a customer \n\nUse endpoint path below. Base URL is determined by both the target environment and API version.\n\n```\nGET {base_url}/customers\n```\n\n**REQUEST EXAMPLE**\n\n```bash\ncurl -X GET \\\n'https://api.openprovider.eu/v1beta/customers?first_name_pattern=Car%2Aten' \\\n-H 'Authorization: Bearer ' \\\n```\n\n**REQUEST VALUES**\n\nFor all possible search parameters, please see the method documentation. \n\n| **Name** | **Type** | **Description** |\n| -------------------- | -------- | ------------------------------------------------------------ |\n| handle_pattern | string | search by handle. Note that wildcard (*) can be used. |\n| email_pattern | string | search by email . Note that wildcard (*) can be used. |\n| first_name_pattern | string | search by first name. Note that wildcard (*) can be used. |\n| last_name_pattern | string | search by last name. Note that wildcard (*) can be used. |\n| company_name_pattern | string | search by company name. Note that wildcard (*) can be used. |\n| comment_pattern | string | search by comment. Note that wildcard (*) can be used. |\n| with_additional_data | boolean | True in order to retrieve any additional data associated with the handle |\n| limit | integer | default value: 100, maximum value: 1000 |\n| offset | integer | default value: 0 |\n\n\n#### RESPONSE EXAMPLE\n\n```json\n{\n \"code\": 0,\n \"desc\": \"\",\n \"data\":\n {\n \"results\":\n [\n {\n \"id\": 988275,\n \"company_name\": \"Hosters with Style\",\n \"name\":\n {\n \"initials\": \"C.G.P.\",\n \"first_name\": \"Carsten\",\n \"prefix\": \"Dr.\",\n \"last_name\": \"van Noort\",\n \"full_name\": \"Carsten Dr. van Noort\"\n },\n \"phone\":\n {\n \"country_code\": \"+04\",\n \"area_code\": \"111\",\n \"subscriber_number\": \"123456\"\n },\n \"address\":\n {\n \"street\": \"Albusstraat\",\n \"number\": \"83\",\n \"zipcode\": \"4903 RG\",\n \"city\": \"Oosterhout\",\n \"country\": \"NL\",\n \"state\": \"Noord-Brabant\"\n },\n \"email\": \"example@mail.tld\",\n \"handle\": \"CV904716-NL\",\n \"reseller_id\": 242219,\n \"locale\": \"nl_NL\",\n \"deleted_at\": \"0000-00-00 00:00:00\",\n \"is_deleted\": false,\n \"tags\":\n [\n {\n \"key\": \"customer\",\n \"value\": \"VIP\"\n }\n ]\n }\n ],\n \"total\": 1\n }\n}\n```\n\n## Retrieving a specific handle\n\nCustomer data can also be retrieved directly by handle\n\nUse endpoint path below. Base URL is determined by both the target environment and API version.\n\n```\nGET {base_url}/customers/{handle}\n```\n\n#### REQUEST VALUES\n\n| **Name** | **Type** | **Description** |\n| -------------------- | -------- | --------------------------------------------------------- |\n| handle | string | |\n| with_additional_data | string | Accepted values \u2018true\u2019 or \u2018false\u2019 - default value \u2018false\u2019 |\n\n#### REQUEST EXAMPLE\n\n```bash\ncurl -X GET \\\nhttps://api.openprovider.eu/v1beta/customers/CV904716-NL \\\n-H 'Authorization: Bearer '\n```\n\n#### RESPONSE EXAMPLE\n\n```json\n {\n \"code\": 0,\n \"desc\": \"\",\n \"data\":\n {\n \"id\": 988275,\n \"company_name\": \"Hosters with Style\",\n \"name\":\n {\n \"initials\": \"C.G.P.\",\n \"first_name\": \"Carsten\",\n \"prefix\": \"Dr.\",\n \"last_name\": \"van Noort\",\n \"full_name\": \"Carsten Dr. van Noort\"\n },\n \"phone\":\n {\n \"country_code\": \"+04\",\n \"area_code\": \"111\",\n \"subscriber_number\": \"123456\"\n },\n \"address\":\n {\n \"street\": \"Albusstraat\",\n \"number\": \"83\",\n \"zipcode\": \"4903 RG\",\n \"city\": \"Oosterhout\",\n \"country\": \"NL\",\n \"state\": \"Noord-Brabant\"\n },\n \"email\": \"example@mail.tld\",\n \"handle\": \"CV904716-NL\",\n \"reseller_id\": 242219,\n \"fax\":\n {\n \"country_code\": \"+05\",\n \"area_code\": \"111\",\n \"subscriber_number\": \"123456\"\n },\n \"locale\": \"nl_NL\",\n \"deleted_at\": \"0000-00-00 00:00:00\",\n \"is_deleted\": false,\n \"tags\":\n [\n {\n \"key\": \"customer\",\n \"value\": \"VIP\"\n }\n ]\n }\n}\n```\n\n\n\n## Delete a handle\n\nHandle deletion removes an existing customer object and all its records. **IF** it is not connected to any active products, such as domains or certificates.\n\nThe name of the handle is the only parameter that is required to perform this operation.\n\nUse endpoint path below. Base URL is determined by both the target environment and API version.\n\n```\nDEL {base_url}/customers/{handle}\n```\n\n#### REQUEST EXAMPLE\n\n```bash\ncurl -X DELETE \\\n 'https://api.openprovider.eu/v1beta/customers/CV904716-NL' \\\n -H 'Authorization: ,Bearer ' \\\n```\n\n#### RESPONSE EXAMPLE\n\n```json\n{\n\"code\": 0,\n\"data\": {\n\"success\": true\n},\n\"desc\": \"\"\n}\n```\n\nDepending on the outcome, one will either receive code 0 (in case of success) or an error code with an error message.", "name": "descCustomerQuickstart", "x-displayName": "Customers", "x-traitTag": true }, { "description": "We strive to offer the best domain prices on the market through our flexible and personalized membership plans. Our powerful API allows you to automate almost any action you can do from the control panel. No matter the size of your portfolio, integrating with Openprovider should be easy. The domain guide will get you started with the basics: checking availability, registration, searching your portfolio, renewals and updates. \n\n## Check Domain Availability \n\nCheck if the domain you want to register is available, and optionally retrieve the registration price. Multiple domains can be searched in parallel.\n\nUse the endpoint path below. Base URL is determined by both the target environment and API version.\n\n```\nPOST {base_url}/domains/check\n```\n**REQUEST EXAMPLE**\n\nNote these are not all possible request values, please check method documentation for the full parameter list.\n\n```bash\ncurl -X POST \\\nhttps://api.openprovider.eu/v1beta/domains/check \\\n-H 'Authorization: Bearer ' \\\n-H 'Content-Type: application/json' \\\n-d '{\"domains\": [{\"extension\": \"tools\", \"name\": \"god\"},{\"extension\": \"com\", \"name\": \"some-amazing-example\"}], \"with_price\": true}' \n```\n\n**REQUEST VALUES**\n\n| **Name** | **Type** | **Values** | **Description** |\n| :--------- | :----------------------------------------- | :--------- | :----------------------------------------------------------- |\n| domains | list of arrays with keys (extension, name) | | list of domains to check. \"example.com\" would be written as `{\"extension\": \"com\",\"name\": \"example\"}` |\n| with_price | boolean | 0 or 1 | Indicate whether to include the domain price with domain availability. Price check nominally increases the query time, but can be n. |\n\n**RESPONSE EXAMPLE**\n\n```json\n{\n \"code\": 0,\n \"data\":\n {\n \"results\":\n [\n {\n \"domain\": \"some-amazing-example.com\",\n \"price\":\n {\n \"product\":\n {\n \"currency\": \"USD\",\n \"price\": 8.57\n },\n \"reseller\":\n {\n \"currency\": \"EUR\",\n \"price\": 7.53\n }\n },\n \"status\": \"free\"\n },\n {\n \"domain\": \"god.tools\",\n \"is_premium\": true,\n \"premium\":\n {\n \"price\":\n {\n \"create\": 250\n }\n },\n \"price\":\n {\n \"product\":\n {\n \"currency\": \"USD\",\n \"price\": 250\n },\n \"reseller\":\n {\n \"currency\": \"EUR\",\n \"price\": 219.8\n }\n },\n \"status\": \"free\"\n }\n ]\n },\n \"desc\": \"\"\n}\n```\n**RESPONSE VALUES**\n\n| **Name** | **Type** | **Values** | **Description** |\n| :--------- | :-------------- | :--------------------------- | :----------------------------------------------------------- |\n| domain | string | | the complete domain name expressed as a string. |\n| price | key value array | keys: (product, reseller) | Indicates the price of registering the domain. The product price is the current price charged by the supplier in the supplier's currency, and the reseller price expressed in the currency of your Openprovider account. |\n| is_premium | boolean | | indicates if the domain has a premium price for registrations |\n| premium | key value array | | only included in the case of a premium domain. Indicates the creation price in the currency of the domain supplier |\n| status | string | \"free\", \"reserved\", \"in use\" | Whether the domain is free to register, or already in use |\n\n## Register a domain\n\nOnce you've configured your Openprovider account and topped up your balance you will be able to register domains via the API. If there is sufficient balance in your account and the API call is correct the domain will be immediately registered in most cases and the balance deducted from your account. For a minority of extensions, further processing is required from the registry side, and the domain will be put in \"requested\" status until processing is completed and the domain is marked as \"active\"\n\nUse endpoint path below. Base URL is determined by both the target environment and API version.\n\n```\nPOST {base_url}/domains/\n```\n**REQUEST EXAMPLE**\n\n```bash\ncurl -X POST \\\nhttps://api.openprovider.eu/v1beta/domains \\\n-H 'Authorization: Bearer ' \\\n-H 'Content-Type: application/json' \\\n-d ' {\"admin_handle\": \"CV904717-NL\", \"billing_handle\": \"CV904717-NL\", \"owner_handle\":\"CV904717-NL\", \"tech_handle\": \"CV904717-NL\", \"domain\":{\"name\": \"greatdomain\", \"extension\": \"info\"}, \"period\": \"1\", \"name_servers\":[{\"name\": \"ns1.op.eu\"}, {\"name\": \"ns2.op.nl\"},{\"name\": \"ns3.op.be\"}], \"autorenew\": \"default\"}'\n```\n\n**REQUEST VALUES**\n\nNote these are not all possible request values, please check method documentation for a full list\n\n| **Name** | **Type** | **Description** |\n| --------------- | ------------------------------ | ------------------------------------------------------------ |\n| name | string | The domain name to register |\n| period | integer | Period of time to register the domain, default is year but some domains can be registered for months or quarters |\n| owner_handle | string | handle of the customer who will be the domain owner |\n| admin_handle | string | handle of the customer who will be domain admin |\n| tech_handle | string | handle of the customer who will be domain tech contact. |\n| billing_handle | string | Optional. |\n| reseller_handle | string | Optional. contact information for the domain reseller |\n| name_servers | list of arrays with key \"name\" | the nameservers to apply to the domain |\n| autorenew | string | *on \\| off \\| default* |\n\n**RESPONSE EXAMPLE**\n\n```json\n{\n \"code\": 0,\n \"data\":\n {\n \"activation_date\": \"2019-04-29 17:15:19\",\n \"auth_code\": \"C8$#wgG#25tQ\",\n \"expiration_date\": \"2020-04-29 17:15:19\",\n \"id\": 10592139,\n \"renewal_date\": \"2020-04-29 17:15:19\",\n \"status\": \"ACT\"\n },\n \"desc\": \"\"\n}\n```\n\n**RESPONSE VALUES**\n\n| **Name** | **Type** | **Description** |\n| --------------- | -------- | ------------------------------------------------------------ |\n| status | | ACT - active or REQ - requested |\n| auth_code | | only in case if TLD supports it |\n| activation_date | | available only in case of a succeeded realtime domain registration |\n\n\n## Transfer a domain\n\nAutomate the transfer of domains into your Openprovider account with the transfer method. Before starting a transfer, make sure you have the approval of the owner of the domain name and the domain is not locked for transfer at the current registrar.\n\nUse the endpoint path below. Base URL is determined by both the target environment and API version.\n\n```\nPOST {base_url}/domains/transfer\n```\n**REQUEST EXAMPLE**\n\n```json\ncurl -X POST \\\nhttps://api.openprovider.eu/v1beta/domains/transfer \\\n-H 'Authorization: Bearer ' \\\n-H 'Content-Type: application/json' \\\n-d ' {\"owner_handle\":\"CV904717-NL\",\"tech_handle\":\"CV904717-NL\",\"admin_handle\":\"CV904717-NL\",\"autorenew\":\"default\",\"auth_code\":\"gX38tslFG2#%F%%1\",\"domain\":{\"extension\":\"com\",\"name\":\"example\"},\"name_servers\":[{\"name\":\"ns1.op.eu\"},{\"name\":\"ns2.op.nl\"},{\"name\":\"ns3.op.be\"}]}'\n```\n**REQUEST VALUES**\n\nNote these are not all possible request values, please check method documentation for a full list\n\n| **Name** | **Type** | **Description** |\n| ------------ | ---------------------------------- | ------------------------------------------------------------ |\n| domain | array with keys: (name, extension) | The name and extension of the domain to be requested for transfer |\n| auth_code | string | The auth code or transfer code of the domain to be requested for transfer. Applicable to almost all TLDs, but not all. Check the Openprovider knowledge base for detailed transfer requirements of a given TLD. |\n| autorenew | string | on, off, default. The auto renew status which the domain should have after successful transfer |\n| owner_handle | string | The handle of the contact which will be designated domain owner after the transfer. |\n| admin_handle | string | The handle of the contact which will be designated domain admin after the transfer. |\n| tech_handle | string | The handle of the contact which will be designated domain tech contact after the transfer. |\n| name_servers | list of arrays with key \"name\" | the nameservers to apply to the domain |\n\n**RESPONSE EXAMPLE**\n\n```json\n{\n \"code\": 0,\n \"data\":\n {\n \"auth_code\": \"Z79sTaH\",\n \"expiration_date\": \"2020-03-31 23:59:59\",\n \"renewal_date\": \"2020-03-29 23:59:59\",\n \"status\": \"REQ\"\n },\n \"desc\": \"\"\n}\n```\n\n**RESPONSE VALUES**\n\n| **Name** | **Type** | **Description** |\n| ---------------------------- | --------- | ------------------------------------------------------------ |\n| expiration_date | timestamp | available only in case of a successful realtime domain transfer |\n| expiration_date_openprovider | timestamp | available only in case of a successful realtime domain transfer |\n| status | string | possible values are \"ACT\" for domains which immediately transfer successfully, and \"REQ\" for domains which have been requested for transfer and are awaiting approval. A domain will be marked with\"FAI\" status in the case that the transfer fails to complete. |\n\nThe transfer will be initiated at the registry level and the domain will be put in \"pendingTransfer\" status. Depending on the extension, the outgoing registrar should release the domain in 5-7 days. Unless actions are taken to prevent the transfer, it will be approved automatically.\n\nCheck the TLD documentation for the domain in question in order to see the specific workflow. Our documentation also tells you how long a transfer can take. This can range from near an instant to over a month.\n\nWhen the procedure is over, you will receive a corresponding notification to the email address associated with the Openprovider account which initiated the transfer. Depending on the extension, the domain will be renewed for one year and its status will automatically be set to 'clientTransferProhibited' (\"Lock domain\" will be enabled).\n\n\n\n## Search for a domain (retrieve domain ID)\n\nDomains in your account can be queried on a list of parameters, including status, extension, the full domain name, a wildcard pattern on the domain name, the nameserver group, the contact handle, and more. See the method documentation to see the full list. \n\nUsing the \"domain_name_pattern\" we will search for a couple domains using the wildcard character \"\\*\". We know we have domains \"greatdomain.info\" and \"greatdomain1.info\" and with \"domain_name_pattern\"=\"greatdomain*\" we can capture both domains. \n\nUse endpoint path below. Base URL is determined by both the target environment and API version.\n\n```\nGET {base_url}/domains/\n```\n\n**REQUEST EXAMPLE**\n\n```bash\ncurl -X GET \\\n-H 'Authorization: Bearer ' \\\n'https://api.openprovider.eu/v1beta/domains?limit=2&domain_name_pattern=greatdomain%2A&status=act'\n```\n\n**REQUEST VALUES**\n\nNote these are not all possible request values, please check method documentation for a full list\n\n| **Name** | **Type** | **Description** |\n| ------------------- | --------------------------------- | ------------------------------------------------------------ |\n| domain_name_pattern | string | the domain name (not including the extension) to be searched. The wildcard character \\* can be used. |\n| limit | int, default 100 | maximum number of domains to return in the results array |\n| status | string (\"ACT\",\"REQ\",\"DEL\", \"FAI\") | Include domains with the indicated status |\n\n**RESPONSE EXAMPLE**\n\n```json\n{'code': 0,\n 'data': {'results': [{'active_date': '2021-09-27 07:06:00',\n 'admin_handle': 'CV904717-NL',\n 'auth_code': '!@#$%^&*()',\n 'autorenew': 'off',\n 'billing_handle': 'CV904717-NL',\n 'can_renew': True,\n 'comments': 'Any comments go',\n 'comments_last_changed_at': '2021-09-27 07:05:59',\n 'creation_date': '2021-09-27 07:03:04',\n 'deleted_at': '0000-00-00 00:00:00',\n 'dnssec': 'unsigned',\n 'domain': {'extension': 'info', 'name': 'greatdomain1'},\n 'expiration_date': '2022-09-27 07:03:04',\n 'has_history': True,\n 'id': 1222095,\n 'internal_auth_code': '0',\n 'is_abusive': False,\n 'is_deleted': False,\n 'is_dnssec_enabled': True,\n 'is_hosted_whois': True,\n 'is_lockable': True,\n 'is_locked': True,\n 'is_premium': False,\n 'is_private_whois_allowed': True,\n 'is_private_whois_enabled': False,\n 'last_changed': '2021-09-27 07:40:47',\n 'modify_owner_allowed': True,\n 'name_servers': [{'ip': '',\n 'ip6': '',\n 'name': 'ns1.testin.nl',\n 'seq_nr': 0},\n {'ip': '64.190.62.111',\n 'ip6': '',\n 'name': 'ns2.testin.eu',\n 'seq_nr': 1}],\n 'ns_group': 'testin',\n 'ns_template_id': 0,\n 'ns_template_name': '',\n 'nsgroup_id': 161184,\n 'order_date': '2021-09-27 07:05:59',\n 'owner': {'company_name': 'Hosters with Style',\n 'full_name': 'Carsten Dr. van Noort'},\n 'owner_company_name': 'Hosters with Style',\n 'owner_handle': 'CV904717-NL',\n 'registry_expiration_date': '2022-09-27 07:03:04',\n 'renew': 0,\n 'renewal_date': '2022-09-27 07:03:04',\n 'reseller_handle': '',\n 'reseller_id': 242219,\n 'status': 'ACT',\n 'tech_handle': 'CV904717-NL',\n 'trade_allowed': False,\n 'trade_auth_code_required': 'no',\n 'transfer_auth_code_required': 'yes',\n 'transfer_cancel_supported': False,\n 'type': 'NEW',\n 'unit': 'y',\n 'use_domicile': False},\n {second example looks the same}\n ],\n 'total': 2},\n 'desc': ''}\n```\n\n**RESPONSE VALUES**\n\n| **Name** | **Type** | **Description** |\n| --------------------------- | --------------------------------------- | ------------------------------------------------------------ |\n| id | int | The domain ID, which can be used in the udpate domain and get domain methods |\n| domain | array (domain, extension) | key value array with the domain name and extension |\n| admin_handle | string (Openprovider handle) | Openprovider handle of admin contact |\n| owner | array (owner name and company name) | array with domain owner details |\n| owner_company_name | string | company name of owner, if applicable |\n| owner_handle | string (Openprovider handle) | Openprovider handle of owner contact |\n| billing_handle | string | Openprovider handle of billing contact |\n| reseller_handle | string (Openprovider handle) | Openprovider handle with reseller details |\n| tech_handle | string (Openprovider handle) | Openprovider handle of tech contact |\n| reseller_id | int | reseller ID to whom the domain belongs |\n| auth_code | string | authorization code for external transfers |\n| internal_auth_code | string | authorization code for transfers between Openprovider accounts |\n| status | string | the domain status in Openprovider, active, requested, deleted, failed transfer |\n| name_servers | array (nameserver objects) | Key value array indicating which nameservers are assigned to the domain |\n| nsgroup_id | int | the ID assigned to the domain's current nameservers |\n| dnssec | string or array | either \"unsigned\" or an array of DNSSEC information for the domain |\n| ns_template_id | int | if the domain was created with a ns_template, the template ID |\n| ns_template_name | string | if the domain was created with a ns_template, the template name |\n| autorenew | string | autorenew status of the domain in Openprovider, on, off, default |\n| can_renew | bool | whether the domain can be renewed |\n| comments | string | any comments you've left on the domain (only reseller can view) |\n| comments_last_changed_at | string (datetime) | time of most recent comment change |\n| renew | int | Indicates the availability of renew command for extensions with a renewal offset of 28 days from the expiration date |\n| type | string | Indicates how the domain entered your portfolio: NEW, TRADE, or TRANSFER |\n| unit | string (y, m, q) | indicates the period on which the domain is renewed, y - year, m - month, q - quarterly. |\n| active_date | string (datetime) | datetime the domain was indicated as active by the registry |\n| creation_date | string (datetime) | datetime the create request was received by the registry |\n| deleted_at | string (datetime) or 0 (if not deleted) | datetime the domain was deleted, if applicable |\n| expiration_date | string (datetime) | Datetime the domain will expire in Openprovider |\n| last_changed | string (datetime) | datetime of most recent update |\n| order_date | string (datetime) | datetime the create request was received by Openprovider |\n| registry_expiration_date | string (datetime) | Datetime the domain will expire in the registry |\n| renewal_date | string (datetime) | datetime autorenew will be triggered in Openprovider |\n| has_history | bool | whether domain operation history is available for the domain |\n| is_abusive | bool | whether or not Openprovider has received abuse complaints for this domain |\n| is_deleted | bool | whether the domain object has been deleted from Openprovider |\n| is_dnssec_enabled | bool | whether DNSSEC is enabled on the domain |\n| is_hosted_whois | bool | True indicates that WHOIS data exists with Openprovider, false indicates WHOIS data is only with the registry |\n| is_lockable | bool | if the domain can be locked in order to prevent unauthorized transfer |\n| is_locked | bool | whether domain is locked to prevent unauthorized transfer |\n| is_premium | bool | whether domain has a premium price |\n| is_private_whois_allowed | bool | whether domain contact details can be hidden from WHOIS queries |\n| is_private_whois_enabled | bool | whether domain contact details is hidden from WHOIS queries |\n| modify_owner_allowed | bool | whether the domain owner can be changed via the update command (if false, then owner can be changed only with the trade command) |\n| trade_allowed | bool | whether the trade command can be used on the domain |\n| trade_auth_code_required | bool | whether trades need an authcode to be completed |\n| transfer_auth_code_required | bool | whether external transfer authcode is needed |\n| transfer_cancel_supported | bool | whether transfers can be canceled after being initiated |\n| use_domicile | bool | whether domain is registered with a local address |\n\n\n\n## Update domain attributes\n\nTo modify the contact data of the domain or the nameservers as well as to set or remove a transfer lock or special parameters associated with the domain, you should utilize the Update Domain method of the API. Note that the domain ID will be needed from the search domain method.\n\nUse endpoint path below. Base URL is determined by both the target environment and API version.\n\n```\nPUT {base_url}/domains/{id}\n```\n**REQUEST EXAMPLE**\n\n```bash\ncurl -X PUT \\\n 'http://api.openprovider.eu/v1beta/domains/123456' \\\n -H 'Authorization: Bearer ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"owner_handle\": \"XX123456-XX\",\n \"admin_handle\": \"XX123456-XX\",\n \"autorenew\": \"on\",\n\t\"ns_group\": \"testin\"\n}'\n```\n\n**REQUEST VALUES**\n\nNote these are not all possible request values, please check method documentation for the full parameter list.\n\n| **Name** | **Type** | **Description** |\n| ------------ | ------------------------------- | --------------------------------------------- |\n| owner_handle | string | Must be an Openprovider handle |\n| admin_handle | string | Must be an Openprovider handle |\n| autorenew | string: (on \\| off \\| default) | Update the autorenew settings |\n| ns_group | string | Update the nameservers with a namesever group |\n\n\n**RESPONSE EXAMPLE**\n\n```json\n{\n \"data\":\n {\n \"id\": 123456,\n \"status\": \"ACT\"\n }\n}\n```\n\n\n\n\n## Request or reset an authcode\n\nIt reads the transfer authorization code (or EPP code) from the registry or triggers the registry to send the code to a domain owner (in case of .be and .eu, for instance.\n\nUse endpoint path below. Base URL is determined by both the target environment and API version.\n\n```\nGET {base_url}/domains/{id}/authcode\n```\n\n\n\n**REQUEST EXAMPLE - Request authcode**\n\nTo retrieve an already existing authcode\n\n```bash\ncurl -X GET \\\n 'https://api.openprovider.eu/v1beta/domains/123456/authcode' \\\n -H 'Authorization: Bearer ' \\\n```\n\n**REQUEST EXAMPLE - Reset authcode**\n\nTo trigger the generation of a new authcode.\n\n```bash\ncurl -X POST \\\n 'https://api.openprovider.eu/v1beta/domains/123456/authcode/reset' \\\n -H 'Authorization: Bearer ' \\\n```\n\n**REQUEST VALUES**\n\n| **Name** | **Type** | **Description** |\n| -------------- | -------- | ------------------------------------------------------------ |\n| id | string | the domain ID to be retrieved |\n| auth_code_type | string | Default \"external\". Value \"internal\" can be used to generate authcodes for transferring domains between Openprovider accounts. |\n\n**RESPONSE EXAMPLE**\n\n```json\n{\n \"code\": 0,\n \"data\":\n {\n \"auth_code\": \"12345678\",\n \"success\": true,\n \"type\": \"external\"\n },\n \"desc\": \"\"\n}\n```\n\n\n\n\n## Renew domain\n\nIf you've set \"autorenew\" parameter to \"on\" then your domains will be renewed automatically as long as funds are sufficient in your account to cover the cost. \n\nIn other cases you may want to manually renew a domain, depending on the logic of your business. In this case, note that some extensions can be renewed at any given time while others can only be renewed within a certain timeframe before their expiration date. Check the Openprovider knowledge base for detailed information on the given extension.\n\nUse endpoint path below. Base URL is determined by both the target environment and API version.\n\n```\nPOST {base_url}/domains/{id}/renew\n```\n\n\n\n**REQUEST EXAMPLE**\n\n```bash\ncurl -X POST \\\n 'https://api.openprovider.eu/v1beta/domains/123456/renew' \\\n -H 'Authorization: Bearer ' \\\n -d '{\"period\": 2}'\n```\n\n**REQUEST VALUES**\n\n| **Name** | **Type** | **Description** |\n| -------- | -------- | ------------------------------------------------------------ |\n| period | integer | default 1, the number of renewals to perform on the domain. If the domain has a yearly period, the domain will be renewed by default for 1 year. |\n\n**RESPONSE EXAMPLE**\n\n```json\n{\n \"code\": 0,\n \"data\":\n {\n \"status\": \"ACT\"\n },\n \"desc\": \"\"\n}\n```\n\n", "name": "descDomainQuickstart", "x-displayName": "Domains", "x-traitTag": true }, { "description": "Openprovider provides DNS hosting for which we have an extensive API. Zones hosted by Openprovider are automatically generated with the relevant NS and SOA records, and these records cannot be edited. Almost any other kind of record can be created and hosted on our nameservers. Check the Openprovider knowledge base for more information about what can be done with our DNS. \n\nIn addition to the free DNS offering, Openprovider also offers a [premium DNS service](https://support.openprovider.eu/hc/en-us/articles/4403130666386-Premium-DNS-Service-), which we have developed in collaboration with Sectigo. In order to create, retrieve, update or delete a premium zone just add the parameter \"provider\"=\"sectigo\" to any operation.\n\n# Create a zone\n\nUse the endpoint path below. Base URL is determined by both the target environment and API version.\n\n```\nPOST {base_url}/dns/zones\n```\n\n\n\n**REQUEST EXAMPLE**\n\n```bash\ncurl -X POST \\\n http://api.openprovider.eu/v1beta/zones \\\n -H 'Authorization: Bearer ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"domain\":\n {\n \"extension\": \"nl\",\n \"name\": \"op-demozone\"\n },\n \"type\": \"master\",\n \"records\":\n [\n {\n \"name\": \"WWW\",\n \"ttl\": \"900\",\n \"type\": \"A\",\n \"value\": \"1.2.3.4\"\n },\n {\n \"name\": \"ftp\",\n \"ttl\": \"900\",\n \"type\": \"CNAME\",\n \"value\": \"op-demozone.nl\"\n }\n ]\n}'\n```\n\n**REQUEST VALUES**\n\n| **Name** | **Type** | **Description** |\n| ------------- | ------------- | ------------------------------------------------------------ |\n| domain | string | **Required**. name of a zone (domain name) |\n| type | string | **Required.** master or slave |\n| master_ip | string | Optional. required for type = slave |\n| records | array of data | **Required** for master zones |\n| template_name | string | Optional. |\n| provider | string | set \"provider\" = \"sectigo\" to create a premium DNS zone. Note that there is an additional fee for this |\n| secured | boolean | Optional. Enable DNSSEC |\n| provider | string | Optional parameter. Set to \"sectigo\" to create a premium domain zone |\n\n**RESPONSE EXAMPLE**\n\n```json\n{\n \"code\":0,\n \"data\": {\n \t\"success\": true\n }\n}\n```\n\n# Searching for a zone\n\nIn the previous article we covered how to create a DNS zone. In this one let's look at how we can retrieve it.\n\nFor this purpose we're going to use [List Zones](https://docs.openprovider.com/doc/all#operation/ListZones) method. It returns information about an existing DNS zone object.\n\nUse the endpoint path below. Base URL is determined by both the target environment and API version.\n\n```\nGET {base_url}/dns/zones/\n```\n\n**REQUEST EXAMPLE**\n\n```bash\ncurl -X GET \\\n 'https://api.openprovider.eu/v1beta/dns/zones?name_pattern=domain' \\\n -H 'Authorization: Bearer ' \\\n```\n\n**REQUEST VALUES**\n\n| **Name** | **Type** | **Description** |\n| ------------ | -------- | ------------------------------------------------- |\n| limit | integer | Optional. default value: 100, maximum value: 1000 |\n| offset | integer | Optional. master or slave |\n| name_pattern | string | name of . |\n| type | string | **Required** for master zones |\n| with_records | boolean | Optional. default value: 0 |\n| with_history | boolean | Optional. default value: 0 |\n\n\n**RESPONSE EXAMPLE**\n\n```json\n{\n \"code\": 0,\n \"data\":\n {\n \"active\": 1,\n \"creation_date\": \"1328427448\",\n \"dnskey\": \"\",\n \"id\": 1,\n \"ip\": \"127.0.0.1\",\n \"is_deleted\": false,\n \"is_shadow\": false,\n \"is_spamexperts_enabled\": false,\n \"modification_date\": \"1543388225\",\n \"name\": \"domain.com\",\n \"reseller_id\": 1,\n \"type\": \"master\"\n },\n \"desc\": \"\"\n}\n```\n\n**RESPONSE VALUES**\n\n| **Name** | **Type** | **Description** |\n| ----------------- | --------- | --------------------------------------- |\n| type | string | |\n| name | string | |\n| ip | varchar | |\n| creation_date | timestamp | |\n| modification_date | timestamp | |\n| records | | Will be returned if with_records = true |\n| history | | Will be returned if with_history = true |\n\n## Retrieving a zone\n\nWith the [Get Zone](https://docs.openprovider.com/doc/all#operation/GetZone) method you can get data about an existing DNS zone object as well as its records.\n\nUse endpoint path below. Base URL is determined by both the target environment and API version.\n\n```\nGET {base_url}/dns/zones/{name}\n```\n\n**REQUEST EXAMPLE**\n\n```bash\ncurl -X GET \\\n https://api.openprovider.eu/v1beta/dns/zones/demo-domain.nl \\\n -H 'Accept: */*' \\\n -H 'Authorization: Bearer ' \\\n```\n\n**REQUEST VALUES**\n\n| **Name** | **Type** | **Description** |\n| ------------ | -------- | ------------------------------------------------- |\n| id | integer | Optional. default value: 100, maximum value: 1000 |\n| name | string | Name of the zone, in this case \"demo-domain.nl\" |\n| with_records | boolean | Optional. default value: 0 |\n| with_history | boolean | Optional. default value: 0 |\n| with_dnskey | boolean | Optional. default value: 0 |\n\n\n**RESPONSE EXAMPLE**\n\n```json\n{\n \"data\":\n {\n \"id\": 9146574,\n \"reseller_id\": 204661,\n \"type\": \"master\",\n \"name\": \"demo-domain.nl\",\n \"active\": 1,\n \"creation_date\": \"2019-06-27 06:22:36\",\n \"modification_date\": \"2019-06-27 06:22:36\"\n }\n}\n```\n\n\n\n# Modify a zone\n\nThere are two possible scenarios to consider when modifying a DNS zone:\n\n1. rewrite the whole object with new data\n2. add/delete or modify a select record\n\nUse endpoint path below. Base URL is determined by both the target environment and API version.\n\n```\nPUT {base_url}/dns/zones/{name}\n```\n\n**REQUEST EXAMPLE**\n\n```bash\ncurl -X PUT \\\n http://api.openprovider.eu/v1beta/dns/zones/domain.com \\\n -H 'Authorization: Bearer ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"domain\":\n [\n {\n \"extension\": \"com\",\n \"name\": \"domain\"\n }\n ],\n \"id\": 6574389,\n \"is_spamexperts_enabled\": true,\n \"master_ip\": \"127.0.0.1\",\"records\": {\n \"add\": [\n {\n \"name\": \"domain.com\",\n \"prio\": 1,\n \"ttl\": 900,\n \"type\": \"CNAME\",\n \"value\": \"abcd.domain.com\"\n }\n ],\n \"remove\": [\n {\n \"name\": \"domain.com\",\n \"prio\": 1,\n \"ttl\": 900,\n \"type\": \"CNAME\",\n \"value\": \"abcd.domain.com\"\n }\n ],\n \"replace\": [\n {\n \"name\": \"domain.com\",\n \"prio\": 1,\n \"ttl\": 900,\n \"type\": \"CNAME\",\n \"value\": \"abcd.domain.com\"\n }\n ],\n \"update\": [\n {\n \"original_record\": {\n \"name\": \"domain.com\",\n \"prio\": 1,\n \"ttl\": 900,\n \"type\": \"CNAME\",\n \"value\": \"abcd.domain.com\"\n },\n \"record\": {\n \"name\": \"domain.com\",\n \"prio\": 1,\n \"ttl\": 900,\n \"type\": \"CNAME\",\n \"value\": \"abcd.domain.com\"\n }\n }\n ]\n },\n \"name\": \"domain.com\"\n}'\n```\n\n**REQUEST VALUES**\n\n| **Name** | **Type** | **Description** |\n| ---------------------- | ---------------- | ------------------------------------------------------------ |\n| domain | array | Name and extension in a key-value array |\n| master_ip | varchar | Only required for slave zones |\n| records | array of objects | **Required**. [Array of record objects](https://docs.openprovider.com/doc/all#operation/UpdateZone) |\n| is_spamexperts_enabled | boolean | **Required** for master zones |\n\n**RESPONSE EXAMPLE**\n\n```\n{\n \"code\": 0,\n \"data\":\n {\n \"success\": true\n },\n \"desc\": \"\"\n}\n```\n\n**RESPONSE VALUES**\n\n| **Filed** | **Type** | **Records** |\n| --------- | --------- | ------------------------------------------------------------ |\n| type | string | A, AAAA, CNAME, MX, SPF, SRV, TXT, NS, TLSA, SSHFP, CAA |\n| name | string | The part of the hostname before the domain name; for example www or ftp |\n| value | varchar | The value of the record; depending on the type, certain restrictions apply; see the FAQ for these restrictions |\n| priority | timestamp | The priority of the record; required for MX records; ignored for all other record types |\n| TTL | timestamp | *Time To Live* of the record; this is a value in seconds Accepted values: 900, 3600, 10800, 21600, 43200, 86400. Inserting other values will result in 86400 being saved. |\n\n\n\n# Adding a single record\n\nIn order to add or update a single record it is necessary to utilize the \"add\" modifier.\nFor instance:\n\n**REQUEST EXAMPLE**\n\n```bash\ncurl -X PUT \\\n http://api.openprovider.eu/v1beta/dns/zones/domain.com \\\n -H 'Authorization: Bearer ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"id\": 6574389,\n \"name\": \"domain.com\",\n \"records\":\n {\n \"add\":\n [\n {\n \"ttl\": 900,\n \"type\": \"A\",\n \"value\": \"5.255.94.114\"\n }\n ]\n }\n}'\n```\n\n## Updating a single record\n\n**REQUEST EXAMPLE**\n\n```bash\ncurl -X PUT \\\n http://api.openprovider.eu/v1beta/dns/zones/domain.com \\\n -H 'Authorization: Bearer 2831a37fb8*******90b5aac822' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"id\": 6574389,\n \"name\": \"domain.com\",\n \"records\":\n {\n \"update\":\n [\n {\n \"original_record\":\n {\n \"prio\": 10,\n \"ttl\": 3600,\n \"type\": \"MX\",\n \"value\": \"test-mail.domain.com\"\n },\n \"record\":\n {\n \"prio\": 10,\n \"ttl\": 3600,\n \"type\": \"MX\",\n \"value\": \"mail.domain.com\"\n }\n }\n ]\n }\n}'\n```\n\n\n\n# Delete a zone\n\nThe name of the zone is the only thing that is required to perform this operation. Openprovider servers won't respond to queries for the zone or any of the records after you do this, and you cannot recover the deleted zone. \n\nUse endpoint path below. Base URL is determined by both the target environment and API version.\n\n```\nGET {base_url}/dns/zones/{name}\n```\n\n**REQUEST EXAMPLE**\n\n```json\ncurl -X DELETE \\\n 'https://api.openprovider.eu/v1beta/dns/zones/examplezonename.com' \\\n -H 'Authorization: Bearer 2831a37fb8*******90b5aac822' \\\n```\n\n**RESPONSE EXAMPLE**\n\n```json\n{\n\"code\": 0,\n\"data\": {\n\"success\": true\n},\n\"desc\": \"\"\n}\n```\n\n ", "name": "descDNSQuickstart", "x-displayName": "DNS Records", "x-traitTag": true }, { "description": "SSL certificates are the way to go to keep yourself and your customers safe. Keep your data secure, verify website ownership, prevent attackers from creating fake versions of your website and gain trust.\n\nSecurity is at the core of what we do and is one of the keys to succeed as a domain reseller. Want to find out more?\n [Watch our webinar](https://openprovider.com/how-to-succeed-as-a-domain-reseller/) and aim for the stars!\n\n## Search SSL products list\n\nDifferent products have a wide variety of options and are suitable for almost all use cases.\nThe search method allows you to retrieve a list of the products offered in the SSL Panel with their parameters and prices.\n\nUse the endpoint path below. Base URL is determined by both the target environment and API version.\n\n```\nGET {base_url}/ssl/products\n```\n\n**REQUEST VALUES**\n\n| **Name** | **Type** | **Values** | **Description** |\n| :---------------------- | :------- | :-------------------- | :----------------------------------------------------------- |\n| limit | numeric | Default: 0, Max: 1000 | The maximum number of records to be returned. |\n| offset | numeric | Default: 0 | Indicate the starting position of the response list. Indexing starts at 0, meaning that in order to start with the 10th certificate, this value would be 9. |\n| with_price | boolean | true or false | Include product price (for creation, payments for extra domains, etc.) in the response. Note that the warranty price will be displayed in any case. |\n| with_supported_software | boolean | true or false | Include a list of available platforms. |\n| with_description | boolean | true or false | Include the description for each product, if it exists. |\n\n\n\n**REQUEST EXAMPLE**\n\n```json\ncurl -X GET \\\n https://api.openprovider.eu/v1beta/ssl/products \\\n -H 'Authorization: Bearer ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"limit\": \"2\",\n \"offset\": \"1\",\n \"with_price\": \"true\",\n \"with_supported_software\": \"true\",\n \"with_description\": \"true\"\n}'\n```\n\n**RESPONSE EXAMPLE** \n\n```bash\n{\n \"code\": 0,\n \"data\":\n {\n \"results\":\n [\n {\n \"id\": 24,\n \"name\": \"EV SSL\",\n \"brand_name\": \"Comodo\",\n \"category\": \"extended_validation\",\n \"is_mobile_supported\": true,\n \"is_idn_supported\": false,\n \"is_sgc_supported\": false,\n \"is_wildcard_supported\": false,\n \"is_extended_validation_supported\": true,\n \"delivery_time\": \"within 1 day\",\n \"free_refund_period\": \"30d\",\n \"free_reissue_period\": \"lifetime\",\n \"max_period\": 2,\n \"number_of_domains\": 1,\n \"encryption\": \"40/256 bits\",\n \"root\": \"Chained root\",\n \"validation_method\": \"extended\",\n \"warranty\":\n {\n \"product\":\n {\n \"price\": 250000,\n \"currency\": \"USD\"\n },\n \"reseller\":\n {\n \"price\": 16286475,\n \"currency\": \"RUB\"\n }\n },\n \"bypass_san\": false,\n \"included_domains_count\": 1,\n \"max_domains\": 1,\n \"order_module\": \"comodo\"\n },\n {\n \"id\": 33,\n \"name\": \"EVSSL multi-domain\",\n \"brand_name\": \"Comodo\",\n \"category\": \"multi_domain\",\n \"sub_category\": \"extended_validation\",\n \"is_mobile_supported\": true,\n \"is_idn_supported\": false,\n \"is_sgc_supported\": false,\n \"is_wildcard_supported\": false,\n \"is_extended_validation_supported\": true,\n \"delivery_time\": \"within 1 day\",\n \"free_refund_period\": \"30d\",\n \"free_reissue_period\": \"lifetime\",\n \"max_period\": 2,\n \"number_of_domains\": 3,\n \"encryption\": \"40/256 bits\",\n \"root\": \"Chained root\",\n \"validation_method\": \"extended\",\n \"warranty\":\n {\n \"product\":\n {\n \"price\": 250000,\n \"currency\": \"USD\"\n },\n \"reseller\":\n {\n \"price\": 16286475,\n \"currency\": \"RUB\"\n }\n },\n \"bypass_san\": false,\n \"included_domains_count\": 3,\n \"max_domains\": 210,\n \"order_module\": \"comodo\"\n }\n ],\n \"total\": 30\n }\n}\n```\n\n**RESPONSE VALUES**\n\n| **Name** | **Values** | **Description** |\n| :----------------------------------------------------------- | :----------------- | :----------------------------------------------------------- |\n| code | result code number | API Result with code returned. 0 = Success with no errors. |\n| **1. data** | **set of values** | **Lists Products Response Data.** |\n| **1.1 results** | **array** | **Array of SSL Product parameters.** |\n| 1.1.1 brand_name | string | Product manufacturer brand. |\n| 1.1.2 bypass_san | boolean | Bypass SAN (Subject Alternative Name) (deprecated). |\n| 1.1.3 category | string | Product category: DV, OV, EV. |\n| 1.1.4 delivery_time | string | Average period of time between order creation and completion. |\n| 1.1.5 description | string | Marketing description (if it exist). |\n| 1.1.6 encryption | string | Indicates the encryption level of the root certificate (40/256 bits or 128/256 bits). |\n| 1.1.7 free_refund_period | string | The period during which cancellation of the product can be refunded |\n| 1.1.8 free_reissue_period | string | The period during which reissue is not charged |\n| 1.1.9 id | integer | Openprovider Product ID. |\n| 1.1.10 included_domains_count | integer | The included domains count. '-1' in a case of Wildcard product or 1,2,3 in a case of Single/Multidomain product. |\n| 1.1.11 is_extended_validation. Indicates if identifying the legal entity required. | | |\n| 1.1.12 is_idn are supported. | | |\n| 1.1.13 is_mobile_supported | boolean | If mobile devices are supported (deprecated). |\n| 1.1.14 is_sgc_supported | boolean | If Server Gated Cryptography supported (deprecated). |\n| 1.1.15 is_wildcard certificates. | | |\n| **1.2 level prices** | array | List of level prices. |\n| 1.2.1 level | integer | Price level. |\n| 1.2.2 name | string | Product name. |\n| **1.3 prices** | array | An array of SSL product prices. |\n| 1.3.1 extra domain price | set of values | The extra (additional) domain price. |\n| **1.3.1.1 product** | **set of values** | **SSL Product parameters and values.** |\n| 1.3.1.1.1 currency | string | Currency value. |\n| 1.3.1.1.2 price | number | Price amount. |\n| **1.3.1.2 reseller** | **set of values** | Indicates values returned for the current reseller. |\n| 1.3.1.2.1 currency | string | Type of currency. |\n| 1.3.1.2.2 price | number | Price value. |\n| 1.3.2 period | integer | Lifetime period in years |\n| 1.3.3 price | number | Price value. |\n| **1.3.3.1 product parameters and values.** | | |\n| 1.3.3.1.1 currency | string | Currency value. |\n| 1.3.3.1.2 price | number | Price amount. |\n| 1.3.3.2 reseller | | Indicates values returned for current reseller. |\n| 1.3.3.2.1 currency | string | Currency value. |\n| 1.3.3.2.2 price | number | Price value. |\n| max_domains | integer | Applies only to multi-domain certificates. Indicates the maximum number of additional domains which can be added |\n| max_period | integer | Maximal period of product lifetime. |\n| name | string | Product name. |\n| number_of_domains | integer | Indicates domain(s) quantity included in the regular price. Extends in a case of Multi-domain products but for an additional fee. |\n| order_module | | Indicates module that is related to the current product. |\n| **1.4. prices** | **array** | **Array of price parameters and values.** |\n| **1.4.1 extra_domain_price** | **set of values** | **Group of parameters indicating price for additional (extra) domains.** |\n| **1.4.1.1 product parameters and values.** | | |\n| 1.4.1.1.1 currency | string | Currency value. |\n| 1.4.1.1.2 price | number | Price value. |\n| **3.1.2 reseller** | **set of values** | **List of values actual for current reseller account.** |\n| 3.1.2.1 currency | string | Currency value. |\n| 3.1.2.2 price | number | Price value. |\n| period | integer | Lifetime period (in years, e.g. 1 or 2). |\n| 1.4.2 price | | Price value. |\n| **1.4.2.1 product parameters and values.** | | |\n| 1.4.2.1.1 currency | string | Currency value. |\n| 1.4.2.1.2 price | number | Price value. |\n| **1.4.2.2 reseller** | **set of values** | **List of values actual for the current reseller account.** |\n| 1.4.2.2.1 currency | string | Currency value. |\n| 1.4.2.2.2 price | number | Price value. |\n| root | string | Default: chained root. |\n| sub_category | string | A sub-category of the product (deprecated field). |\n| **1.5. supported_software** | **array** | An array of supported software: ID and title (Windows or/and Linux) |\n| 1.5.1 id | string | |\n| 1.5.2 title | string | Windows or Linux value. |\n| validation_method | string | Indicates the validation method required for certificate issuance (domain, organization or extended). |\n| **1.6 warranty. | | |\n| **1.6.1 product parameters and values.** | | |\n| 1.6.1.1 currency | string | Currency. |\n| 1.6.1.2 price | number | Price value. |\n| **1.6.2 reseller** | **set of values** | **List of values actual for a current reseller account.** |\n| 1.6.2.1 currency | string | Currency value. |\n| 1.6.2.2 price | number | Price value. |\n| total | integer | Total number of certificates in the product catalog |\n| desc | string | Description (if presented). |\n| maintenance | boolean | Indicates if Openprovider is under maintenance mode. |\n| **2. warnings** | **array** | **An array of warning messages.** |\n| 2.1 code | integer | Code value (digits). |\n| 2.2 data | string | Data value returned. |\n| 2.3 desc | string | Description value returned. |\n\nUsing the first request we retrieved the RapidSSL product and it's parameters.\nIf we are protecting a single domain and do not want to pass organization validation then RapidSSL would be a great choice. Please note there is one more similar method allowing retrieval of exact product data using Openprovider Product ID value.\n\n# Creating a CSR\n\nUsing the previous method we retrieved all appropriate \"RapidSSL\" product parameters.\n\n**Important**: once you have got the response you should store the returned value of the Private key. It will be required to set up the issued certificate on the server.\n\nUse the endpoint path below. Base URL is determined by both the target environment and API version.\n\n```\nPOST {base_url}/ssl/csr\n```\n\n**REQUEST VALUES**\n\n| **Name** | **Type** | **Values** | **Description** |\n| :---------------------- | :------- | :--------------------- | :----------------------------------------------------------- |\n| bits | integer | 2048 or 4096 | Current browsers should all support certs up to 4096. Advisories recommend 2048 for now. Security experts are projecting that 2048 bits will be sufficient for commercial use until around the year 2030. **Mandatory parameter.** |\n| common_name | string | Value of domain name | The domain name you going to protect. **Mandatory parameter.** |\n| country | string | two letters | Company country code. Check available codes. **Mandatory parameter.** |\n| email | string | Email address value | Requester email address (e.g. director@comany.com. **Mandatory parameter.** |\n| locality | string | Text address data | Company location, e.g. street name and number. |\n| organization | string | Text organization name | Organization name, use legal entity. |\n| signature_hash_algorithm | string | sha1'. | |\n| state | string | Text data | Used for locations with the state, but can be used as a city also. |\n| subject_alternative_name | string | Text data | Additional domains in the case of Multi-domain. |\n| unit | string | Text data | Organization unit, if empty could be left blank or 'IT' used. |\n| with_config | boolean | true or false | Config file for OpenSSL command dumped out when subjectAlternativeName domains are included. **Mandatory parameter.** |\n\n\n\n**REQUEST EXAMPLE**\n\n```json\ncurl -X POST \\\n https://api.openprovider.eu/v1beta/ssl/csr \\\n -H 'Authorization: Bearer ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"bits\": 2048,\n \"common_name\": \"ssl-123-domain.com\",\n \"country\": \"NL\",\n \"email\": \"admin@ssl-123-domain.com\",\n \"locality\": \"Haalem\",\n \"organization\": \"Openprovider B.V.\",\n \"signature_hash_algorithm\": \"sha2\",\n \"state\": \"Noord-Holland\",\n \"subject_alternative_name\":\n [\n \"www.ssl-123-domain.com\"\n ],\n \"unit\": \"IT\",\n \"with_config\": false\n}'\n```\n\n**RESPONSE EXAMPLE** \n\n```json\n{\n \"data\":\n {\n \"command\": \"openssl req -new -sha256-newkey rsa:2048 -nodes -config alt.names.cfg-out your.csr -keyout your.private.key-subj\\\"/C=NL/ST=Noord-Holland/L=Haalem/O=OpenproviderB.V./OU=IT/CN=ssl-123-domain.com/emailAddress=admin@ssl-123-domain.com\\\"\",\n \"key\": \"-----BEGIN PRIVATE KEY-----\\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDNUhGr0aSbrb42\\nC1bfvYzfbnDCR0PCYIqXsplAe4yx4EPTVa37ureKxZUMPhfVbsZRpPG9zxWSlpy\\nvMsF/mU47t4pCCCoG0pTkAk3wVHGsYwUFRj30PBBqrMAspkUkhjaF6NkbcykS8mE\\nkIHdam7a7Rx3lFwinauF4VmDKVERm+MtoaSiUKVAHEddivaXV2YZAc5i3cuu2bgW\\nkTFQfZ+JUJXAwzqFUd8Hf9GzbEK75q7t2xO6tNedaV7MaI2khcEs+7helaP8rWxE\\nuEBA6UI+/QD/1HcN2yF+lQV0hzL1s1wIigFf/CIB9dLpVb4C80tlwcDbZK8o+sxO\\naOv5if6JAgMBAAECggEBAJCTraXTZZnJ6hqcOXwrOTtLxVLIY8pHuM/BD3D8jsHi\\nLWBvAKg1fnDVWHMD68EV2T2fGQgNqAsLKE2K61s5G4XPjdhOxNAbB2d4EUWVd0P2\\nWbD6ei5mjgdvb8SZ/nkhtyY7Zu6c8nDufOQ/7XJAM/cs59K8QXSOme0YFbPqMA+4\\n9n1jD6XvoXDJKKaJu2kBJJWo4YBUposUoe5oLN6BhwbFJpMlHfiGYIf8xfWZCYyE\\nweRBBSi/vcQbpXxzve6jz4IT1Ag1TkjovrnGKZwZeaDGXjqWQEFAFcxpvHtZ9WXW\\no+ffHrEi1BbDKlzpJMKDzxvvrwfU9gCgc7nue2gsghECgYEA6WTmTv+gJS2gfRtV\\nsD/sYTqGm3x+ziScLP18P6c/BNNonkE87vcKDImKlomqQr16RV8HPKRKjT74cWkh\\naxKZJWT6q92EmL1SSeRJjUXfVrVNc0uSmMwtgpHl4I0FojftGaz8AA9LqQBWj1zC\\nbI+Jde9kmtssrJG5rS8/qnovV6sCgYEA4TUTCzTbBM6uJvfLJ2Tn+zkpWLQ7q8X0\\n9LmnxplBPIO8Fzo6gwrlDQ8i7j3Bj5hzNgzvs8vl3zd9og3RwvyaAeMDKtZESa0n\\nqB7yQ5Ova/rw3NlERWVhEodp+X7kMYcCt0KTI41Y0URqpXiKhZkWhokqQGMHUPSM\\nKhegbZhtvpsCgYEA5MzUdodkgG3tUhgU9baEzYApa44tZXtAW16YinIzdlCl09aS\\nnJUzlbzUTuVgMxM7JXyWRJ2utC8SMWPlrejKl30ZvJhpn66hV+zjKgpgesk7xxZD\\n/WTUDJdoqqy05CU9W5lYZdqYynGZaet+chx4nlPz5VeNwRMO2jdii4ZCmQcCgYBt\\naNqCpEAPWtWyqsmwrs4g98lFhfJDZl22EwgWbNgLrThQ1IIerclPid3/flMuDvNR\\n/ADsCY/43L2VYD9bCltLtV0Rj50Hai8M91PdTr93pycjNA595F2/obfzdRkpkpzY\\nKWjQadgPeryQ/TnW4+PUooi7VSD1zIjX3jibZeVTJwKBgEwHwKQo8XUP1PQ9ogPQ\\nLZQElwlzKrCuzIgYgAhxtohF/7mpohPg15SWgf6cztgUVka/jBObZV0tLnNykWU3\\n5wnF6rSUD4TECZLU0dA4o4Js8cXjnypFMAMfL6sxqCA1qVGLaZFiUcFYf8wA1IEP\\ndJ9rB7SWCEtiM53WVQrPLdkD\\n-----ENDPRIVATE KEY-----\\n\",\n \"csr\": \"-----BEGIN CERTIFICATE REQUEST-----MIIDNzCCAh8CAQAwgaUxCzAJBgNVBAYTAk5MMRYwFAYDVQQIEw1Ob29yZC1Ib2xsYW5kMQ8wDQYDVQQHEwZIYWFsZW0xGjAYBgNVBAoTEU9wZW5wcm92aWRlciBCLlYuMQswCQYDVQQLEwJJVDEbMBkGA1UEAxMSc3NsLTEyMy1kb21haW4uY29tMScwJQYJKoZIhvcNAQkBFhhhZG1pbkBzc2wtMTIzLWRvbWFpbi5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQD4t7KW7vJ8Zjw9xZMo1iU4ez7pdPPglmSNNRAkiJXzTda9cIYPjwxduUR7A8EsgxFT/jQ99Gmjyq85liSX45z88eT5a7f84alEfCuiMzZh9DUK6Y8nigATFnjOohJhkEXXay8K0fY7/DXD6dSqJYJkhqULedsvB64ofip00ab8PlgOkdphcLUxKOGcpt8xWpzgKpMTJJnmRVkI7rkikYAU7BWxtJ5tcg/lEFclruh/WUxeBH6qJMZ5xHZ2Z1EWLjiVGb6Mw+sYBUky4WDX9xefv2wl48dEA3opWR9evTL/8Omo7xDk3vN4nEOAl9cT8gidVHuA+YOLMczLLrhP8LRPAgMBAAGgTDBKBgkqhkiG9w0BCQ4xPTA7MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgXgMCEGA1UdEQQaMBiCFnd3dy5zc2wtMTIzLWRvbWFpbi5jb20wDQYJKoZIhvcNAQELBQADggEBAJVyt+D8BDxcQhuT4kOd8A2u0a+T0PAXX7uJcu1AkJr1gMS6tym118nmjXLilgSsL3IarRq21taUMoxlyZuXe38IztCBuUxpKiZz6Ltx5yUrQZaFNNOVsHNjXHe5oajVA1f7dmoIIa3E/fpeHpoPzbWdTv1bfMHuAfHIRqVuTHG78T4fJh4JFXfyHfVbLUN5wc9D7oPoamGOFSUZoY/HLwfGf1zJMqsF9HEreCVmhWGoIHknzKbIhe7sngzR1We3aafNAUOdQ3gov4okpEI8yurKRrGSSo1ZzWqiIew5qEkm6gNGAwVWYgZ0kgadXjJQEBdx6deZ4eJiaV7IwubPS78=-----END CERTIFICATE REQUEST-----\"\n }\n}\n```\n\n**RESPONSE VALUES**\n\n| **Name** | **Values** | **Description** |\n| :----------------------- | :------------------ | :--------------------------------------------------------- |\n| code | Result code number. | API Result with code returned. 0 = Success with no errors. |\n| **1. data** | **set of values** | Lists CSR Generator command response data. |\n| 1.1 command | string | OpenSSL. |\n| 1.2 csr Code output. | | |\n| 1.3 key generated below. | | |\n| desc | string | The description. |\n| maintenance | boolean | Indicates if Openprovider is under maintenance mode. |\n| **2. warnings** | **array** | **An array of warning messages** |\n| 2.1 code | integer | Code (digits). |\n| 2.2 data | string | Data returned. |\n| 2.3 desc | string | Description returned. |\n\nAfter we successfully created a CSR code we can submit SSL order requests.\n\n# Retrieving list of approver emails\n\nUsing the previous method we successfully generated a Certificate Signing Request \n\nThe next step is domain ownership. There are three ways to confirm your domain ownership. \n\nThe approver-email method allows you to retrieve a list of the possible email addresses that could be used to give email confirmation of domain ownership. Five email addresses are static (**admin**@..., **administrator**@..., **postmaster**@..., **hostmaster**@..., **webmaster**@...) and belong to the domain name you're protecting. Comodo products only accept one email address.\n\nDescribed below is how to retrieve a list of available values of approver emails.\nPlease note if your WHOIS contains any public email addresses, they will also be included in the response and can be used to confirm domain ownership.\n\nUse the endpoint path below. Base URL is determined by both the target environment and API version.\n\n```\nGET {base_url}/ssl/approver-emails?product_id={product_id}&domain={domain}\n```\n\n**REQUEST VALUES**\n\n| **Name** | **Type** | **Values** | **Description** |\n| :--------- | :------- | :----------------- | :--------------------------- |\n| product_id | integer | One or two digits. | Product. Check product list. |\n| domain | string | Domain name value. | Domain name value. |\n\n\n\n**REQUEST EXAMPLE**\n\n```bash\ncurl -X GET \\\n https://api.openprovider.eu/v1beta/ssl/approver-emails?domain=example.com&product_id=5 \\\n -H 'Authorization: Bearer ' \\\n -H 'Content-Type: application/json' \\\n```\n\n**RESPONSE EXAMPLE** \n\n```json\n{\n \"code\": 0,\n \"data\": [\n \"admin@example.com\",\n \"administrator@example.com\",\n \"postmaster@example.com\",\n \"hostmaster@example.com\",\n \"webmaster@example.com\"\n ],\n \"desc\": \"\"\n}\n```\n\n**RESPONSE VALUES**\n\n| **Name** | **Type** | **Description** |\n| :-------------- | :-------------- | :-------------------------------------------------------- |\n| code | integer | API Result with code returned. 0 = Sucess with no errors. |\n| data | array of string | An array of string. |\n| desc | string | The description. |\n| maintenance | boolean | Indicates if Openprovider is under maintenance mode. |\n| **1. warnings** | **An array** | **An array of warning messages.** |\n| 1.1 code | integer | Warning code value (digits). |\n| 1.2 data | string | Data (additional warning description) value returned. |\n| 1.3 desc | string | The description value returned. |\n\nOnce we are familiar with the list of approved email addresses and now move to next step by submitting our order creation request.\n\n# Creating SSL Order\n\nUsing the previous method we extracted one of the mandatory values - an approver email that can be used as one of the parameters of our creation request.\n\nAfter collecting all the required information for creating an SSL certificate order, let's check what we have:\n\n1. CSR\n2. Approver email address\n\nPlease note, one more action is required before submitting a request: you will need to provide a contact handle for the certificate owner\n\nThere are two ways to create an order:\n\n- send certificate request to the Certificate Authority (CA. To choose this variant you should send **start_provision = true**.\n- create certificate only in Openprovider without sending request to the CA with **start_provision = true**.\n\nUse the endpoint path below. Base URL is determined by both the target environment and API version.\n\n```\nPOST {base_url}/ssl/orders/\n```\n\n**REQUEST VALUES**\n\n| **Name** | **Type** | **Values** | **Description** |\n| :------------------------------- | :-------- | :-------------------------------------------------- | :----------------------------------------------------------- |\n| product_id | integer | Checklist of products ID order will be created for. | |\n| period | integer | 1 or 2 | Mandatory parameter. Period of the certificate lifetime. |\n| domain_amount | integer | | Optional parameter. The domains amount should be included. Required for the multi-domain certificates. If it is not provided will be set to the included_domains_count (check product description in case of start_provision = 0 and to the amount of the sent domains in case of start_provision = 1. |\n| csr | | | |\n| host_names | array | Array of strings | Optional parameter. Array of hostnames. This parameter is optional, and only allowed in combination with a multi domain SSL certificate, except for the common name. |\n| **1. domain_validation_methods** | **array** | | Optional parameter. Allows to select a specific method for Domain Validation. Hostnames in the array must be equal to hostnames specified in the request (commonName and SANs from the CSR. |\n| 1.1 host_name | string | | Mandatory parameter. Hostname specified in the request (commonName and SANs from the CSR. |\n| 1.2 method | string | https for more details. | |\n| approver_email | string | Email address. | Optional parameter. Valid email address (e.g. admin@example.com). |\n| signature_hash_algorithm | string | sha1 or leave blank as by default. | |\n| software_id | string | linux or windows. | Mandatory parameter. Software used on a host where the certificate will be installed. |\n| start_provision | boolean | true or false (default). | Optional parameter. If **false** then request won't be sent to CA (will stay in status PAI in a case of **true**. |\n| organization_handle | string | Handle. | |\n| technical_handle | string | Handle. | |\n| autorenew | string | \"on\" or \"off\" (default) | Indicates if the certificate should be automatically renewed (check renew process description. |\n\n\n\n**REQUEST EXAMPLE**\n\n```json\ncurl -X POST \\\n https://api.openprovider.eu/v1beta/ssl/orders \\\n -H 'Authorization: Bearer ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"approver_email\": \"admin@ssl-123-domain.com\",\n \"autorenew\": \"off\",\n \"csr\": \"-----BEGIN CERTIFICATE REQUEST-----\\nMIIDNzCCAh8CAQAwgaUxCzAJBgNVBAYTAk5MMRYwFAYDVQQIEw1Ob29yZC1Ib2xs\\nYW5kMQ8wDQYDVQQHEwZIYWFsZW0xGjAYBgNVBAoTEU9wZW5wcm92aWRlciBCLlYu\\nMQswCQYDVQQLEwJJVDEbMBkGA1UEAxMSc3NsLTEyMy1kb21haW4uY29tMScwJQYJ\\nKoZIhvcNAQkBFhhhZG1pbkBzc2wtMTIzLWRvbWFpbi5jb20wggEiMA0GCSqGSIb3\\nDQEBAQUAA4IBDwAwggEKAoIBAQD4t7KW7vJ8Zjw9xZMo1iU4ez7pdPPglmSNNRAk\\niJXzTda9cIYPjwxduUR7A8EsgxFT/jQ99Gmjyq85liSX45z88eT5a7f84alEfCui\\nMzZh9DUK6Y8nigATFnjOohJhkEXXay8K0fY7/DXD6dSqJYJkhqULedsvB64ofip0\\n0ab8PlgOkdphcLUxKOGcpt8xWpzgKpMTJJnmRVkI7rkikYAU7BWxtJ5tcg/lEFcl\\nruh/WUxeBH6qJMZ5xHZ2Z1EWLjiVGb6Mw+sYBUky4WDX9xefv2wl48dEA3opWR9e\\nvTL/8Omo7xDk3vN4nEOAl9cT8gidVHuA+YOLMczLLrhP8LRPAgMBAAGgTDBKBgkq\\nhkiG9w0BCQ4xPTA7MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgXgMCEGA1UdEQQaMBiC\\nFnd3dy5zc2wtMTIzLWRvbWFpbi5jb20wDQYJKoZIhvcNAQELBQADggEBAJVyt+D8\\nBDxcQhuT4kOd8A2u0a+T0PAXX7uJcu1AkJr1gMS6tym118nmjXLilgSsL3IarRq2\\n1taUMoxlyZuXe38IztCBuUxpKiZz6Ltx5yUrQZaFNNOVsHNjXHe5oajVA1f7dmoI\\nIa3E/fpeHpoPzbWdTv1bfMHuAfHIRqVuTHG78T4fJh4JFXfyHfVbLUN5wc9D7oPo\\namGOFSUZoY/HLwfGf1zJMqsF9HEreCVmhWGoIHknzKbIhe7sngzR1We3aafNAUOd\\nQ3gov4okpEI8yurKRrGSSo1ZzWqiIew5qEkm6gNGAwVWYgZ0kgadXjJQEBdx6deZ\\n4eJiaV7IwubPS78=\\n-----END CERTIFICATE REQUEST-----\",\n \"domain_amount\": 1,\n \"domain_validation_methods\":\n [\n {\n \"host_name\": \"ssl-123-domain.com\",\n \"method\": \"dns\"\n }\n ],\n \"organization_handle\": \"IA900531-NL\",\n \"period\": 1,\n \"product_id\": 5,\n \"signature_hash_algorithm\": \"sha2\",\n \"software_id\": \"linux\",\n \"start_provision\": false,\n \"technical_handle\": \"IA900531-NL\"\n}'\n```\n\n**RESPONSE EXAMPLE** \n\n```json\n{\n \"code\": 0,\n \"data\": {\n \"id\": 1\n },\n \"desc\": \"\"\n}\n```\n\n**RESPONSE VALUES**\n\n| **Name** | **Values** | **Description** |\n| :-------------- | :-------------------------------------------- | :----------------------------------------------------------- |\n| code | numeric value | API Result with code returned. 0 = Success with no errors. |\n| **1. data** | **SSL Create Order operation response data.** | **Set of values with data returned.** |\n| 1.1 id | Openprovider order ID. | Openprovider order number assigned to request. |\n| desc | Description string (if exist). | Description (if presented). |\n| maintenance | True or False. | The maintenance: True or False. |\n| **2. warnings** | **An array of warning messages.** | An array of boolean and string data returned if maintenance is in progress. |\n| 2.1 code | integer | Code value (digits). |\n| 2.2 data | string | Data value returned. |\n| 2.3 desc | string | The description value returned. |\n\nOnce we created our SSL Order in status PAI and we got from the response it's ID that is \"1\".\nUsing the next method we will retrieve our order with all data included.\n\n# Search SSL Orders\n\nUsing the previous method we created an order with the ID assigned: \"1\".\n\nUsing the current method we will retrieve all orders that are assigned with our reseller's account.\nYou can retrieve a full list of certificates you have in a system, either active or not, that have specific handle assigned or (and) by name pattern.\nTo get orders statuses updates immediately we would recommend you to use our webhook system\n\n\nUse the endpoint path below. Base URL is determined by both the target environment and API version.\n\n```\nGET {base_url}/ssl/orders\n```\n\n**REQUEST VALUES**\n\n| **Name** | **Type** | **Values** | **Description** |\n| :----------------------------------------------------------- | :------- | :--------------------------------------- | :----------------------------------------------------------- |\n| limit | integer | Min 0, Max 1000. | A number of records that will be returned in the output. |\n| offset | integer | Min 0. | The argument is used to identify the starting point to return records. |\n| order_by.[parameter] parameter: - common_name - order_date - status - active_date - expiration_date - product_name | string | asc/desc | Sorting order. |\n| common_name_pattern | string | domain name pattern | The pattern of domain common name. |\n| status | string | ACT, PAI, REQ, REJ, FAI, EXP | Current order status. |\n| contact_handle | string | One of the resellers handles (contacts). | Openprovider contact of the person assigned to an order (e.g. XY123456-ZW). |\n\n\n\n**REQUEST EXAMPLE**\n\n```bash\ncurl -X GET \\\n https://api.openprovider.eu/v1beta/ssl/orders?status=PAI&order_by.order_date=asc' \\\n -H 'Authorization: Bearer ' \n```\n\n**RESPONSE EXAMPLE** \n\n```json\n{\n \"code\": 0,\n \"data\":\n {\n \"results\":\n [\n {\n \"active_date\": \"2019-01-01 00:00:01\",\n \"additional_data\":\n [\n {\n \"dns_record\": \"ssl-123-domain.com\",\n \"dns_value\": \"0453ff12343c6d5e24466832668aa13658e5893c917b9486d7c59a57270 74c9c\",\n \"domain\": \"ssl-123-domain.com\",\n \"file_contents\": \"0453ff12343c6d5e24466832668aa13658e5893c917b9486d7c59a5 727074c9c\",\n \"file_location\": \"ssl-123-domain.com/.well-known/pki-validation /fileauth.txt\",\n \"md5\": \"73d01a1232214f96ebf08d6f9d0af6f9\",\n \"sha1\": \"0453ff12343c6d5e24466832668aa13658e5893c917b9486d7c59a5727074c9c\",\n \"sha256\": \"0453ff12343c6d5e24466832668aa13658e5893c917b9486d7c59a5727074c9 c\"\n }\n ],\n \"administrative_handle\": \"IA900531-NL\",\n \"autorenew\": \"off\",\n \"billing_handle\": \"IA900531-NL\",\n \"brand_name\": \"RapidSSL\",\n \"certificate\": \"\",\n \"common_name\": \"ssl-123-domain.com\",\n \"csr\": \"-----BEGIN CERTIFICATE REQUEST-----MIIDNzCCAh8CAQAwgaUxCzAJBgNVBAYTAk5MMRYwFAYDVQQIEw1Ob29yZC1Ib2xsYW5kMQ8wDQYDVQQHEwZIYWFsZW0xGjAYBgNVBAoTEU9wZW5wcm92aWRlciBCLlYuMQswCQYDVQQLEwJJVDEbMBkGA1UEAxMSc3NsLTEyMy1kb21haW4uY29tMScwJQYJKoZIhvcNAQkBFhhhZG1pbkBzc2wtMTIzLWRvbWFpbi5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQD4t7KW7vJ8Zjw9xZMo1iU4ez7pdPPglmSNNRAkiJXzTda9cIYPjwxduUR7A8EsgxFT/jQ99Gmjyq85liSX45z88eT5a7f84alEfCuiMzZh9DUK6Y8nigATFnjOohJhkEXXay8K0fY7/DXD6dSqJYJkhqULedsvB64ofip00ab8PlgOkdphcLUxKOGcpt8xWpzgKpMTJJnmRVkI7rkikYAU7BWxtJ5tcg/lEFclruh/WUxeBH6qJMZ5xHZ2Z1EWLjiVGb6Mw+sYBUky4WDX9xefv2wl48dEA3opWR9evTL/8Omo7xDk3vN4nEOAl9cT8gidVHuA+YOLMczLLrhP8LRPAgMBAAGgTDBKBgkqhkiG9w0BCQ4xPTA7MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgXgMCEGA1UdEQQaMBiCFnd3dy5zc2wtMTIzLWRvbWFpbi5jb20wDQYJKoZIhvcNAQELBQADggEBAJVyt+D8BDxcQhuT4kOd8A2u0a+T0PAXX7uJcu1AkJr1gMS6tym118nmjXLilgSsL3IarRq21taUMoxlyZuXe38IztCBuUxpKiZz6Ltx5yUrQZaFNNOVsHNjXHe5oajVA1f7dmoIIa3E/fpeHpoPzbWdTv1bfMHuAfHIRqVuTHG78T4fJh4JFXfyHfVbLUN5wc9D7oPoamGOFSUZoY/HLwfGf1zJMqsF9HEreCVmhWGoIHknzKbIhe7sngzR1We3aafNAUOdQ3gov4okpEI8yurKRrGSSo1ZzWqiIew5qEkm6gNGAwVWYgZ0kgadXjJQEBdx6deZ4eJiaV7IwubPS78=-----END CERTIFICATE REQUEST-----\",\n \"domain_validation_methods\":\n [\n {\n \"host_name\": \"ssl-123-domain.com\",\n \"method\": \"email\"\n }\n ],\n \"domain_validation_statuses\":\n {\n \"ca_operation\": \"request\",\n \"ca_order_status\": \"in_progress\",\n \"ca_status\": \"requested\",\n \"status\": \"open\"\n },\n \"email_approver\": \"admin@ssl-123-domain.com\",\n \"email_reissue\": \"admin@ssl-123-domain.com\",\n \"expiration_date\": \"2020-01-01 00:00:01\",\n \"features\": \"\",\n \"host_names\":\n [\n \"www.ssl-123-domain.com\"\n ],\n \"id\": 1306772,\n \"intermediate_certificate\": \"\",\n \"options\":\n {\n \"features\": \"\"\n },\n \"order_date\": \"2019-01-01 00:00:01\",\n \"organization_handle\": \"TH000001-NL\",\n \"period\": 1,\n \"product_id\": 5,\n \"product_name\": \"RapidSSL\",\n \"root_certificate\": \"\",\n \"software\": \"linux\",\n \"sslinhva_order_id\": \"11111111-1111-1111-1111-111111111111\",\n \"status\": \"REQ\",\n \"technical_handle\": \"IA900531-NL\",\n \"validation_method\": \"domain\",\n \"vendor_order_id\": 123456789,\n \"vendor_reference_id\": 123456789\n }\n ],\n \"total\": 10\n },\n \"desc\": \"\"\n}\n```\n\n**RESPONSE VALUES**\n\n| **Name** | **Values** | **Description** |\n| :----------------------------------------------------------- | :-------------------------------------------------- | :----------------------------------------------------------- |\n| code | Result code number. | API Result with code returned. 0 = Success with no errors. |\n| **1. data** | **SSL Orders list data.** | **Returns results with all required data.** |\n| **1.1 results** | **An array of results.** | **Returns order(s) data.** |\n| 1.1.1 active data | Date value with date stamp. | Date of order creation. |\n| **1.1.2 additional data** | **Array with additional data.** | **Useful information with validation values that should be added, file locations, etc.** |\n| 1.1.1.2.1 dns_record should be added to host. | | |\n| 1.1.1.2.2 dns_value | DNS values. | DNS values that should be added to host to process validation (e.g. random text string). |\n| 1.1.1.2.3 domain | Domain name as a string. | Domain hostname with what certificate is assigned with. |\n| 1.1.1.2.4 file_contents | File contents as a string. | File contents that should be added to the host (an e.g. random string of text). |\n| 1.1.1.2.5 file_location | File location as a string. | Indicates a location where the file should be added into an existing host. |\n| 1.1.1.2.6 md5 | MD5 checksum. | Order MD5 checksum. |\n| 1.1.1.2.7 sha1 checksum. | | |\n| 1.1.1.2.8 sha256 checksum. | | |\n| 1.1.2 administrative_handle. | | |\n| 1.1.3 autorenew | \"On\" or \"Off\" | If autorenew is enabled or not. |\n| 1.1.4 billing_handle. | | |\n| 1.1.5 brand_name | Certificate brand name (manufacturer). | Manufacturer string (e.g. Comodo or Symantec). |\n| 1.1.6 certificate | Certificate value (string). | Value of certificate. |\n| 1.1.7 common_name | Domain common name. | Domain value (e.g. example.com). |\n| 1.1.8 csr value returned. | | |\n| **1.2 domain_validation_methods** | **An array of SSL Order Domain Validation Methods** | |\n| 1.2.1 host_name | Domain name. | The hostname of the domain in Openprovider order. |\n| 1.2.2 method | Validation method value. | Validation method value (e.g. \"https\"). |\n| **1.3 domain_validation_statuses** | **Set of values returned.** | **Set of values related to the validation status of your order.** |\n| 1.3.1 ca. | | |\n| 1.3.2 ca. | | |\n| 1.3.3 ca_status | Certificate Authority order operation status. | Current status of order operation processing inside CA. |\n| 1.3.4 status | The string value of current status. | Current order status (closed or open). |\n| 1.4 email_approver | Email address value. | Email value of approver email. |\n| 1.5 email_reissue | Email address value. | Email value of email reissue approver. |\n| 1.6 expiration_date | Date of order expiration. | Certificate expiration date (date stamp format). |\n| 1.7 features | Product features. | Indicates product features (if presented). |\n| 1.8 host_names | An array of strings. | Host names. |\n| 1.9 id | Numberic value or Openprovider order ID. | E.g. 1306772. |\n| 1.10 intermediate_certificate is a certificate that used between the root and end-user certificate. | | |\n| **1.11 options** | **SSL Order options.** | |\n| 1.11.1 features | Features of the certificate. | The certificate features an optional parameter (if presented). |\n| 1.12 order_date | Date of order creation. | Indicates timestamp when the order was created. |\n| 1.13 organization_handle. | | |\n| 1.14 period | Period of a lifetime in years. | 1 or 2 years. |\n| 1.15 product_id ID used. | | |\n| 1.16 product_name | SSL Product name. | Product name (e.g. RapidSSL). |\n| 1.17 root_certificate as a string. | | |\n| 1.18 software | Windows or Linux. | Software used for server: e.g. Windows or Linux. |\n| 1.19 sslinhva_order_id | Internal Openprovider value. | Internal system Openprovider value of order. |\n| 1.20 status | ACT, PAI, REQ, REJ, FAI, EXP. | |\n| 1.21 technical_handle. | | |\n| 1.22 validation_method | Value as a string. | Validation method (e.g. \"domain\"). |\n| 1.23 vendor_order_id | Numeric value of internal order ID. | Internal vendor order ID (e.g. \"123456789\"). |\n| 1.24 vendor_reference_id | Numeric value of interbal vendor ID. | Internal vendor order ID (e.g. \"123456789\"). |\n| 2. total | Numeric value of total results stored in system. | Numeric value returned. |\n| desc | Description value as a string. | Description text returned (if presented). |\n| maintenance | True or False. | The maintenance: True or False. |\n| **warnings** | **An array of warning messages.** | ***\\*An array of boolean and string data returned\\**** **if Openprovider is under maintenance mode.** |\n| 2.1 code | Code digits. | Code value (digits). |\n| 2.2 data | Data values. | Data value returned. |\n| 2.3 desc | Description value. | Description value returned. |\n\n\n\n# Updating an SSL Order\n\nUsing the previous method we successfully retrieved our orders and details.\n\nBut what if you want to update the original parameter(s) of an order created but was not yet approved?\n\nThere are different cases to use this method:\n\n| SSL Order status | What can be updated |\n| ---------------- | ------------------------------------------------------------ |\n| PAI | All fields that are not connected with the product details, e.g. csr, organization_handle, etc. send start_provision = true if you want to send certificate request to the CA |\n| REQ | domain_validation_methods can be updated, e.g. change method from http to dns |\n| PAI, REQ, ACT | autorenew can be switched on/off |\n\nHowever, for the SSL order in status REQ approver email address value can be modified with the update approver email address method.\n\nUse the endpoint path below. Base URL is determined by both the target environment and API version.\n\n```\nPUT {base_url}/ssl/orders/{id}\n```\n\n**REQUEST VALUES**\n\n| **Name** | **Type** | **Values** | **Description** |\n| :--------------------------- | :----------------------------------------------------------- | :---------------------------------- | :----------------------------------------------------------- |\n| **id** | integer | | Mandatory field. Openprovider order ID. |\n| approver_email | string | Email address. | A valid email address from a pre-approved list. |\n| autorenew | string | on or off | Indicates if the certificate should be automatically renewed (check renew process description. |\n| csr value. | Certificate signing request including information regarding the further certificate. | | |\n| 1. domain_validation_methods | array | | Allows to select a specific method for Domain Validation. Hostnames in the array must be equal to hostnames specified in the request (commonName and SANs from the CSR and hostnames). |\n| 1.1 host_name | string | | Hostname specified in the request (commonName and SANs from the CSR and hostnames). |\n| 1.2 method | string | https | |\n| host_names | array | An array of strings. | Array of hostnames. This parameter is optional, and only allowed in combination with a multi domain SSL certificate. If passed, the hostnames in this parameter will override any hostnames in the CSR, except for the common name. |\n| organization_handle. | | | |\n| signature_hash_algorithm | string | sha1 (deprecated) or sha2 (default) | Deprecated functional, please ignore. Default is: \"sha2\". |\n| software_id | string | linux or windows. | Certificate software platform. Used if you changed your system configuration from Linux to Windows Server and vice versa. |\n| start_provision | boolean | true or false (default) | If **false** then order won't be sent to CA. To request it use **true** value. |\n| technical_handle. | | | |\n\n\n\n\n\n**REQUEST EXAMPLE**\n\n```json\ncurl -X PUT \\\n https://api.openprovider.eu/v1beta/ssl/orders/31027 \\\n -H 'Authorization: Bearer ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"approver_email\": \"admin@ssl-123-domain.com\",\n \"autorenew\": \"on\",\n \"csr\": \"-----BEGIN CERTIFICATE REQUEST-----\\nMIIDNzCCAh8CAQAwgaUxCzAJBgNVBAYTAk5MMRYwFAYDVQQIEw1Ob29yZC1Ib2xs\\nYW5kMQ8wDQYDVQQHEwZIYWFsZW0xGjAYBgNVBAoTEU9wZW5wcm92aWRlciBCLlYu\\nMQswCQYDVQQLEwJJVDEbMBkGA1UEAxMSc3NsLTEyMy1kb21haW4uY29tMScwJQYJ\\nKoZIhvcNAQkBFhhhZG1pbkBzc2wtMTIzLWRvbWFpbi5jb20wggEiMA0GCSqGSIb3\\nDQEBAQUAA4IBDwAwggEKAoIBAQD4t7KW7vJ8Zjw9xZMo1iU4ez7pdPPglmSNNRAk\\niJXzTda9cIYPjwxduUR7A8EsgxFT/jQ99Gmjyq85liSX45z88eT5a7f84alEfCui\\nMzZh9DUK6Y8nigATFnjOohJhkEXXay8K0fY7/DXD6dSqJYJkhqULedsvB64ofip0\\n0ab8PlgOkdphcLUxKOGcpt8xWpzgKpMTJJnmRVkI7rkikYAU7BWxtJ5tcg/lEFcl\\nruh/WUxeBH6qJMZ5xHZ2Z1EWLjiVGb6Mw+sYBUky4WDX9xefv2wl48dEA3opWR9e\\nvTL/8Omo7xDk3vN4nEOAl9cT8gidVHuA+YOLMczLLrhP8LRPAgMBAAGgTDBKBgkq\\nhkiG9w0BCQ4xPTA7MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgXgMCEGA1UdEQQaMBiC\\nFnd3dy5zc2wtMTIzLWRvbWFpbi5jb20wDQYJKoZIhvcNAQELBQADggEBAJVyt+D8\\nBDxcQhuT4kOd8A2u0a+T0PAXX7uJcu1AkJr1gMS6tym118nmjXLilgSsL3IarRq2\\n1taUMoxlyZuXe38IztCBuUxpKiZz6Ltx5yUrQZaFNNOVsHNjXHe5oajVA1f7dmoI\\nIa3E/fpeHpoPzbWdTv1bfMHuAfHIRqVuTHG78T4fJh4JFXfyHfVbLUN5wc9D7oPo\\namGOFSUZoY/HLwfGf1zJMqsF9HEreCVmhWGoIHknzKbIhe7sngzR1We3aafNAUOd\\nQ3gov4okpEI8yurKRrGSSo1ZzWqiIew5qEkm6gNGAwVWYgZ0kgadXjJQEBdx6deZ\\n4eJiaV7IwubPS78=\\n-----END CERTIFICATE REQUEST-----\",\n \"domain_validation_methods\":\n [\n {\n \"host_name\": \"ssl-123-domain.com\",\n \"method\": \"http\"\n }\n ],\n \"host_names\":\n [\n \"ssl-123-domain.com\"\n ],\n \"organization_handle\": \"IA900531-NL\",\n \"signature_hash_algorithm\": \"sha2\",\n \"software_id\": \"windows\",\n \"start_provision\": true,\n \"technical_handle\": \"IA900531-NL\"\n}'\n```\n\n**RESPONSE EXAMPLE** \n\n```json\n{\n\"code\": 0,\n\"data\": {\n\"id\": 1\n},\n\"desc\": \"\"\n}\n```\n\n**RESPONSE VALUES**\n\n| **Name** | **Values** | **Description** |\n| :-------------- | :------------------------------------------ | :----------------------------------------------------------- |\n| code | API code returned. | **API Result with code returned. 0 = Sucess with no errors.** |\n| 1. data | Update Order Response Data | Response data returned while updating the order. |\n| 1.1 id | Digital value usually consists of 6 digits. | Openprovider order ID. |\n| desc | Description text (if presented). | Description (if presented). |\n| maintenance | Boolean parameter: True or False. | The Maintenance: True or False. |\n| **2. warnings** | An array of warning messages | Warning data returned while updating the order. |\n| 2.1 code | Numeric code if warning(s) detected. | Code value (digits). |\n| 2.2 data | Warning data values. | Data value returned. |\n| 2.3 desc | Description of warnings. | The description value returned. |\n\n \n\nNow we have updated our order and sent request to the CA.\nIn the next method, we will try to update the approver email because that help you if you no longer have an access to initial email used when submitted an order in a case if you used email domain validation method.\n\n# Updating an approver email address\n\nUsing the previous method we successfully changed a few details in our order and has requested it (sent to the CA).\n\nUse current method to change approver email address for an SSL order in \"REQ\" status.\nIt helps to change an email address of a person who will approve certificate issuance. Validation email will be resent automatically by the CA to the new address.\n\nValidation email sent by the issuing CA will contain a URL needs to be followed.\n\nUse the endpoint path below. Base URL is determined by both the target environment and API version.\n\n```\nPUT {base_url}/ssl/orders/{id}\n```\n\n**REQUEST VALUES**\n\n| **Name** | **Type** | **Values** | **Description** |\n| :------------- | :------- | :------------------ | :------------------------------------------ |\n| approver_email | string | email address value | Valid email address from pre-approved list. |\n\n\n\n**REQUEST EXAMPLE**\n\n```bash\ncurl -X PUT \\\n https://api.openprovider.eu/v1beta/ssl/orders/31027 \\\n -H 'Authorization: Bearer ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"approver_email\": \"webmaster@ssl-123-domain.com\"\n}'\n```\n\n**RESPONSE EXAMPLE** \n\n```json\n{\n \"code\": 0,\n \"data\": {\n \"id\": 1\n },\n \"desc\": \"\"\n}\n```\n\n**RESPONSE VALUES**\n\n| **Name** | **Values** | **Description** |\n| :-------------- | :----------------------------------------------- | :----------------------------------------------------------- |\n| code | API code returned. | API Result with code returned**.** **0 = Success with no errors.** |\n| **1. data** | **Update Approver Email Address Response Data.** | **Response data returned while updating the approver email address.** |\n| 1.1 id | Digital value usually consists of 6 digits. | Openprovider order ID. |\n| desc | Description text (if presented). | Description (if presented). |\n| maintenance | Boolean parameter: True or False. | Indicates if Openprovider is under maintenance mode. |\n| **2. warnings** | **An array of warning messages.** | **Warning data returned while updating the order.** |\n| 2.1 code | Numeric code if warning(s) detected. | Code value (digits). |\n| 2.2 data | Warning data values. | Data value returned. |\n| 2.3 desc | Description of warnings. | Description value returned. |\n\nYou can resend an approver email without updating an email also, check the next method:\n\n# Resending an approver email\n\nUsing the previous method we successfully changed the email address to which the certificate approval email would be sent.\n\nThis method allows us to resend the approval email to the current list of approver email addresses.\n\nUse the endpoint path below. Base URL is determined by both the target environment and API version.\n\n```\nPOST {base_url}/ssl/orders/{id}/approver-email/resend\n```\n\n**REQUEST VALUES**\n\n| **Name** | **Type** | **Values** | **Description** |\n| :------- | :------- | :------------ | :--------------------- |\n| id | integer | numeric value | Openprovider Order ID. |\n\n\n\n**REQUEST EXAMPLE**\n\n```bash\ncurl -X POST \\\n https://api.openprovider.eu/v1beta/ssl/orders/31027/approver-email/resend \\\n -H 'Authorization: Bearer ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"id\": 31027\n}'\n```\n\n**RESPONSE EXAMPLE** \n\n```json\n{\n \"code\": 0,\n \"data\": {\n \"id\": 1\n },\n \"desc\": \"\"\n}\n```\n\n**REQUEST VALUES**\n\n| **Name** | **Values** | **Description** |\n| :-------------- | :----------------------------- | :---------------------------------------------------------- |\n| code | Result code number. | API Result with code returned. 0 = Success with no errors. |\n| **1. data** | **Set of values.** | **Resend Approver Emai Response Data.** |\n| 1.1 id | Integer value returned. | Openprovider Order ID. |\n| desc | Text data response. | Description as string value. |\n| maintenance | True or False. | Maintenance: True or False. |\n| **2. warnings** | An array of possible warnings. | An array of warning messages |\n| 2.1 code | Integer value. | Numeric code value returned (if presented). |\n| 2.2 data | String value. | Additional warning message (if presented). |\n| 2.3 desc | String value. | Warning description (if presented). |\n\nUsing this simple method we are aware of how to resent approver email, often can be your company have changed (e.g. department, from \"IT\" to \"Financial).\nUse the following method if you want to change some details in an already activated certificate.\n\n# Reissuing SSL Certificate\n\nCertificate.\n\nThe parameters needed to start reissue are described below.\n\nUse the endpoint path below. Base URL is determined by both the target environment and API version.\n\n```\nPOST {base_url}/ssl/orders/{id}/reissue \n```\n\n**REQUEST VALUES**\n\n| **Name** | **Type** | **Values** | **Description** |\n| :------------------------------- | :-------- | :---------------------------------------- | :---------------------------------------------------- |\n| id | integer | numeric value | Mandatory field. Openprovider order ID. |\n| approver_email | string | Email address. | Valid email address. (e.g. admin@example.com). |\n| csr | | | |\n| **1. domain_validation_methods** | **array** | **SSL Order reissue validation methods.** | **The domain validation methods** **(e.g. domain).** |\n| 1.1 host_name | string | Hostname. | Hostname returned (e.g. \"example.com\"). |\n| 1.2 method | string | Validation method of SSL Certificate. | |\n| host_names | array | An array of string. | Array of string (hostnames e.g. \"www.example.com\"). |\n| organization_handle. | | | |\n| signature_hash_algorithm | string | sha1\" will be used by default. | |\n| software_id | string | Linux or Windows. | A software platform used for installation. |\n\n\n\n**REQUEST EXAMPLE**\n\n```bash\ncurl -X POST \\\n https://api.openprovider.eu/v1beta/ssl/csr \\\n -H 'Authorization: Bearer ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"approver_email\": \"admin@ssl-123-domain.com\",\n \"csr\": \"-----BEGIN CERTIFICATE REQUEST-----\\nMIIDNzCCAh8CAQAwgaUxCzAJBgNVBAYTAk5MMRYwFAYDVQQIEw1Ob29yZC1Ib2xs\\nYW5kMQ8wDQYDVQQHEwZIYWFsZW0xGjAYBgNVBAoTEU9wZW5wcm92aWRlciBCLlYu\\nMQswCQYDVQQLEwJJVDEbMBkGA1UEAxMSc3NsLTEyMy1kb21haW4uY29tMScwJQYJ\\nKoZIhvcNAQkBFhhhZG1pbkBzc2wtMTIzLWRvbWFpbi5jb20wggEiMA0GCSqGSIb3\\nDQEBAQUAA4IBDwAwggEKAoIBAQD4t7KW7vJ8Zjw9xZMo1iU4ez7pdPPglmSNNRAk\\niJXzTda9cIYPjwxduUR7A8EsgxFT/jQ99Gmjyq85liSX45z88eT5a7f84alEfCui\\nMzZh9DUK6Y8nigATFnjOohJhkEXXay8K0fY7/DXD6dSqJYJkhqULedsvB64ofip0\\n0ab8PlgOkdphcLUxKOGcpt8xWpzgKpMTJJnmRVkI7rkikYAU7BWxtJ5tcg/lEFcl\\nruh/WUxeBH6qJMZ5xHZ2Z1EWLjiVGb6Mw+sYBUky4WDX9xefv2wl48dEA3opWR9e\\nvTL/8Omo7xDk3vN4nEOAl9cT8gidVHuA+YOLMczLLrhP8LRPAgMBAAGgTDBKBgkq\\nhkiG9w0BCQ4xPTA7MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgXgMCEGA1UdEQQaMBiC\\nFnd3dy5zc2wtMTIzLWRvbWFpbi5jb20wDQYJKoZIhvcNAQELBQADggEBAJVyt+D8\\nBDxcQhuT4kOd8A2u0a+T0PAXX7uJcu1AkJr1gMS6tym118nmjXLilgSsL3IarRq2\\n1taUMoxlyZuXe38IztCBuUxpKiZz6Ltx5yUrQZaFNNOVsHNjXHe5oajVA1f7dmoI\\nIa3E/fpeHpoPzbWdTv1bfMHuAfHIRqVuTHG78T4fJh4JFXfyHfVbLUN5wc9D7oPo\\namGOFSUZoY/HLwfGf1zJMqsF9HEreCVmhWGoIHknzKbIhe7sngzR1We3aafNAUOd\\nQ3gov4okpEI8yurKRrGSSo1ZzWqiIew5qEkm6gNGAwVWYgZ0kgadXjJQEBdx6deZ\\n4eJiaV7IwubPS78=\\n-----END CERTIFICATE REQUEST-----\",\n \"domain_validation_methods\":\n [\n {\n \"host_name\": \"ssl-123-domain.com\",\n \"method\": \"dns\"\n }\n ],\n \"id\": 1,\n \"organization_handle\": \"IA900531-NL\",\n \"signature_hash_algorithm\": \"sha2\",\n \"software_id\": \"linux\"\n}'\n```\n\n**RESPONSE EXAMPLE** \n\n```json\n{\n \"code\": 0,\n \"data\": {\n \"id\": 1\n },\n \"desc\": \"\"\n}\n```\n\n**RESPONSE VALUES**\n\n| **Name** | **Values** | **Description** |\n| :-------------- | :----------------------------------- | :----------------------------------------------------------- |\n| **code** | **numeric** | **API Result with code returned.** **0 = Success with no errors.** |\n| data | An array of elements | Allowed addresses. |\n| desc | Description text (if presented). | Description (if presented). |\n| maintenance | Boolean parameter: True or False. | Indicates if Openprovider is under maintenance mode. |\n| **1. warnings** | **An array of warning messages** | **Warning data returned after the request processed.** |\n| 1.1 code | Numeric code if warning(s) detected. | Code value (digits). |\n| 1.2 data | Warning data values. | Data value returned. |\n| 1.3 desc | Description of warnings. | The description value returned. |\n\nWe submitted a reissue request and it again has status REQ. When the reissue process is finished the status of the certificate will be ACT. Let us prolong our certificate lifetime using the next method\n\n# Renewing SSL Certificate\n\nRenewal is a process of extending a certificate expiration date. It is available for the certificates in status ACT and can be requested within the 30 days before expiration date.\nThe price for the renew is the same as for the create operation (prices are already retrieved.\nRenewal vice versa reissue does not change any certificate data except the expiration date.\nIt will be extended to the same period we selected while used order creation.\n\nYou can't change any certificate data during the renew process. So if you need it - you can just request\n a new certificate. \n\nOur advice is to start the new order at least 4 weeks before the current SSL certificate. That means that if you have expiration date of the 1 year certificate 01.05.2019 and requested renew at 01.04.2019 the expiration date of the renewed certificate will still be 01.05.2020.\n\nPlease note renewal is applicable for certificates that are active and not yet expired.\n\nUse the endpoint path below. Base URL is determined by both the target environment and API version.\n\n```\nPOST {base_url}/ssl/orders/{id}/renew\n```\n\n**REQUEST VALUES**\n\n| **Name** | **Type** | **Values** | **Description** |\n| :------- | :------- | :------------ | :--------------------- |\n| id | integer | numeric value | Openprovider Order ID. |\n\n\n\n**REQUEST EXAMPLE**\n\n```bash\ncurl -X POST \\\n https://api.openprovider.eu/v1beta/ssl/orders/1/renew \\\n -H 'Authorization: Bearer ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n\"id\":\"1\"\n}'\n```\n\n**RESPONSE EXAMPLE** \n\n```json\n{\n \"code\": 0,\n \"data\": {\n \"id\": 1\n },\n \"desc\": \"\"\n}\n```\n\n**RESPONSE VALUES**\n\n| **Name** | **Values** | **Description** |\n| :-------------- | :------------------------------------------ | :----------------------------------------------------------- |\n| code | result code number | **API Result with code returned. 0 = Success with no errors.** |\n| **1. data** | **set of values** | **Renew Order Response Data.** |\n| 1.1 id | integer | Returns Openprovider order ID that been processed. |\n| desc | string | Description text value (if available). |\n| maintenance | True or false. | Indicates if system maintenance is in progress now. |\n| **2. warnings** | **An array of numeric value and string(s)** | **An array of warning messages.** |\n| 2.1 code | numeric code returned | Warning numeric code returned (if available). |\n| 2.2 data | string | Additional warning description. |\n| 2.3 desc | string | Warning description. |\n\nWe checked how we can easily renew our certificate.\n\n# Provide access to end users\n\nYou can provide access for a particular order to your end user by generating a URL and token. The generated link directs the user to the SSL Panel. The link will expire after a short time.\n\nCustomer will see the SSL Panel with their order opened.\n\nYou can read more about this functionality in the Openprovider Knowledge base\n\nUse the endpoint path below. Base URL is determined by both the target environment and API version.\n\n```\nPOST {base_url}/ssl/orders/{id}/otp-tokens\n```\n\n\n\n**REQUEST VALUES**\n\n| **Name** | **Type** | **Values** | **Description** |\n| :------- | :------- | :------------ | :--------------------- |\n| id | string | numeric value | Openprovider Order ID. |\n\n\n\n**REQUEST EXAMPLE**\n\n```bash\ncurl -X POST \\\n https://api.openprovider.eu/v1beta/ssl/orders/31234/otp-tokens \\\n -H 'Authorization: Bearer ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"id\": 1\n}'\n```\n\n**RESPONSE EXAMPLE** \n\n```json\n{\n \"code\": 0,\n \"data\": {\n \"uri\": \"http://sslinhva.openprovider.eu/auth-order-otp-token\",\n \"token\": \"RxFs3X_We6V12m0toZxmNuakfNm999BI\",\n \"expire_at\": \"2019-06-28 21:11:11\"\n \"desc\": \"\"\n}\n```\n\n**RESPONSE VALUES**\n\n| **Name** | **Values** | **Description** |\n| :-------------- | :-------------------- | :----------------------------------------------------------- |\n| code | numeric | API Result with code returned. 0 = Success with no errors. |\n| **1. data** | **set of values** | **Cancel Order Response Data.** |\n| 1.1 expire_at | integer | Link expiration date. |\n| 1.2 token | string | Individual token. |\n| 1.3 uri | string | Individual link. |\n| desc | string | Description. |\n| maintenance | True or False. | The maintenance: True or False. |\n| **2. warnings** | **Array of elements** | ***\\*An array of boolean and string data returned\\**** **if Openprovider is under maintenance mode.** |\n| 2.1 code | code digits | Warning code digits. |\n| 2.2 data | string | Data value returned. |\n| 2.3 desc | string | Description value returned. |\n\n\n\nWe successfully generated a link for an order and can provide it to end-user where customer could track status of an order, change validation methods (if certificate yet not active), communicate with CA personnel etc.\nIf you or your customer no longer needs a certificate it can be canceled \n\n# Canceling an SSL Order\n\nUsing the previous method we shared access to the SSL panel to our end user.\nAfter we moved through a process of creating, renewing, modifying, and reissuing a certificate, the time has come to check how cancellation can be processed.\n\nCancellation is the process of voiding your SSL order request, no matter whether it's active or not. Certificate will pass revocation at the CA side and resource used certificate will no longer be protected.\nPlease note cancellation is fully refunded if processed within 30 days after the certificate became \"ACT\".\n\nUse the endpoint path below. Base URL is determined by both the target environment and API version.\n\n```\nPOST {base_url}/ssl/orders/{id}/cancel \n```\n\n\n\n**REQUEST VALUES**\n\n| **Name** | **Type** | **Values** | **Description** |\n| :------- | :------- | :------------ | :--------------------- |\n| id | string | numeric value | Openprovider Order ID. |\n\n\n\n**REQUEST EXAMPLE**\n\n```bash\ncurl -X POST \\\n https://api.openprovider.eu/v1beta/ssl/orders/1/cancel \\\n -H 'Authorization: Bearer ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"id\": \"1\"\n}'\n```\n\n**RESPONSE EXAMPLE** \n\n```json\n{\n \"code\": 0,\n \"data\": {\n \"id\": 1\n },\n \"desc\": \"\"\n}\n```\n\n**RESPONSE VALUES**\n\n| **Name** | **Values** | **Description** |\n| :-------------- | :------------------------ | :----------------------------------------------------------- |\n| code | numeric | API Result with code returned. 0 = Success with no errors. |\n| **1. data** | **set of values** | **Cancel Order Response Data.** |\n| 1.1 id | integer | Returns Openprovider order ID that been processed. |\n| desc | string | Description (if available). |\n| maintenance | True or False | The Maintenance: True or False. |\n| **2. warnings** | **An array of elements.** | ***\\*An array of boolean and string data returned\\**** **if Openprovider is under maintenance mode.** |\n| 2.1 code | digits | Warning code digits. |\n| 2.2 data | string | Data value returned. |\n| 2.3 desc | string | The description value returned. |\n\nPlease note order changes status from \"Active\" to \"Canceled\" within 24 hrs.\nCanceled order remains in \"FAI\" status and cannot be reactivated.", "name": "descSSLQuickstart", "x-displayName": "SSL Certificates", "x-traitTag": true }, { "name": "InvoiceService", "x-displayName": "Invoice" }, { "name": "NameserverService", "x-displayName": "Nameserver" }, { "name": "NsGroupService", "x-displayName": "NsGroup" }, { "name": "TemplateService", "x-displayName": "Template" }, { "name": "ZoneService", "x-displayName": "Zone" }, { "name": "ZoneRecordService", "x-displayName": "ZoneRecord" }, { "name": "DomainService", "x-displayName": "Domain" }, { "name": "DomainPriceService", "x-displayName": "DomainPrice" }, { "name": "TldService", "x-displayName": "Tld" }, { "name": "LicenseService", "x-displayName": "License" }, { "name": "ContactService", "x-displayName": "Contact" }, { "name": "ResellerService", "x-displayName": "Reseller" }, { "name": "TagService", "x-displayName": "Tag" } ], "x-tagGroups": [ { "name": "Introduction", "tags": [ "descAbout", "descGettingStarted", "descEndpoints", "descAuthentication" ] }, { "name": "Quick Start", "tags": [ "descCustomerQuickstart", "descDomainQuickstart", "descTLDQuickstart", "descDNSQuickstart", "descSSLQuickstart" ] }, { "name": "Auth", "tags": [ "Auth", "SpamExpert" ] }, { "name": "Billing", "tags": [ "InvoiceService", "Payment", "Transaction" ] }, { "name": "DNS", "tags": [ "DomainToken", "NameserverService", "NsGroupService", "TemplateService", "ZoneService", "ZoneRecordService" ] }, { "name": "Domain", "tags": [ "DomainService", "AdditionalData", "CustomerAdditionalData", "DomainPriceService", "AuthCode", "TldService" ] }, { "name": "EasyDmarc", "tags": [ "EasydmarcOrder" ] }, { "name": "Email template", "tags": [ "Email" ] }, { "name": "License", "tags": [ "LicenseService" ] }, { "name": "Reseller/Customer", "tags": [ "ContactService", "Customer", "EmailVerification", "ResellerService", "Settings", "Statistics", "TagService" ] }, { "name": "Spam Experts", "tags": [ "SEDomain" ] }, { "name": "SSL", "tags": [ "ApproverEmail", "Csr", "Order", "OrderApproverEmail", "OtpToken", "Product" ] } ] }