{
"openapi": "3.1.0",
"info": {
"title": "Domain Forward APIs",
"description": "Domain forwarding: activate, configure, retrieve, and remove forwarding rules\nfor domain orders.\n",
"version": "2.0.0"
},
"servers": [
{
"url": "https://api.sandbox.resellerclub.com/v2",
"description": "Sandbox"
},
{
"url": "https://api.resellerclub.com/v2",
"description": "Live"
}
],
"security": [
{
"apiKeyAuth": [],
"userIdHeader": []
}
],
"paths": {
"/orders/{orderId}/domain-forward": {
"get": {
"tags": [
"APIs"
],
"summary": "Get domain forwarding configuration",
"description": "Gets details of the Domain Forwarding service.",
"operationId": "getDomainForwardService",
"parameters": [
{
"name": "orderId",
"in": "path",
"description": "Order Id for which details of the Domain Forwarding service need to be fetched",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "includeSubdomain",
"in": "query",
"description": "The sub-domain for which details of the Domain Forwarding service need to be fetched",
"required": false,
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/GetDomainForwardServiceResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/GenericResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/GenericResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/GenericResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/GenericResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/GenericResponse"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/GenericResponse"
}
}
}
}
},
"x-v2-response-schema": "GetDomainForwardServiceResponse"
},
"put": {
"tags": [
"APIs"
],
"summary": "Update domain forwarding settings",
"description": "Returns the result of updating domain forwarding settings.",
"operationId": "updateDomainForwardService",
"parameters": [
{
"name": "orderId",
"in": "path",
"description": "Order Id for which settings of the Domain Forwarding service needs to be updated",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateDomainForwardRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/UpdateDomainForwardServiceResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/GenericResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/GenericResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/GenericResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/GenericResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/GenericResponse"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/GenericResponse"
}
}
}
}
},
"x-v2-response-schema": "UpdateDomainForwardServiceResponse"
},
"post": {
"tags": [
"APIs"
],
"summary": "Activate domain forwarding for an order",
"description": "This API call can be used to Activate and Manage the Domain Forwarding service.",
"operationId": "activateDomainForwardService",
"parameters": [
{
"name": "orderId",
"in": "path",
"description": "The Order Id for which Domain Forwarding service needs to be activated",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActivateDomainForwardRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ActivateDomainForwardServiceResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/GenericResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/GenericResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/GenericResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/GenericResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/GenericResponse"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/GenericResponse"
}
}
}
}
},
"x-v2-response-schema": "ActivateDomainForwardServiceResponse"
}
},
"/domain-forward/zones/{domainName}/dns-records": {
"get": {
"tags": [
"APIs"
],
"summary": "List DNS records for domain forwarding",
"description": "Returns DNS records required for domain forwarding.",
"operationId": "listDomainForwardDnsRecords",
"parameters": [
{
"name": "domainName",
"in": "path",
"description": "Domain Name (required).",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ListDomainForwardDnsRecordsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/GenericResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/GenericResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/GenericResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/GenericResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/GenericResponse"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/GenericResponse"
}
}
}
}
},
"x-v2-response-schema": "ListDomainForwardDnsRecordsResponse"
}
},
"/orders/{orderId}/domain-forward/subdomains/{subDomainPrefix}": {
"delete": {
"tags": [
"APIs"
],
"summary": "Delete sub-domain forwarding",
"description": "Disables domain forwarding for a sub-domain.",
"operationId": "deleteSubDomainForward",
"parameters": [
{
"name": "orderId",
"in": "path",
"description": "The Order ID of the Order for which is forwarding is to be disabled",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "subDomainPrefix",
"in": "path",
"description": "The prefix of the sub-domain for which you want to disable domain forwarding.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DeleteSubDomainForwardResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/GenericResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/GenericResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/GenericResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/GenericResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/GenericResponse"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/GenericResponse"
}
}
}
}
},
"x-v2-response-schema": "DeleteSubDomainForwardResponse"
}
},
"/domain-forward/zones/{domainName}": {
"delete": {
"tags": [
"APIs"
],
"summary": "Delete domain forwarding for a domain",
"description": "Disables domain forwarding for a domain name.",
"operationId": "deleteDomainForward",
"parameters": [
{
"name": "domainName",
"in": "path",
"description": "Domain name for which you want to disable domain forwarding.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DeleteDomainForwardResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/GenericResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/GenericResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/GenericResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/GenericResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/GenericResponse"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/GenericResponse"
}
}
}
}
},
"x-v2-response-schema": "DeleteDomainForwardResponse"
}
}
},
"components": {
"schemas": {
"GenericResponse": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"path": {
"type": "string"
},
"status": {
"type": "integer",
"format": "int32"
},
"customLogMessage": {}
}
},
"UpdateDomainForwardRequest": {
"type": "object",
"description": "Returns the result of updating domain forwarding settings.",
"properties": {
"forwardTo": {
"type": "string",
"description": "URL where you want to forward your request.",
"minLength": 1
},
"urlMasking": {
"type": "boolean",
"description": "Possible values are true or false . If true passed, visitors will see the source URL and not the destination URL."
},
"metaTags": {
"type": "string",
"description": "Sets META Tags and Page Title for the frames page which is sent to the visitor. eg. Your Webpage title can be mentioned here"
},
"noframes": {
"type": "string",
"description": "Sets alternate <![CDATA[ page content for search engines. Provide your HTML within <NOFRAMES>]]> tags to set alternate page content."
},
"subDomainForwarding": {
"type": "boolean",
"description": "Possible values are true or false . For e.g. if true passed, a request made to https://subdomain.domainname.com will be forwarded to https://destination-domainname.com/subdomain"
},
"pathForwarding": {
"type": "boolean",
"description": "Possible values are true or false . For e.g. if true passed, a request made to https://domainname.com/some/path will be forwarded to https://destination-domainname.com/some/path"
}
},
"required": [
"forwardTo"
]
},
"ActivateDomainForwardRequest": {
"type": "object",
"description": "This API call can be used to Activate and Manage the Domain Forwarding service.",
"properties": {
"forwardTo": {
"type": "string",
"description": "URL where you want to forward your request.",
"minLength": 1
},
"subDomainPrefix": {
"type": "string",
"description": "The prefix for the sub-domain"
},
"urlMasking": {
"type": "boolean",
"description": "Possible values are true or false . If true passed, visitors will see the source URL and not the destination URL."
},
"metaTags": {
"type": "string",
"description": "Sets META Tags and Page Title for the frames page which is sent to the visitor. eg. Your Webpage title can be mentioned here"
},
"noframes": {
"type": "string",
"description": "Sets alternate <![CDATA[ page content for search engines. Provide your HTML within <NOFRAMES>]]> tags to set alternate page content."
},
"subDomainForwarding": {
"type": "boolean",
"description": "Possible values are true or false . For e.g. if true passed, a request made to https://subdomain.domainname.com will be forwarded to https://destination-domainname.com/subdomain"
},
"pathForwarding": {
"type": "boolean",
"description": "Possible values are true or false . For e.g. if true passed, a request made to https://domainname.com/some/path will be forwarded to https://destination-domainname.com/some/path"
}
},
"required": [
"forwardTo"
]
},
"DomainForwardServiceDetailsDto": {
"type": "object",
"description": "Domain forwarding configuration details.",
"properties": {
"forwardTo": {
"type": "string",
"description": "Destination URL for forwarding"
},
"urlMasking": {
"type": "boolean",
"description": "Whether URL masking is enabled"
},
"metaTags": {
"type": "string",
"description": "Custom meta tags"
},
"noframes": {
"type": "string",
"description": "Noframes content"
},
"subDomainForwarding": {
"type": "boolean",
"description": "Whether sub-domain forwarding is enabled"
},
"pathForwarding": {
"type": "boolean",
"description": "Whether path forwarding is enabled"
},
"subDomainPrefix": {
"type": "string",
"description": "Sub-domain prefix"
}
}
},
"DomainForwardDnsRecordDto": {
"type": "object",
"description": "DNS record entry for domain forwarding.",
"properties": {
"host": {
"type": "string",
"description": "Record hostname"
},
"value": {
"type": "string",
"description": "Record value"
},
"ttl": {
"type": "integer",
"format": "int32",
"description": "Time to live in seconds"
},
"recordType": {
"type": "string",
"description": "DNS record type"
}
}
},
"ActivateDomainForwardServiceResponse": {
"type": "object",
"description": "Returns domain forwarding activation status for the order.",
"properties": {
"transactionId": {
"type": "string",
"description": "Transaction identifier"
},
"status": {
"type": "string",
"description": "Operation status"
},
"message": {
"type": "string",
"description": "Status message"
}
}
},
"DeleteDomainForwardResponse": {
"type": "object",
"description": "Indicates whether domain forwarding was removed successfully.",
"properties": {
"status": {
"type": "string",
"description": "Operation status"
}
}
},
"DeleteSubDomainForwardResponse": {
"type": "object",
"description": "Indicates whether sub-domain forwarding was removed successfully.",
"properties": {
"status": {
"type": "string",
"description": "Operation status"
}
}
},
"GetDomainForwardServiceResponse": {
"type": "object",
"description": "Returns domain forwarding configuration for the order.",
"properties": {
"details": {
"$ref": "#/components/schemas/DomainForwardServiceDetailsDto",
"description": "Domain forwarding configuration"
},
"status": {
"type": "string",
"description": "Operation status"
},
"message": {
"type": "string",
"description": "Status message"
}
}
},
"ListDomainForwardDnsRecordsResponse": {
"type": "object",
"description": "Returns DNS records required for domain forwarding.",
"properties": {
"records": {
"type": "array",
"description": "DNS records for domain forwarding",
"items": {
"$ref": "#/components/schemas/DomainForwardDnsRecordDto"
}
},
"transactionId": {
"type": "string",
"description": "Transaction identifier"
},
"status": {
"type": "string",
"description": "Operation status"
},
"message": {
"type": "string",
"description": "Status message"
}
}
},
"UpdateDomainForwardServiceResponse": {
"type": "object",
"description": "Returns the result of updating domain forwarding settings.",
"properties": {
"transactionId": {
"type": "string",
"description": "Transaction identifier"
},
"status": {
"type": "string",
"description": "Operation status"
},
"message": {
"type": "string",
"description": "Status message"
}
}
}
},
"securitySchemes": {
"apiKeyAuth": {
"type": "apiKey",
"description": "Reseller API key. In your own requests, send the full header value: Authorization: ApiKey YOUR_API_KEY",
"name": "Authorization",
"in": "header"
},
"userIdHeader": {
"type": "apiKey",
"description": "Reseller user ID",
"name": "X-User-Id",
"in": "header"
}
}
},
"tags": [
{
"name": "APIs"
}
]
}