{ "swagger" : "2.0", "info" : { "description" : "Domainrobot JSON API for managing: Domains, SSL\n Certificates, DNS and\n much more.", "version" : "v1", "title" : "Domainrobot JSON API" }, "host" : "api.autodns.com", "basePath" : "/v1", "tags" : [ { "name" : "BackupMx Tasks" }, { "name" : "Billing Tasks" }, { "name" : "Certificate Tasks" }, { "name" : "Client Customer Tasks" }, { "name" : "Contact Document Tasks" }, { "name" : "Contact Tasks" }, { "name" : "Customer Account Tasks" }, { "name" : "CustomerPriceList Tasks" }, { "name" : "Document Tasks" }, { "name" : "Domain Prereg Tasks" }, { "name" : "Domain Tasks" }, { "name" : "DomainPremium Tasks" }, { "name" : "DomainPrereg Tasks" }, { "name" : "DomainSafe Tasks" }, { "name" : "DomainStudio" }, { "name" : "Elastic Tld Search Tasks" }, { "name" : "Elastic Tld Statistic" }, { "name" : "Guest account tasks" }, { "name" : "Invoice Tasks" }, { "name" : "Job Tasks" }, { "name" : "Mail Tasks" }, { "name" : "MailProxy Tasks" }, { "name" : "ObjectUserAssignment Tasks" }, { "name" : "Poll Tasks" }, { "name" : "Price Tasks" }, { "name" : "Redirect Tasks" }, { "name" : "SalesReport Tasks" }, { "name" : "Session Tasks" }, { "name" : "SslContact Tasks" }, { "name" : "subjectProduct Tasks" }, { "name" : "Subscription Tasks" }, { "name" : "Test Tasks" }, { "name" : "TmchMark Claim Tasks" }, { "name" : "TmchMark Tasks" }, { "name" : "Transfer Request Tasks" }, { "name" : "User 2fa Tasks" }, { "name" : "User Tasks" }, { "name" : "UserTaskLimit Task" }, { "name" : "Zone Query Tasks" }, { "name" : "Zone Tasks" }, { "name" : "ZoneQuery Tasks" } ], "schemes" : [ "https" ], "paths" : { "/OTPAuth" : { "get" : { "tags" : [ "User 2fa Tasks" ], "summary" : "User Token Config Info (1301044)", "description" : "Inquiring the token configuration of the logged in user.", "operationId" : "otpAuthInfo", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataOTPAuth" } } } }, "post" : { "tags" : [ "User 2fa Tasks" ], "summary" : "User Token Config Create (1301041)", "description" : "Creating a temporary token for the logged in user. The response contains the qr code as a base64 image.", "operationId" : "otpAuthCreate", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataOTPAuth" } } } } }, "/account" : { "get" : { "tags" : [ "Customer Account Tasks" ], "summary" : "Account Info (0984)", "description" : "Inquiring the account data of a customer.", "operationId" : "AccountInfo", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "view", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataAccount" } } } }, "post" : { "tags" : [ "Customer Account Tasks" ], "summary" : "Account Update (0982)", "description" : "Updates the notifications parameters", "operationId" : "contextHostCreate", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "account", "required" : false, "schema" : { "$ref" : "#/definitions/Account" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataContextHost" } } } } }, "/backupMx" : { "post" : { "tags" : [ "BackupMx Tasks" ], "summary" : "BackupMx Create (0521)", "description" : "Creating a new BackupMx.", "operationId" : "backupMxCreate", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "backupMx", "required" : false, "schema" : { "$ref" : "#/definitions/BackupMx" } }, { "name" : "keys", "in" : "query", "description" : "If the dns should be provisioned if available.", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?keys[]=dnsProvisioning" }, "collectionFormat" : "multi", "x-example" : "?keys[]=dnsProvisioning" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataJsonNoData" } } } } }, "/backupMx/_search" : { "post" : { "tags" : [ "BackupMx Tasks" ], "summary" : "BackupMx List (0524)", "description" : "Inquiring a list of BackupMx with certain details. The following keys can be used for filtering, ordering and inquiring additional data via query parameter: domain, created, updated", "operationId" : "backupMxList", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "query", "required" : false, "schema" : { "$ref" : "#/definitions/Query" } }, { "name" : "keys", "in" : "query", "description" : "The query parameter to inquire additional details.", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?keys[]=domain", "enum" : [ "{domain", "created", "updated}" ] }, "collectionFormat" : "multi", "x-example" : "?keys[]=domain" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataBackupMx" } } } } }, "/backupMx/{domain}" : { "get" : { "tags" : [ "BackupMx Tasks" ], "summary" : "BackupMx Info (0524)", "description" : "Inquiring the data for the specified backup mx.", "operationId" : "backupMxInfo", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "domain", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataBackupMx" } } } }, "delete" : { "tags" : [ "BackupMx Tasks" ], "summary" : "BackupMx Delete (0523)", "description" : "Deleting an existing BackupMx.", "operationId" : "backupMxDelete", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "domain", "in" : "path", "required" : true, "type" : "string" }, { "name" : "keys", "in" : "query", "description" : "If the dns should be provisioned if available.", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?keys[]=dnsProvisioning" }, "collectionFormat" : "multi", "x-example" : "?keys[]=dnsProvisioning" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataJsonNoData" } } } } }, "/bulk/backupMx" : { "post" : { "tags" : [ "BackupMx Tasks" ], "summary" : "BackupMx Create Bulk (0521)", "description" : "Creating several new backupMxs.", "operationId" : "backupMxCreates", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "backupMxs", "required" : false, "schema" : { "$ref" : "#/definitions/BulkBackupMxPostRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataBackupMx" } } } }, "delete" : { "tags" : [ "BackupMx Tasks" ], "summary" : "BackupMx Delete Bulk (0523)", "description" : "Deleting several existing backupMxs.", "operationId" : "backupMxDeletes", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "sources", "required" : false, "schema" : { "$ref" : "#/definitions/BulkBackupMxDeleteRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataBackupMx" } } } } }, "/bulk/certificate" : { "post" : { "tags" : [ "Certificate Tasks" ], "summary" : "Certificate Create Bulk (400101)", "description" : "Creating several new certificates.", "operationId" : "certificateCreates", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "certificates", "required" : false, "schema" : { "$ref" : "#/definitions/BulkCertificatePostRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataCertificate" } } } }, "delete" : { "tags" : [ "Certificate Tasks" ], "summary" : "Certificate Delete Bulk (400103)", "description" : "Deleting several existing certificates.", "operationId" : "certificateDeletes", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "sources", "required" : false, "schema" : { "$ref" : "#/definitions/BulkCertificateDeleteRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataCertificate" } } } }, "patch" : { "tags" : [ "Certificate Tasks" ], "summary" : "Certificate Update Bulk (400102)", "description" : "Updating several existing certificates.", "operationId" : "certificatePatches", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "sources", "required" : false, "schema" : { "$ref" : "#/definitions/BulkCertificatePatchRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataCertificate" } } } } }, "/bulk/certificate/_renew" : { "patch" : { "tags" : [ "Certificate Tasks" ], "summary" : "Certificate Update Bulk (400106)", "description" : "Renewing several existing certificates.", "operationId" : "certificatRenews", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "sources", "required" : false, "schema" : { "$ref" : "#/definitions/BulkCertificatePatchRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataCertificate" } } } } }, "/bulk/clientAccount/{label}/clientCustomer" : { "post" : { "tags" : [ "Client Customer Tasks" ], "summary" : "Client Customer Create Bulk (0144201)", "description" : "Creating several client customers in one request.", "operationId" : "externalCustomerCreates", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "label", "in" : "path", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "externalCustomers", "required" : false, "schema" : { "$ref" : "#/definitions/BulkExternalCustomerPostRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataExternalCustomer" } } } }, "delete" : { "tags" : [ "Client Customer Tasks" ], "summary" : " Client Customer Delete Bulk (0144203)", "description" : "Deleting several client customers in one request.", "operationId" : "externalCustomerDeletes", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "externalCustomers", "required" : false, "schema" : { "$ref" : "#/definitions/BulkExternalCustomerDeleteRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataExternalCustomer" } } } } }, "/bulk/contact" : { "delete" : { "tags" : [ "Contact Tasks" ], "summary" : "Contact Delete Bulk (0303)", "description" : "Deleting several contacts with one request.", "operationId" : "contactDeletes", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "sources", "required" : false, "schema" : { "$ref" : "#/definitions/BulkContactDeleteRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataContact" } } } } }, "/bulk/contact/_domainSafe" : { "put" : { "tags" : [ "Domain Tasks" ], "summary" : "Safe Object Contact Create Bulk (0601)", "description" : "Adding several contacts in the DomainSafe with one request.", "operationId" : "domainsAddDomainSafe", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "domains", "required" : false, "schema" : { "$ref" : "#/definitions/BulkDomainSafeContactRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataContact" } } } }, "delete" : { "tags" : [ "Domain Tasks" ], "summary" : "Safe Object Contact Delete Bulk (0603)", "description" : "Deleting several contacts from the DomainSafe with one request.", "operationId" : "domainsDeleteDomainSafe", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "domains", "required" : false, "schema" : { "$ref" : "#/definitions/BulkDomainSafeContactRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataContact" } } } } }, "/bulk/customerPriceList" : { "post" : { "tags" : [ "CustomerPriceList Tasks" ], "summary" : "CustomerPriceList Create Bulk (099961)", "description" : "Creating several customer price lists in one request.", "operationId" : "customerPriceListCreates", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "customerPriceLists", "required" : false, "schema" : { "$ref" : "#/definitions/BulkCustomerPriceListPostRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataCustomerPriceList" } } } }, "delete" : { "tags" : [ "CustomerPriceList Tasks" ], "summary" : " CustomerPriceList Delete Bulk (099963)", "description" : "Deleting several customer price lists in one request.", "operationId" : "customerPriceListDeletes", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "customerPriceLists", "required" : false, "schema" : { "$ref" : "#/definitions/BulkCustomerPriceListDeleteRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataCustomerPriceList" } } } } }, "/bulk/domain" : { "post" : { "tags" : [ "Domain Tasks" ], "summary" : "Domain Create Bulk (0101)", "description" : "Creating several domains with one request.", "operationId" : "domainCreates", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "domains", "required" : false, "schema" : { "$ref" : "#/definitions/BulkDomainPostRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataDomain" } } } }, "patch" : { "tags" : [ "Domain Tasks" ], "summary" : "Domain Update Bulk (0102)", "description" : "Updating several domains with one request.", "operationId" : "domainPatches", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "domains", "required" : false, "schema" : { "$ref" : "#/definitions/BulkDomainPatchRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataDomain" } } } } }, "/bulk/domain/_authinfo1" : { "post" : { "tags" : [ "Domain Tasks" ], "summary" : "Authinfo1 Create Bulk (0113001)", "description" : "Creating several AuthInfos 1 with one request.", "operationId" : "domainAuthinfoCreates", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "domains", "required" : false, "schema" : { "$ref" : "#/definitions/BulkDomainDeleteRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataDomain" } } } }, "delete" : { "tags" : [ "Domain Tasks" ], "summary" : "Authinfo1 Delete Bulk (0113002)", "description" : "Deleting several AuthInfos 1 with one request.", "operationId" : "domainAuthinfoDeletes", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "domains", "required" : false, "schema" : { "$ref" : "#/definitions/BulkDomainDeleteRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataDomain" } } } } }, "/bulk/domain/_authinfo2" : { "post" : { "tags" : [ "Domain Tasks" ], "summary" : "AuthInfo2 Create Bulk (0113003)", "description" : "Creating several AuthInfos 2 with one request.", "operationId" : "domainAuthinfo2Creates", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "domains", "required" : false, "schema" : { "$ref" : "#/definitions/BulkDomainDeleteRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataDomain" } } } } }, "/bulk/domain/_buy" : { "post" : { "tags" : [ "Domain Tasks" ], "summary" : "Domain Buy Bulk (0101006)", "description" : "Buying several domains with one request.", "operationId" : "domainBuys", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "domains", "required" : false, "schema" : { "$ref" : "#/definitions/BulkDomainDeleteRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataDomain" } } } } }, "/bulk/domain/_comment" : { "put" : { "tags" : [ "Domain Tasks" ], "summary" : "Domain Comments Update Bulk (0102004)", "description" : "Updating several domain comments with one request.", "operationId" : "domainUpdateComments", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "domains", "required" : false, "schema" : { "$ref" : "#/definitions/BulkDomainCommentRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataDomain" } } } } }, "/bulk/domain/_domainSafe" : { "put" : { "tags" : [ "Domain Tasks" ], "summary" : "Safe Object Create Bulk (0601)", "description" : "Adding several domains in the DomainSafe with one request.", "operationId" : "domainsAddDomainSafe", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "domains", "required" : false, "schema" : { "$ref" : "#/definitions/BulkDomainSafeDomainRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataDomain" } } } }, "delete" : { "tags" : [ "Domain Tasks" ], "summary" : "Safe Object Delete Bulk (0603)", "description" : "Deleting several domains from the DomainSafe with one request.", "operationId" : "domainsDeleteDomainSafe", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "domains", "required" : false, "schema" : { "$ref" : "#/definitions/BulkDomainSafeDomainRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataDomain" } } } } }, "/bulk/domain/_renew" : { "put" : { "tags" : [ "Domain Tasks" ], "summary" : "Domain Renew Bulk (0101003)", "description" : "Renewing several domains with one request.", "operationId" : "domainRenews", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "domains", "required" : false, "schema" : { "$ref" : "#/definitions/BulkDomainCommentRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataDomain" } } } } }, "/bulk/domain/_restore" : { "put" : { "tags" : [ "Domain Tasks" ], "summary" : "Domain Restore Bulk (0101005)", "description" : "Restoring several domains with one request.", "operationId" : "domainRestores", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "domains", "required" : false, "schema" : { "$ref" : "#/definitions/BulkDomainCommentRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataDomain" } } } } }, "/bulk/domain/_transfer" : { "post" : { "tags" : [ "Domain Tasks" ], "summary" : "Domain Transfer Bulk (0104)", "description" : "Transferring several domains with one request.", "operationId" : "domainTransfers", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "domains", "required" : false, "schema" : { "$ref" : "#/definitions/BulkDomainPostRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataDomain" } } } } }, "/bulk/domain/cancelation" : { "post" : { "tags" : [ "Domain Tasks" ], "summary" : "Cancelation Create Bulk (0103101)", "description" : "Creating several domain cancelations with one request.", "operationId" : "domainCancelationCreates", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "cancelations", "required" : false, "schema" : { "$ref" : "#/definitions/BulkDomainCancelationPostRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataDomainCancelation" } } } }, "delete" : { "tags" : [ "Domain Tasks" ], "summary" : "Cancelation Delete Bulk (0103103)", "description" : "Deleting several domain cancelations with one request.", "operationId" : "domainCancelationDeletes", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "cancelations", "required" : false, "schema" : { "$ref" : "#/definitions/BulkDomainCancelationDeleteRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataDomainCancelation" } } } }, "patch" : { "tags" : [ "Domain Tasks" ], "summary" : "Cancelation Update Bulk (0103102)", "description" : "Updating several domain cancelations with one request.", "operationId" : "domainCancelationPatches", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "cancelations", "required" : false, "schema" : { "$ref" : "#/definitions/BulkDomainCancelationPatchRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataDomainCancelation" } } } } }, "/bulk/domainPrereg" : { "post" : { "tags" : [ "Domain Prereg Tasks" ], "summary" : "Domain Prereg Create Bulk (0110001)", "description" : "Creating several domain preregistrations with one request.", "operationId" : "domainPreregCreates", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "domains", "required" : false, "schema" : { "$ref" : "#/definitions/BulkDomainPreregPostRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataDomainPrereg" } } } }, "delete" : { "tags" : [ "Domain Prereg Tasks" ], "summary" : "Domain Prereg Delete Bulk (0110003)", "description" : "Deleting several domain preregistrations with one request.", "operationId" : "domainPreregDeletes", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "domains", "required" : false, "schema" : { "$ref" : "#/definitions/BulkDomainPreregDeleteRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataDomainPrereg" } } } }, "patch" : { "tags" : [ "Domain Prereg Tasks" ], "summary" : "Domain Prereg Update Bulk (0110002)", "description" : "Updating several domain preregistrations with one request.", "operationId" : "domainPreregPatches", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "domains", "required" : false, "schema" : { "$ref" : "#/definitions/BulkDomainPreregPatchRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataDomainPrereg" } } } } }, "/bulk/domainPrereg/_confirm" : { "put" : { "tags" : [ "Domain Prereg Tasks" ], "summary" : "Domain Prereg Confirm Bulk (0110007)", "description" : "Confirming several domain preregistrations with one request.", "operationId" : "domainPreregConfimrs", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "domains", "required" : false, "schema" : { "$ref" : "#/definitions/BulkDomainPreregDeleteRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataDomainPrereg" } } } } }, "/bulk/intern/billing/_confirm" : { "put" : { "tags" : [ "Billing Tasks" ], "summary" : "BillingEvent Confirm Bulk (1606)", "description" : "Confirming several Billing with one request.", "operationId" : "billingEventConfirm", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "billingEvent", "required" : false, "schema" : { "$ref" : "#/definitions/BulkBillingEventDeleteRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataBillingEvent" } } } } }, "/bulk/intern/billing/_drop" : { "put" : { "tags" : [ "Billing Tasks" ], "summary" : "BillingEvent Drop Bulk (1623)", "description" : "Drop several Billing with one request.", "operationId" : "billingEventDrop", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "billingEvent", "required" : false, "schema" : { "$ref" : "#/definitions/BulkBillingEventDropRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataBillingEvent" } } } } }, "/bulk/intern/billing/_reactivate" : { "put" : { "tags" : [ "Billing Tasks" ], "summary" : "BillingEvent Reactivate Bulk (1609)", "description" : "Reactivating several Billing with one request.", "operationId" : "billingEventReactivate", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "billingEvent", "required" : false, "schema" : { "$ref" : "#/definitions/BulkBillingEventReactivateRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataBillingEvent" } } } } }, "/bulk/intern/billing/_reject" : { "put" : { "tags" : [ "Billing Tasks" ], "summary" : "BillingEvent Reject Bulk (1608)", "description" : "Rejecting several Billing with one request.", "operationId" : "billingEventRegect", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "billingEvent", "required" : false, "schema" : { "$ref" : "#/definitions/BulkBillingEventRejectRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataBillingEvent" } } } } }, "/bulk/mailProxy" : { "post" : { "tags" : [ "MailProxy Tasks" ], "summary" : "MailProxy Create Bulk (0511)", "description" : "Creating several new MailProxys with one request.", "operationId" : "mailProxyCreates", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "mailProxys", "required" : false, "schema" : { "$ref" : "#/definitions/BulkMailProxyPostRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataMailProxy" } } } }, "delete" : { "tags" : [ "MailProxy Tasks" ], "summary" : "MailProxy Delete Bulk (0513)", "description" : "Deleting several new MailProxys with one request.", "operationId" : "mailProxyDeletes", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "sources", "required" : false, "schema" : { "$ref" : "#/definitions/BulkMailProxyDeleteRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataMailProxy" } } } }, "patch" : { "tags" : [ "MailProxy Tasks" ], "summary" : "MailProxy Update Bulk (0512)", "description" : "Updating several new MailProxys with one request.", "operationId" : "mailProxyPatches", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "sources", "required" : false, "schema" : { "$ref" : "#/definitions/BulkMailProxyPatchRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataMailProxy" } } } } }, "/bulk/objectUserAssignment" : { "patch" : { "tags" : [ "ObjectUserAssignment Tasks" ], "summary" : "Update owner objects (1308)", "description" : "Reassigins objects to a new owner.", "operationId" : "objectUserAssignmentBulk", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "objects", "required" : false, "schema" : { "$ref" : "#/definitions/BulkObjectUserAssignmentPatchRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataObjectUserAssignment" } } } } }, "/bulk/price" : { "post" : { "tags" : [ "Price Tasks" ], "summary" : "Price Create Bulk (09951)", "description" : "Creating several prices in one request.", "operationId" : "priceCreates", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "prices", "required" : false, "schema" : { "$ref" : "#/definitions/BulkPricePostRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataPrice" } } } }, "delete" : { "tags" : [ "Price Tasks" ], "summary" : " Price Delete Bulk (09953)", "description" : "Deleting several prices in one request.", "operationId" : "priceDeletes", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "prices", "required" : false, "schema" : { "$ref" : "#/definitions/BulkPriceDeleteRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataPrice" } } } }, "patch" : { "tags" : [ "Price Tasks" ], "summary" : "Price Update Bulk (09952)", "description" : "Updating several prices in one request.", "operationId" : "pricePatches", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "prices", "required" : false, "schema" : { "$ref" : "#/definitions/BulkPricePatchRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataPrice" } } } } }, "/bulk/redirect" : { "post" : { "tags" : [ "Redirect Tasks" ], "summary" : "Redirect Create Bulk (0501)", "description" : "Creating several redirects in one request.", "operationId" : "redirectCreates", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "redirects", "required" : false, "schema" : { "$ref" : "#/definitions/BulkRedirectPostRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataRedirect" } } } }, "delete" : { "tags" : [ "Redirect Tasks" ], "summary" : " Redirect Delete Bulk (0503)", "description" : "Deleting several redirects in one request.", "operationId" : "redirectDeletes", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "sources", "required" : false, "schema" : { "$ref" : "#/definitions/BulkRedirectDeleteRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataRedirect" } } } }, "patch" : { "tags" : [ "Redirect Tasks" ], "summary" : "Redirect Update Bulk (0502) ", "description" : "Updating several redirects in one request.", "operationId" : "redirectPatches", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "sources", "required" : false, "schema" : { "$ref" : "#/definitions/BulkRedirectPatchRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataRedirect" } } } } }, "/bulk/sslcontact" : { "delete" : { "tags" : [ "SslContact Tasks" ], "summary" : "SslContact Delete Bulk (400203)", "description" : "Deleting serveral SslContact with one request.", "operationId" : "sslContactsDeletes", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "sources", "required" : false, "schema" : { "$ref" : "#/definitions/BulkSslContactDeleteRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataSslContact" } } } } }, "/bulk/zone" : { "post" : { "tags" : [ "Zone Tasks" ], "summary" : "Create Zones (0201)", "description" : "Creating several zones with one request.", "operationId" : "zoneCreates", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "zones", "required" : false, "schema" : { "$ref" : "#/definitions/BulkZonePostRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataZone" } } } }, "delete" : { "tags" : [ "Zone Tasks" ], "summary" : "Delete Zones (0203)", "description" : "Deleting several existing zones with one request.", "operationId" : "zoneDeletes", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "zones", "required" : false, "schema" : { "$ref" : "#/definitions/BulkZoneDeleteRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataZone" } } } }, "patch" : { "tags" : [ "Zone Tasks" ], "summary" : "Update Zones (0202001)", "description" : "Updating several existing zones with one request.", "operationId" : "zoneBulkPatches", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "zones", "required" : false, "schema" : { "$ref" : "#/definitions/BulkZonePatchRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataZone" } } } } }, "/bulk/zone/_comment" : { "put" : { "tags" : [ "Zone Tasks" ], "summary" : "Update Zone Comments (0202004)", "description" : "Updating several existing zone comments with one request.", "operationId" : "zoneUpdateComments", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "zones", "required" : false, "schema" : { "$ref" : "#/definitions/BulkZoneCommentRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataZone" } } } } }, "/bulk/zone/_domainSafe" : { "put" : { "tags" : [ "Domain Tasks" ], "summary" : "Safe Object Zone Create Bulk (0601)", "description" : "Adding several zones in the DomainSafe with one request.", "operationId" : "domainsAddDomainSafeZone", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "domains", "required" : false, "schema" : { "$ref" : "#/definitions/BulkDomainSafeZoneRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataZone" } } } }, "delete" : { "tags" : [ "Domain Tasks" ], "summary" : "Safe Object Zone Delete Bulk (0603)", "description" : "Deleting several zones from the DomainSafe with one request.", "operationId" : "domainsDeleteDomainSafeZone", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "domains", "required" : false, "schema" : { "$ref" : "#/definitions/BulkDomainSafeZoneRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataZone" } } } } }, "/bulk/zone/_import" : { "post" : { "tags" : [ "Zone Tasks" ], "summary" : "Import Zones (0204)", "description" : "Importing several specified zones with one request.", "operationId" : "zoneImports", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "zones", "required" : false, "schema" : { "$ref" : "#/definitions/BulkZonePostRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataListJsonResponseDataZone" } } } } }, "/certificate" : { "post" : { "tags" : [ "Certificate Tasks" ], "summary" : "Certificate Create (400101)", "description" : "Ordering a new certificate. The operation is asynchronous and creates a new job.", "operationId" : "certificateCreate", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "certificate", "required" : false, "schema" : { "$ref" : "#/definitions/Certificate" } }, { "name" : "keys", "in" : "query", "description" : "The query parameter to enable additional features.", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?keys[]=dnsProvisioning", "enum" : [ "{dnsProvisioning}" ] }, "collectionFormat" : "multi", "x-example" : "?keys[]=dnsProvisioning" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataJob" } } } } }, "/certificate/_checkVmcData" : { "post" : { "tags" : [ "Certificate Tasks" ], "summary" : " Vmc Data Check (4001015)", "description" : "Checks the given data against requirements for VMC certificates", "operationId" : "vmcDataCheck", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "vmcCheckData", "required" : false, "schema" : { "$ref" : "#/definitions/VmcCheckData" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataVmcCheckData" } } } } }, "/certificate/_installcheck" : { "post" : { "tags" : [ "Certificate Tasks" ], "summary" : "Certificate Install Check (4001013)", "description" : "Checks an installed certificate on a server", "operationId" : "certificateInstallCheck", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "request", "required" : false, "schema" : { "$ref" : "#/definitions/CertificateInstallCheckRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataCertificateInstallCheckResult" } } } } }, "/certificate/_prepareOrder" : { "post" : { "tags" : [ "Certificate Tasks" ], "summary" : " Certificate Order Prepare (400110)", "description" : "Preparing a certificate order. This call checks the csr and generates authentication data required for further calls like order, renew, reissue, revoke, delete.", "operationId" : "certificatePrepareOrder", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "certificateData", "required" : false, "schema" : { "$ref" : "#/definitions/CertificateData" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataCertificateData" } } } } }, "/certificate/_realtime" : { "post" : { "tags" : [ "Certificate Tasks" ], "summary" : "Certificate Realtime Order (4001012)", "description" : "Ordering or renewing a certificate in realtime. Only supported by a few certificate products!", "operationId" : "certificateRealtime", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "certificate", "required" : false, "schema" : { "$ref" : "#/definitions/Certificate" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataCertificate" } } } } }, "/certificate/_search" : { "post" : { "tags" : [ "Certificate Tasks" ], "summary" : "Certificate List (400105)", "description" : "Inquiring a list of certificates with certain details. The following keys can be used for filtering, ordering and fetching additional data via query parameter: product, technical, orderId, created, admin, type, expire, domain, name, comment, id, updated, authentication.", "operationId" : "certificateList", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "query", "required" : false, "schema" : { "$ref" : "#/definitions/Query" } }, { "name" : "keys", "in" : "query", "description" : "The query parameter to inquire additional details.", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?keys[]=product", "enum" : [ "{product", "technical", "orderId", "created", "admin", "type", "expire", "domain", "name", "comment", "id", "updated", "authentication}" ] }, "collectionFormat" : "multi", "x-example" : "?keys[]=product" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataCertificate" } } } } }, "/certificate/{id}" : { "get" : { "tags" : [ "Certificate Tasks" ], "summary" : "Certificate Info (400104)", "description" : "Inquiring the data for the specified certificate.", "operationId" : "certificateinfo", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "id", "in" : "path", "required" : true, "type" : "integer", "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataCertificate" } } } }, "put" : { "tags" : [ "Certificate Tasks" ], "summary" : "Certificate Reissue (400102)", "description" : "Reissuing an existing certificate. The operation is asynchronous and creates a job.", "operationId" : "certificateReissue", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "id", "in" : "path", "required" : true, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "certificate", "required" : false, "schema" : { "$ref" : "#/definitions/Certificate" } }, { "name" : "keys", "in" : "query", "description" : "The query parameter to enable additional features.", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?keys[]=dnsProvisioning", "enum" : [ "{dnsProvisioning}" ] }, "collectionFormat" : "multi", "x-example" : "?keys[]=dnsProvisioning" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataJob" } } } }, "delete" : { "tags" : [ "Certificate Tasks" ], "summary" : "Certificate Delete (400103)", "description" : "Deleting an existing certificate. The operation is asynchronous and creates a job.", "operationId" : "certificateDelete", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "id", "in" : "path", "required" : true, "type" : "integer", "format" : "int32" }, { "name" : "keys", "in" : "query", "description" : "The query parameter to enable additional features.", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?keys[]=dnsProvisioning", "enum" : [ "{dnsProvisioning}" ] }, "collectionFormat" : "multi", "x-example" : "?keys[]=dnsProvisioning" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataJob" } } } } }, "/certificate/{id}/_comment" : { "put" : { "tags" : [ "Certificate Tasks" ], "summary" : "Certificate Comment Update (4001024)", "description" : "Updating a comment for an existing certificate.", "operationId" : "certificateCommentUpdate", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "id", "in" : "path", "required" : true, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "certificate", "required" : false, "schema" : { "$ref" : "#/definitions/Certificate" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataVoid" } } } } }, "/certificate/{id}/_renew" : { "put" : { "tags" : [ "Certificate Tasks" ], "summary" : "Certificate Renew (400106)", "description" : "Renewin an existing certificate. The operation is asynchronous and creates a job.", "operationId" : "certificateRenew", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "id", "in" : "path", "required" : true, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "certificate", "required" : false, "schema" : { "$ref" : "#/definitions/Certificate" } }, { "name" : "keys", "in" : "query", "description" : "The query parameter to enable additional features.", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?keys[]=dnsProvisioning", "enum" : [ "{dnsProvisioning}" ] }, "collectionFormat" : "multi", "x-example" : "?keys[]=dnsProvisioning" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataJob" } } } } }, "/certificate/{id}/_revoke" : { "post" : { "tags" : [ "Certificate Tasks" ], "summary" : "Certificate Revoke (4001031)", "description" : "Revoking an existing old certificate by serialnumber. The operation is in realtime", "operationId" : "certificateRevoke", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "id", "in" : "path", "required" : true, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "certificate", "required" : false, "schema" : { "$ref" : "#/definitions/Certificate" } }, { "name" : "keys", "in" : "query", "description" : "The query parameter to enable additional features.", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?keys[]=dnsProvisioning", "enum" : [ "{dnsProvisioning}" ] }, "collectionFormat" : "multi", "x-example" : "?keys[]=dnsProvisioning" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataJob" } } } } }, "/certificate/{id}/_siteseal" : { "get" : { "tags" : [ "Certificate Tasks" ], "summary" : "Certificate Get Site Seal (4001014)", "description" : "Fetches the site seal information for the given certificate", "operationId" : "certificateGetSiteSeal", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "id", "in" : "path", "required" : true, "type" : "integer", "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataSiteSealInformation" } } } } }, "/contact" : { "post" : { "tags" : [ "Contact Tasks" ], "summary" : "Contact Create (0301)", "description" : "Creating a new domain contact.", "operationId" : "contactCreate", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "contact", "required" : false, "schema" : { "$ref" : "#/definitions/Contact" }, "x-examples" : { "application/json" : "{\n \"alias\": \"John-Doe-1\",\n \"type\": \"PERSON\",\n \"organization\": \"Company\",\n \"title\": \"Dr.\",\n \"city\": \"Anytown\",\n \"country\": \"DE\",\n \"state\": \"BY\",\n \"email\": \"john.doe@domain.com\",\n \"fname\": \"John\",\n \"lname\": \"Doe\",\n \"address\": [\n \"addbfdgfdgfdress\"\n ],\n \"pcode\": \"12345\",\n \"phone\": \"+49-123-12345\",\n \"fax\": \"+49-123-12345\"\n}" } }, { "name" : "keys", "in" : "query", "description" : "The query parameter wich enables the force mode if the key is set.", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?keys[]=force_handle_create", "enum" : [ "{force_handle_create}" ] }, "collectionFormat" : "multi", "x-example" : "?keys[]=force_handle_create" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataContact" } } } } }, "/contact/_search" : { "post" : { "tags" : [ "Contact Tasks" ], "summary" : "Contact List (0304)", "description" : "Inquiring a list of contacts with certain details. The following keys can be used for filtering, ordering and fetching additional data via query parameter: country, pcode, city, type, title, lname, alias, state, id, sip, fax, verification, email, fname, address, created, phone, organization, domainsafe, comment, updated.", "operationId" : "contactList", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "query", "required" : false, "schema" : { "$ref" : "#/definitions/Query" } }, { "name" : "keys", "in" : "query", "description" : "The query parameter to fetch additional details.", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?keys[]=email", "enum" : [ "{country", "pcode", "city", "type", "title", "lname", "alias", "state", "id", "sip", "fax", "verification", "email", "fname", "address", "created", "phone", "organization", "domainsafe", "comment", "updated}" ] }, "collectionFormat" : "multi", "x-example" : "?keys[]=email" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataContact" } } } } }, "/contact/verification" : { "get" : { "tags" : [ "Contact Tasks" ], "summary" : "Contact Verification Info (0344)", "description" : "Inquiring the data for the specified verification.", "operationId" : "verificationInfoWithReference", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "reference", "in" : "query", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataContactVerification" } } } } }, "/contact/verification/_confirm" : { "put" : { "tags" : [ "Contact Tasks" ], "summary" : "Contact Verification Confirm (0346)", "description" : "Confirming an existing verification with a given hash.", "operationId" : "verificationConfirm", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "reference", "in" : "query", "required" : false, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "contactVerification", "required" : false, "schema" : { "$ref" : "#/definitions/ContactVerification" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataContactVerification" } } } } }, "/contact/verification/_search" : { "post" : { "tags" : [ "Contact Tasks" ], "summary" : "Contact Verification List (0345)", "description" : "Inquiring a list of contact verifications with certain details. The following keys can be used for filtering, ordering and fetching additional data via query parameter: confirmed, action, deactivation, created, failed, name, comment, updated, status.", "operationId" : "verificationList", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "query", "required" : false, "schema" : { "$ref" : "#/definitions/Query" } }, { "name" : "keys", "in" : "query", "description" : "The query parameter to fetch additional details.", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?keys[]=action", "enum" : [ "{confirmed", "action", "deactivation", "created", "failed", "name", "comment", "updated", "status}" ] }, "collectionFormat" : "multi", "x-example" : "?keys[]=action" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataContactVerification" } } } } }, "/contact/verification/history" : { "get" : { "tags" : [ "Contact Tasks" ], "summary" : "Contact Verification History Info (0354)", "description" : "Inquiring the data of a specified verification.", "operationId" : "verificationHistoryInfo", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "reference", "in" : "query", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataContactVerification" } } } } }, "/contact/verification/history/_search" : { "post" : { "tags" : [ "Contact Tasks" ], "summary" : "Contact Verification History List (0355)", "description" : "Inquiring a list of history verifications with certain details. The following keys can be used for filtering, ordering and fetching additional data via query parameter: confirmed, action, deactivation, created, failed, name, comment, updated, status", "operationId" : "verificationHistoryList", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "query", "required" : false, "schema" : { "$ref" : "#/definitions/Query" } }, { "name" : "keys", "in" : "query", "description" : "The query parameter to fetch additional details.", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?keys[]=action", "enum" : [ "{confirmed", "action", "deactivation", "created", "failed", "name", "comment", "updated", "status}" ] }, "collectionFormat" : "multi", "x-example" : "?keys[]=action" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataContactVerification" } } } } }, "/contact/{id}" : { "get" : { "tags" : [ "Contact Tasks" ], "summary" : "Contact Info (0304)", "description" : "Inquiring data of a specified domain contact.", "operationId" : "contactInfo", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "id", "in" : "path", "required" : true, "type" : "integer", "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataContact" } } } }, "put" : { "tags" : [ "Contact Tasks" ], "summary" : "Contact Update (0302)", "description" : "Updating an existing domain contact.", "operationId" : "contactUpdate", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "id", "in" : "path", "required" : true, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "contact", "required" : false, "schema" : { "$ref" : "#/definitions/Contact" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataContact" } } } }, "delete" : { "tags" : [ "Contact Tasks" ], "summary" : "Contact Delete (0303)", "description" : "Deleting an existing domain contact.", "operationId" : "contactDelete", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "id", "in" : "path", "required" : true, "type" : "integer", "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataJsonNoData" } } } } }, "/contact/{id}/_comment" : { "put" : { "tags" : [ "Contact Tasks" ], "summary" : "Contact Comment Update (0302004)", "description" : "Updating a comment for an existing contact.", "operationId" : "contcatCommentUpdate", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "id", "in" : "path", "required" : true, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "contact", "required" : false, "schema" : { "$ref" : "#/definitions/Contact" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataVoid" } } } } }, "/contact/{id}/_domainSafe" : { "put" : { "tags" : [ "Contact Tasks" ], "summary" : "Safe Object Create (0601)", "description" : "Adding the contact to the domain safe", "operationId" : "contactAddDomainSafe", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "id", "in" : "path", "required" : true, "type" : "integer", "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataJsonNoData" } } } }, "delete" : { "tags" : [ "Contact Tasks" ], "summary" : "Safe Object Create (0603)", "description" : "Deleting the contact from the domain safe", "operationId" : "contactDeleteDomainSafe", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "id", "in" : "path", "required" : true, "type" : "integer", "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataJsonNoData" } } } } }, "/contact/{id}/document/{type}" : { "get" : { "tags" : [ "Contact Document Tasks" ], "summary" : "Contact Document Info (0364)", "description" : "Inquiring a single contact document for the given type.", "operationId" : "contactDocumentInfo", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "id", "in" : "path", "required" : true, "type" : "integer", "format" : "int32" }, { "name" : "type", "in" : "path", "required" : true, "type" : "string" }, { "name" : "keys", "in" : "query", "description" : "The query parameter to enable generate a download link.", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?keys[]=link", "enum" : [ "{link}" ] }, "collectionFormat" : "multi", "x-example" : "?keys[]=link" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataContactDocument" } } } }, "post" : { "tags" : [ "Contact Document Tasks" ], "summary" : "Contact Document Create (0361)", "description" : "Uploading a specific document to a contact entry.", "operationId" : "documentCreate", "consumes" : [ "multipart/form-data" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "file", "in" : "formData", "required" : false, "type" : "string" }, { "name" : "id", "in" : "path", "required" : true, "type" : "integer", "format" : "int64" }, { "name" : "type", "in" : "path", "required" : true, "type" : "string" }, { "name" : "keys", "in" : "query", "description" : "The query parameter to enable assignment replacment.", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?keys[]=override", "enum" : [ "{override}" ] }, "collectionFormat" : "multi", "x-example" : "?keys[]=override" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataContactDocument" } } } }, "delete" : { "tags" : [ "Contact Document Tasks" ], "summary" : "Contact Document Delete (0363)", "description" : "Deleting a single TmchMark document for the given type.", "operationId" : "contactDocumentDelete", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "id", "in" : "path", "required" : true, "type" : "integer", "format" : "int64" }, { "name" : "type", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataVoid" } } } }, "patch" : { "tags" : [ "Contact Document Tasks" ], "summary" : "Contact Document Status Update (0362)", "description" : "Updating status an existing contactDocument.", "operationId" : "contactDocumentPatch", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "id", "in" : "path", "required" : true, "type" : "integer", "format" : "int32" }, { "name" : "type", "in" : "path", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "contactDocument", "required" : false, "schema" : { "$ref" : "#/definitions/ContactDocument" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataContactDocument" } } } } }, "/contact/{id}/document/{type}/_copy" : { "post" : { "tags" : [ "Contact Document Tasks" ], "summary" : "Contact Document Copy (0365)", "description" : "Copying a document and assigning it to another contact.", "operationId" : "documentCopy", "consumes" : [ "multipart/form-data" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "file", "in" : "formData", "required" : false, "type" : "string" }, { "name" : "type", "in" : "path", "required" : true, "type" : "string" }, { "name" : "id", "in" : "path", "required" : true, "type" : "integer", "format" : "int64" }, { "in" : "body", "name" : "body", "description" : "contactDocument", "required" : false, "schema" : { "$ref" : "#/definitions/ContactDocument" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataContactDocument" } } } } }, "/contact/{id}/verification" : { "get" : { "tags" : [ "Contact Tasks" ], "summary" : "Contact Verification Info (0344)", "description" : "Inquiring the data for the specified verification.", "operationId" : "verificationInfo", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "id", "in" : "path", "required" : true, "type" : "integer", "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataContactVerification" } } } }, "post" : { "tags" : [ "Contact Tasks" ], "summary" : "Contact Verification Create (0341)", "description" : "Creating a new contact verification.", "operationId" : "verificationCreate", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "id", "in" : "path", "required" : true, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "contactVerification", "required" : false, "schema" : { "$ref" : "#/definitions/ContactVerification" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataContactVerification" } } } } }, "/contact/{id}/verification/_resendEmail" : { "put" : { "tags" : [ "Contact Tasks" ], "summary" : "Contact Verification ResendEmail (0349)", "description" : "Resending the email for an existing verification.", "operationId" : "verificationResendEmail", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "id", "in" : "path", "required" : true, "type" : "integer", "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataContactVerification" } } } } }, "/document/{alias}" : { "get" : { "tags" : [ "Document Tasks" ], "summary" : "Document Info (1901004)", "description" : "Inquiring the document for the given alias. The alias can be an ID, UUID or a alias name like price_list.xml. For more information on Pricelist download look at our helpcenter.", "operationId" : "documentInfoWithAlias", "produces" : [ "application/octet-stream" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "alias", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "type" : "string", "format" : "byte" } } } } }, "/domain" : { "post" : { "tags" : [ "Domain Tasks" ], "summary" : "Domain Create (0101)", "description" : "Ordering a new domain. The operation is asynchronous and creates a job.", "operationId" : "domainCreate", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "domain", "required" : false, "schema" : { "$ref" : "#/definitions/Domain" } }, { "name" : "ignoreWhois", "in" : "query", "description" : "Specifies whether the whois check should be ignored. Ignores the whois check if parameter is set. Example : ?ignoreWhois", "required" : false, "type" : "string" }, { "name" : "nsCheck", "in" : "query", "description" : "Specifies the name server check to use. Forces the name server nast check if set", "required" : false, "type" : "string", "default" : "NONE", "x-example" : "?nsCheck=ALL", "enum" : [ "SOA", "NS", "ALL", "NONE" ] }, { "name" : "replyTo", "in" : "query", "description" : "The query parameter to override the default reply to address.", "required" : false, "type" : "string", "x-example" : "?replyTo=john.doe@example.org" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataJob" } } } } }, "/domain/_buy" : { "post" : { "tags" : [ "Domain Tasks" ], "summary" : "Domain Buy Order (0101006)", "description" : "Buying a domain from the premium market. The operation is asynchronous and creates a job.", "operationId" : "domainBuy", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "domain", "required" : false, "schema" : { "$ref" : "#/definitions/Domain" } }, { "name" : "replyTo", "in" : "query", "description" : "The query parameter to override the default reply to address.", "required" : false, "type" : "string", "x-example" : "?replyTo=john.doe@example.org" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataJob" } } } } }, "/domain/_ownerChange" : { "post" : { "tags" : [ "Domain Tasks" ], "summary" : "Domain Owner Change (0104010). Deprecated: Will be removed in future releases. Please use /_trade instead", "description" : "Changing the ownerc of an existing domain.", "operationId" : "domainOwnerChange", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "domain", "required" : false, "schema" : { "$ref" : "#/definitions/Domain" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataJob" } } }, "deprecated" : true } }, "/domain/_search" : { "post" : { "tags" : [ "Domain Tasks" ], "summary" : "Domain List (0105)", "description" : "Inquiring a list of domains with certain details. The following keys can be used for filtering, ordering and fetching additional data via query parameter: sld, subtld, tld, status, authinfo, expire, comment, ownerc, updated, zonec, nserver, techc, adminc, certificate, created, autorenew.", "operationId" : "domainList", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "query", "required" : false, "schema" : { "$ref" : "#/definitions/Query" } }, { "name" : "keys", "in" : "query", "description" : "The query parameter to fetch additional details.", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?keys[]=expire", "enum" : [ "{sld", "subtld", "tld", "status", "authinfo", "expire", "comment", "ownerc", "updated", "zonec", "nserver", "techc", "adminc", "certificate", "created", "autorenew}" ] }, "collectionFormat" : "multi", "x-example" : "?keys[]=expire" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataDomain" } } } } }, "/domain/_services" : { "put" : { "tags" : [ "Domain Tasks" ], "summary" : "Domain Services Update", "description" : "Updating the services of a domain.", "operationId" : "domainServicesUpdate", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "services", "required" : false, "schema" : { "$ref" : "#/definitions/DomainServicesUpdate" } }, { "name" : "keys", "in" : "query", "description" : "If the dns should be provisioned if available.", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?keys[]=dnsProvisioning" }, "collectionFormat" : "multi", "x-example" : "?keys[]=dnsProvisioning" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataJsonNoData" } } } } }, "/domain/_trade" : { "post" : { "tags" : [ "Domain Tasks" ], "summary" : "Domain Trade (0104010).", "description" : "Changing the ownerc of an existing domain.", "operationId" : "domainTrade", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "domain", "required" : false, "schema" : { "$ref" : "#/definitions/Domain" } }, { "name" : "replyTo", "in" : "query", "description" : "The query parameter to override the default reply to address.", "required" : false, "type" : "string", "x-example" : "?replyTo=john.doe@example.org" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataJob" } } } } }, "/domain/_transfer" : { "post" : { "tags" : [ "Domain Tasks" ], "summary" : "Domain Transfer (0104)", "description" : "Transfering a domain. The operation is asynchronous and creates a job.", "operationId" : "domainTransfer", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "domain", "required" : false, "schema" : { "$ref" : "#/definitions/Domain" } }, { "name" : "nsCheck", "in" : "query", "description" : "Specifies the name server check to use. Forces the name server nast check if set", "required" : false, "type" : "string", "default" : "NONE", "x-example" : "?nsCheck=ALL", "enum" : [ "SOA", "NS", "ALL", "NONE" ] }, { "name" : "replyTo", "in" : "query", "description" : "The query parameter to override the default reply to address.", "required" : false, "type" : "string", "x-example" : "?replyTo=john.doe@example.org" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataJob" } } } } }, "/domain/autodelete/_search" : { "post" : { "tags" : [ "Domain Tasks" ], "summary" : "Auto Delete List (0718)", "description" : "AutoDelete list", "operationId" : "autoDeleteList", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "query", "required" : false, "schema" : { "$ref" : "#/definitions/Query" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataAutoDeleteDomain" } } } } }, "/domain/cancelation/_search" : { "post" : { "tags" : [ "Domain Tasks" ], "summary" : "Cancelation List (0103104)", "description" : "Inquiring a list of cancelations with certain details. The following keys can be used for filtering, ordering and fetching additional data via query parameter: disconnect, execdate, ctid, created, registryStatus, sld, type, tld, subtld, gainingRegistrar, updated.", "operationId" : "domainCancelationList", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "query", "required" : false, "schema" : { "$ref" : "#/definitions/Query" } }, { "name" : "keys", "in" : "query", "description" : "The query parameter to fetch additional details.", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?keys[]=sld", "enum" : [ "{disconnect", "execdate", "ctid", "created", "registryStatus", "sld", "type", "tld", "subtld", "gainingRegistrar", "updated}" ] }, "collectionFormat" : "multi", "x-example" : "?keys[]=sld" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataDomainCancelation" } } } } }, "/domain/restore/_search" : { "post" : { "tags" : [ "Domain Tasks" ], "summary" : "Domain Restore List (0105005)", "description" : "Inquiring a list of restorable domains with certain details. The following keys can be used for filtering, ordering and fetching additional data via query parameter: parking, certificate, adminc, cancelation, action, zonec, nserver, techc, nsentry, dnssec, period, created, sld, tld, subtld, deleted, autorenew, expire, domainsafe, comment, ownerc, updated, remarks, authinfo, status.", "operationId" : "domainRestoreList", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "query", "required" : false, "schema" : { "$ref" : "#/definitions/Query" } }, { "name" : "keys", "in" : "query", "description" : "The query parameter to fetch additional details.", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?keys[]=sld", "enum" : [ "{parking", "certificate", "adminc", "cancelation", "action", "zonec", "nserver", "techc", "nsentry", "dnssec", "period", "created", "sld", "tld", "subtld", "deleted", "autorenew", "expire", "domainsafe", "comment", "ownerc", "updated", "remarks", "authinfo", "status}" ] }, "collectionFormat" : "multi", "x-example" : "?keys[]=sld" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataDomainRestore" } } } } }, "/domain/{name}" : { "get" : { "tags" : [ "Domain Tasks" ], "summary" : "Domain Info (0105)", "description" : "Inquiring the data for the specified domain.", "operationId" : "domainInfo", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataDomain" } } } }, "put" : { "tags" : [ "Domain Tasks" ], "summary" : "Domain Update (0102)", "description" : "Updating an existing domain. The operation is asynchronous and creates a job.", "operationId" : "domainUpdate", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "domain", "required" : false, "schema" : { "$ref" : "#/definitions/Domain" } }, { "name" : "nsCheck", "in" : "query", "description" : "Specifies the name server check to use. Forces the name server nast check if set", "required" : false, "type" : "string", "default" : "NONE", "x-example" : "?nsCheck=ALL", "enum" : [ "SOA", "NS", "ALL", "NONE" ] }, { "name" : "replyTo", "in" : "query", "description" : "The query parameter to override the default reply to address.", "required" : false, "type" : "string", "x-example" : "?replyTo=john.doe@example.org" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataJob" } } } } }, "/domain/{name}/_authinfo1" : { "post" : { "tags" : [ "Domain Tasks" ], "summary" : "Authinfo Create (0113001)", "description" : "Creating an AuthInfo 1 for the specified domain.", "operationId" : "domainAuthinfo1Create", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataDomain" } } } }, "delete" : { "tags" : [ "Domain Tasks" ], "summary" : "Authinfo Delete", "description" : "Deleting an existing AuthInfo1 for the specified domain.", "operationId" : "domainAuthinfo1Delete", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataJsonNoData" } } } } }, "/domain/{name}/_authinfo2" : { "post" : { "tags" : [ "Domain Tasks" ], "summary" : "Authinfo2 Create (0113003)", "description" : "Creating an AuthInfo 2 for the specified domain.", "operationId" : "domainAuthinfo2Create", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataJsonNoData" } } } } }, "/domain/{name}/_autoDnssecKeyRollover" : { "put" : { "tags" : [ "Domain Tasks" ], "summary" : "AutoDNSSec Key Rollover (0120002)", "description" : "Invoking an AutoDNSSec key rollover. Note the AutoDNSSec feature must be enabled for the domain", "operationId" : "autoDnssecKeyRollover", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataVoid" } } } } }, "/domain/{name}/_comment" : { "put" : { "tags" : [ "Domain Tasks" ], "summary" : "Domain Comment Update (0102004)", "description" : "Updating a comment for an existing domain.", "operationId" : "domainCommentUpdate", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "domain", "required" : false, "schema" : { "$ref" : "#/definitions/Domain" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataJsonNoData" } } } } }, "/domain/{name}/_dnssec" : { "put" : { "tags" : [ "Domain Tasks" ], "summary" : "Domain Update (0102007)", "description" : "Updating only the dnssec information for an existing domain. The operation is asynchronous and creates a job.", "operationId" : "domainUpdateDnsSec", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "domain", "required" : false, "schema" : { "$ref" : "#/definitions/Domain" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataJob" } } } } }, "/domain/{name}/_domainSafe" : { "put" : { "tags" : [ "Domain Tasks" ], "summary" : "Safe Object Create (0601)", "description" : "Adding the domain to the domain safe", "operationId" : "domainAddDomainSafe", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataJsonNoData" } } } }, "delete" : { "tags" : [ "Domain Tasks" ], "summary" : "Safe Object Delete (0603)", "description" : "Deleting the domain from the domain safe", "operationId" : "domainDeleteDomainSafe", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataJsonNoData" } } } } }, "/domain/{name}/_ownerChange" : { "put" : { "tags" : [ "Domain Tasks" ], "summary" : "Domain Owner Change (0104010)", "description" : "Changing the ownerc of an existing domain.", "operationId" : "ownercChange", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "domain", "required" : false, "schema" : { "$ref" : "#/definitions/Domain" } }, { "name" : "replyTo", "in" : "query", "description" : "The query parameter to override the default reply to address.", "required" : false, "type" : "string", "x-example" : "?replyTo=john.doe@example.org" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataJob" } } } } }, "/domain/{name}/_renew" : { "put" : { "tags" : [ "Domain Tasks" ], "summary" : "Domain Renew (0101003)", "description" : "Renewing an existing domain. The operation is asynchronous and creates a job.", "operationId" : "domainRenew", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "domain", "required" : false, "schema" : { "$ref" : "#/definitions/Domain" } }, { "name" : "removeCancelation", "in" : "query", "description" : "Specifies whether an existing cancelation should be removed or not. Removes an existing cancelation if parameter is set. Example : ?removeCancelation", "required" : false, "type" : "string" }, { "name" : "replyTo", "in" : "query", "description" : "The query parameter to override the default reply to address.", "required" : false, "type" : "string", "x-example" : "?replyTo=john.doe@example.org" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataJob" } } } } }, "/domain/{name}/_restore" : { "put" : { "tags" : [ "Domain Tasks" ], "summary" : "Domain Restore (0101005)", "description" : "Restoring an existing domain.", "operationId" : "domainRestore", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "domain", "required" : false, "schema" : { "$ref" : "#/definitions/DomainRestore" } }, { "name" : "replyTo", "in" : "query", "description" : "The query parameter to override the default reply to address.", "required" : false, "type" : "string", "x-example" : "?replyTo=john.doe@example.org" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataJob" } } } } }, "/domain/{name}/_sendAuthinfoToOwnerc" : { "put" : { "tags" : [ "Domain Tasks" ], "summary" : "AuthInfo Send (0113005)", "description" : "Sending the AuthInfo for the specified domain to the domain owner.", "operationId" : "authinfoSend", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "domain", "required" : false, "schema" : { "$ref" : "#/definitions/Domain" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataJsonNoData" } } } } }, "/domain/{name}/_statusUpdate" : { "put" : { "tags" : [ "Domain Tasks" ], "summary" : "Domain Status Update (0102002)", "description" : "Updating the registry status for an existing domain.", "operationId" : "domainStatusUpdate", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "domain", "required" : false, "schema" : { "$ref" : "#/definitions/Domain" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataJob" } } } } }, "/domain/{name}/cancelation" : { "get" : { "tags" : [ "Domain Tasks" ], "summary" : "Cancelation Info (0103104)", "description" : "Inquiring the cancelation data for the specified domain.", "operationId" : "domainCancelationInfo", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataDomainCancelation" } } } }, "post" : { "tags" : [ "Domain Tasks" ], "summary" : "Cancelation Create (0103101)", "description" : "Creating a cancelation for the specified domain.", "operationId" : "domainCancelationCreate", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "domain", "required" : false, "schema" : { "$ref" : "#/definitions/DomainCancelation" } }, { "name" : "replyTo", "in" : "query", "description" : "The query parameter to override the default reply to address.", "required" : false, "type" : "string", "x-example" : "?replyTo=john.doe@example.org" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataDomainCancelation" } } } }, "put" : { "tags" : [ "Domain Tasks" ], "summary" : "Cancelation Update (0103102)", "description" : "Updating an existing cancelation for the specified domain.", "operationId" : "domainCancelationUpdate", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "domain", "required" : false, "schema" : { "$ref" : "#/definitions/DomainCancelation" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataDomainCancelation" } } } }, "delete" : { "tags" : [ "Domain Tasks" ], "summary" : "Cancelation Delete (0103103)", "description" : "Deleting an existing cancelation for the specified domain.", "operationId" : "domainCancelationDelete", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataJsonNoData" } } } } }, "/domainPrereg" : { "post" : { "tags" : [ "DomainPrereg Tasks" ], "summary" : "Domain Prereg Create (0110001)", "description" : "Creating a new domain preregistration.", "operationId" : "domainPreregCreate", "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "domainPrereg", "required" : false, "schema" : { "$ref" : "#/definitions/DomainPrereg" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataVoid" } } } } }, "/domainPrereg/_confirm" : { "post" : { "tags" : [ "DomainPrereg Tasks" ], "summary" : "Domain Prereg Create (0110001)", "description" : "Creating and confirming an existing domain preregistration.", "operationId" : "createAndConfirmPrereg", "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "domainPrereg", "required" : false, "schema" : { "$ref" : "#/definitions/DomainPrereg" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataVoid" } } } } }, "/domainPrereg/_search" : { "post" : { "tags" : [ "DomainPrereg Tasks" ], "summary" : "Domain Prereg List (0110005)", "description" : "Inquiring a list of domain preregistrations with certain details. The following keys can be used for filtering, ordering and fetching additional data via query parameter: orderReference, techc, phase, nsentry, period, created, sld, ownerc, updated, status, confirmed, adminc, zonec, nserver, tld, recommended, subtld.", "operationId" : "domainPreregList", "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "query", "required" : false, "schema" : { "$ref" : "#/definitions/Query" } }, { "name" : "keys", "in" : "query", "description" : "The query parameter to inquire additional details.", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?keys[]=sld", "enum" : [ "{orderReference", "techc", "phase", "nsentry", "period", "created", "sld", "ownerc", "updated", "status", "confirmed", "adminc", "zonec", "nserver", "tld", "recommended", "subtld}" ] }, "collectionFormat" : "multi", "x-example" : "?keys[]=sld" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataDomainPrereg" } } } } }, "/domainPrereg/{reference}" : { "get" : { "tags" : [ "DomainPrereg Tasks" ], "summary" : "Domain PreregInfo (0110004)", "description" : "Inquiring the data of a specified domain preregistration.", "operationId" : "domainPreregInfo", "produces" : [ "application/json" ], "parameters" : [ { "name" : "reference", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataDomainPrereg" } } } }, "put" : { "tags" : [ "DomainPrereg Tasks" ], "summary" : "Domain Prereg Update (0110002)", "description" : "Updating an existing domain preregistration.", "operationId" : "domainPreregUpdate", "produces" : [ "application/json" ], "parameters" : [ { "name" : "reference", "in" : "path", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "domainPrereg", "required" : false, "schema" : { "$ref" : "#/definitions/DomainPrereg" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataVoid" } } } }, "delete" : { "tags" : [ "DomainPrereg Tasks" ], "summary" : "Domain Prereg Delete (0110003)", "description" : "Deleting an existing domain preregistration.", "operationId" : "domainPreregDelete", "produces" : [ "application/json" ], "parameters" : [ { "name" : "reference", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataVoid" } } } } }, "/domainPrereg/{reference}/_confirm" : { "put" : { "tags" : [ "DomainPrereg Tasks" ], "summary" : "Domain Prereg Confirm (0110007)", "description" : "Confirming an existing domain preregistration.", "operationId" : "confirmPrereg", "produces" : [ "application/json" ], "parameters" : [ { "name" : "reference", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataVoid" } } } } }, "/domainSafeContact" : { "post" : { "tags" : [ "DomainSafe Tasks" ], "summary" : "Safe Contact Create (0621)", "description" : "Creating a new DomainSafe Contact.", "operationId" : "safeContactCreate", "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "safeContact", "required" : false, "schema" : { "$ref" : "#/definitions/DomainSafeAccount" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataDomainSafeAccount" } } } } }, "/domainSafeContact/_search" : { "post" : { "tags" : [ "DomainSafe Tasks" ], "summary" : "Safe Contact List (0624)", "description" : "Inquiring a list of Domain Safe contacts with certain details. The following keys can be used for filtering, ordering and fetching additional data via query parameter: name, created, updated.", "operationId" : "safeContactList", "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "query", "required" : false, "schema" : { "$ref" : "#/definitions/Query" } }, { "name" : "keys", "in" : "query", "description" : "The query parameter to fetch additional details.", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?keys[]=name", "enum" : [ "{name", "created", "updated}" ] }, "collectionFormat" : "multi", "x-example" : "?keys[]=name" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataDomainSafeAccount" } } } } }, "/domainSafeContact/user" : { "post" : { "tags" : [ "DomainSafe Tasks" ], "summary" : " Safe User Create (0622001)", "description" : "Creating a new DomainSafe user.", "operationId" : "safeUserCreate", "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "domainSafeUser", "required" : false, "schema" : { "$ref" : "#/definitions/DomainSafeUser" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataDomainSafeUser" } } } }, "put" : { "tags" : [ "DomainSafe Tasks" ], "summary" : "Safe User Update (0622002)", "description" : "Updating an existing DomainSafe user.", "operationId" : "safeUserUpdate", "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "domainSafeUser", "required" : false, "schema" : { "$ref" : "#/definitions/DomainSafeUser" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataDomainSafeUser" } } } } }, "/domainSafeContact/user/{user}/{context}" : { "delete" : { "tags" : [ "DomainSafe Tasks" ], "summary" : "Safe User Delete (0622003)", "description" : "Deleting an existing DomainSafe user.", "operationId" : "safeUserDelete", "produces" : [ "application/json" ], "parameters" : [ { "name" : "user", "in" : "path", "required" : true, "type" : "string" }, { "name" : "context", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataDomainSafeUser" } } } } }, "/domainSafeContact/{id}" : { "get" : { "tags" : [ "DomainSafe Tasks" ], "summary" : "Safe Contact Info (0624)", "description" : "Inquiring the data for the specified safeContact.", "operationId" : "safeContactInfo", "produces" : [ "application/json" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "type" : "integer", "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataDomainSafeAccount" } } } }, "put" : { "tags" : [ "DomainSafe Tasks" ], "summary" : "Safe Contact Update (0622)", "description" : "Updating an existing DomainSafe contact.", "operationId" : "safeContactUpdate", "produces" : [ "application/json" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "domainSafeContact", "required" : false, "schema" : { "$ref" : "#/definitions/DomainSafeAccount" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataDomainSafeAccount" } } } } }, "/domainSafeObject" : { "post" : { "tags" : [ "DomainSafe Tasks" ], "summary" : "Safe Object Create (0601)", "description" : "Creating a new SafeObject.", "operationId" : "safeObjectCreate", "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "safeObject", "required" : false, "schema" : { "$ref" : "#/definitions/DomainSafeObject" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataDomainSafeObject" } } } } }, "/domainSafeObject/_search" : { "post" : { "tags" : [ "DomainSafe Tasks" ], "summary" : "Safe Object List (0604)", "description" : "Inquiring a list of DomanSafe objects with certain details. The following keys can be used for filtering, ordering and fetching additional data via query parameter: created, updated.", "operationId" : "safeObjectList", "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "query", "required" : false, "schema" : { "$ref" : "#/definitions/Query" } }, { "name" : "keys", "in" : "query", "description" : "The query parameter to inquire additional details.", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?keys[]=created", "enum" : [ "{created", "updated}" ] }, "collectionFormat" : "multi", "x-example" : "?keys[]=created" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataDomainSafeObject" } } } } }, "/domainSafeObject/{safeObject}/{type}" : { "delete" : { "tags" : [ "DomainSafe Tasks" ], "summary" : "Safe Object Delete (0603)", "description" : "Deleting an existing safeObject.", "operationId" : "safeObjectDelete", "produces" : [ "application/json" ], "parameters" : [ { "name" : "safeObject", "in" : "path", "required" : true, "type" : "string" }, { "name" : "type", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataDomainSafeObject" } } } } }, "/domainpremium/{name}" : { "get" : { "tags" : [ "DomainPremium Tasks" ], "summary" : "Domain Premium Info (0164)", "description" : "Inquiring the data for the specified premium domain.", "operationId" : "domainPremiumInfo", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataDomainPremium" } } } } }, "/domainstudio" : { "post" : { "tags" : [ "DomainStudio" ], "summary" : "Powerful search api for free domains, premium domains and alternate domain names (0108001).", "description" : "Configurable search results", "operationId" : "domainSearch", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "search", "required" : false, "schema" : { "$ref" : "#/definitions/DomainEnvelopeSearchRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataDomainEnvelope" } } } } }, "/domainstudio/classify" : { "post" : { "tags" : [ "DomainStudio" ], "summary" : "Powerful api to classify domain names.", "description" : "Configurable search results", "operationId" : "domainstudioClassify", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "search", "required" : false, "schema" : { "$ref" : "#/definitions/DomainStudioClassifyRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataDomainEnvelope" } } } } }, "/domainstudio/socialmedia" : { "post" : { "tags" : [ "DomainStudio" ], "summary" : "Powerful search api for free domains, premium domains and alternate domain names.", "description" : "Configurable search results", "operationId" : "domainstudiaSocalMediaCheck", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "search", "required" : false, "schema" : { "$ref" : "#/definitions/DomainstudioSocialMediaRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataDomainEnvelope" } } } } }, "/domainstudio/tlds/_search" : { "post" : { "tags" : [ "Elastic Tld Search Tasks" ], "summary" : "", "description" : "", "operationId" : "elasticTldList", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "query", "required" : false, "schema" : { "$ref" : "#/definitions/Query" } }, { "name" : "keys", "in" : "query", "required" : false, "type" : "string", "x-example" : "?keys[]=searchPrefix", "enum" : [ "{searchPrefix", "bla}" ] } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataTldProduct" } } } } }, "/domainstudio/tlds/stats/_search" : { "get" : { "tags" : [ "Elastic Tld Statistic" ], "summary" : "", "description" : "", "operationId" : "elasticTldStatistics", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataTldStatistic" } } } } }, "/email/_verify/{token}" : { "get" : { "tags" : [ "User Tasks" ], "summary" : "Email Action Verify", "description" : "Applying a verification code for an email address.", "operationId" : "emailConfirmVerification", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "token", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataVoid" } } } } }, "/hello" : { "get" : { "tags" : [ "Test Tasks" ], "summary" : "Hello", "description" : "This route is only for testing the connection to the system. It does no operation.", "operationId" : "hello", "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataVoid" } } } } }, "/invoice/_search" : { "post" : { "tags" : [ "Invoice Tasks" ], "summary" : "Invoice List (0885)", "description" : "Inquiring a list of invoices with certain details. The following keys can be used for filtering, ordering and inquiring additional data via query parameter: number, payment, subType, amount, status, type, failed, currency, paid.", "operationId" : "InvoiceList", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "query", "required" : false, "schema" : { "$ref" : "#/definitions/Query" } }, { "name" : "keys", "in" : "query", "description" : "The query parameter to inquire additional details.", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?keys[]=created", "enum" : [ "{number", "payment", "subType", "amount", "status", "type", "failed", "currency", "paid}" ] }, "collectionFormat" : "multi", "x-example" : "?keys[]=created" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataInvoice" } } } } }, "/invoice/{id}" : { "get" : { "tags" : [ "Invoice Tasks" ], "summary" : "Invoice Info (0884)", "description" : "Inquiring the data for the specified Invoice.", "operationId" : "InvoiceInfo", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "id", "in" : "path", "required" : true, "type" : "integer", "format" : "int64" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataInvoice" } } } } }, "/job/_search" : { "post" : { "tags" : [ "Job Tasks" ], "summary" : "Job List (300115)", "description" : "Inquiring a list of jobs with certain details. The following keys can be used for filtering, ordering and inquiring additional data via query parameter: parent, execution, subStatus, type, created, id, updated, status, object, action.", "operationId" : "jobList", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "query", "required" : false, "schema" : { "$ref" : "#/definitions/Query" } }, { "name" : "keys", "in" : "query", "description" : "The query parameter to fetch additional details.", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?keys[]=type", "enum" : [ "{parent", "execution", "subStatus", "type", "created", "id", "updated", "status", "object", "action}" ] }, "collectionFormat" : "multi", "x-example" : "?keys[]=type" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataObjectJob" } } } } }, "/job/history/_search" : { "post" : { "tags" : [ "Job Tasks" ], "summary" : "Job History List (300135)", "description" : "Inquiring a list of finished jobs with certain details. The following keys can be used for filtering, ordering and inquiring additional data via query parameter: parent, execution, subStatus, type, created, id, updated, status, object, action.", "operationId" : "jobHistoryList", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "query", "required" : false, "schema" : { "$ref" : "#/definitions/Query" } }, { "name" : "keys", "in" : "query", "description" : "The query parameter to fetch additional details.", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?keys[]=type", "enum" : [ "{parent", "execution", "subStatus", "type", "created", "id", "updated", "status", "object", "action}" ] }, "collectionFormat" : "multi", "x-example" : "?keys[]=type" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataObjectJob" } } } } }, "/job/history/{id}" : { "get" : { "tags" : [ "Job Tasks" ], "summary" : "Job History Info (300134)", "description" : "Inquiring the data for the specified finished job.", "operationId" : "jobHistoryInfo", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "id", "in" : "path", "required" : true, "type" : "integer", "format" : "int64" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataObjectJob" } } } } }, "/job/{id}" : { "get" : { "tags" : [ "Job Tasks" ], "summary" : "Job Info (300114)", "description" : "Inquiring the data of the specified job.", "operationId" : "jobInfo", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "id", "in" : "path", "required" : true, "type" : "integer", "format" : "int64" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataObjectJob" } } } } }, "/job/{id}/_cancel" : { "put" : { "tags" : [ "Job Tasks" ], "summary" : "Job Cancel (300121)", "description" : "Cancelling the specified job.", "operationId" : "jobCancel", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "id", "in" : "path", "required" : true, "type" : "integer", "format" : "int64" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataJsonNoData" } } }, "x-allowed-types" : "Certificate" } }, "/job/{id}/_confirm" : { "put" : { "tags" : [ "Job Tasks" ], "summary" : "Job Confirm (300122)", "description" : "Confirming the specified job.", "operationId" : "jobConfirm", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "id", "in" : "path", "required" : true, "type" : "integer", "format" : "int64" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataJsonNoData" } } }, "x-allowed-types" : "Certificate" } }, "/job/{id}/_resendApproverEmail" : { "put" : { "tags" : [ "Job Tasks" ], "summary" : "Approver Email Resend (400118)", "description" : "Resending the approver email.", "operationId" : "resendApproverEmail", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "id", "in" : "path", "required" : true, "type" : "integer", "format" : "int64" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataJsonNoData" } } }, "x-allowed-types" : "Certificate" } }, "/job/{id}/_resendPhoneAuthorization" : { "put" : { "tags" : [ "Job Tasks" ], "summary" : "Phone Authorization Resend (400119)", "description" : "Resending the phone authorization.", "operationId" : "resendPhoneAuthorization", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "id", "in" : "path", "required" : true, "type" : "integer", "format" : "int64" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataJsonNoData" } } }, "x-allowed-types" : "Certificate" } }, "/login" : { "post" : { "tags" : [ "Session Tasks" ], "summary" : "Login (1321001)", "description" : "Logging in and creating a new session.", "operationId" : "login", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "user", "required" : false, "schema" : { "$ref" : "#/definitions/LoginData" } }, { "name" : "acl", "in" : "query", "description" : "Specifies whether the acls are returned in the response. Returns extra data if parameter is set. Example : ?acl", "required" : false, "type" : "string" }, { "name" : "profiles", "in" : "query", "description" : "Specifies whether the user profile is returned in the response. Returns extra data if parameter is set. Example : ?profiles", "required" : false, "type" : "string" }, { "name" : "serviceProfiles", "in" : "query", "description" : "Specifies whether the service user profile is returned in the response. Returns extra data if parameter is set. Example : ?serviceProfiles", "required" : false, "type" : "string" }, { "name" : "customer", "in" : "query", "description" : "Specifies whether the customer data is returned in the response. Returns extra data if parameter is set. Example : ?customer", "required" : false, "type" : "string" }, { "name" : "subscription", "in" : "query", "description" : "Specifies whether the subscriptions are returned in the response. Returns extra data if parameter is set. Example : ?subscription", "required" : false, "type" : "string" }, { "name" : "nameServerGroup", "in" : "query", "description" : "Specifies whether the nameserver groups are returned in the response. Returns extra data if parameter is set. Example : ?nameServerGroup", "required" : false, "type" : "string" }, { "name" : "timeout", "in" : "query", "description" : "Defines the timeout of the session in minutes. Min: 10 minutes, Max: 300 minutes. Default is 10 minutes. Example : timeout=60", "required" : false, "type" : "string" }, { "name" : "clientAccount", "in" : "query", "description" : "Specifies wether the client account data is returned in the response. Returns extra data if parameter is set. Example : ?clientAccount=domainrobot", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataUser" } } } } }, "/logout" : { "get" : { "tags" : [ "Session Tasks" ], "summary" : "Logout (1321003)", "description" : "Logging out and deleting the current session.", "operationId" : "logout", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataJsonNoData" } } } } }, "/mailProxy" : { "post" : { "tags" : [ "MailProxy Tasks" ], "summary" : "MailProxy Create (0511)", "description" : "Creating a new mailproxy.", "operationId" : "mailProxyCreate", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "mailProxy", "required" : false, "schema" : { "$ref" : "#/definitions/MailProxy" } }, { "name" : "keys", "in" : "query", "description" : "If the dns should be provisioned if available.", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?keys[]=dnsProvisioning" }, "collectionFormat" : "multi", "x-example" : "?keys[]=dnsProvisioning" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataJsonNoData" } } } } }, "/mailProxy/_search" : { "post" : { "tags" : [ "MailProxy Tasks" ], "summary" : "MailProxy List (0514)", "description" : "Inquiring a list of MailProxies with certain details. The following keys can be used for filtering, ordering and inquiring additional data via query parameter: target, admin, protection, created, updated.", "operationId" : "mailProxyList", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "query", "required" : false, "schema" : { "$ref" : "#/definitions/Query" } }, { "name" : "keys", "in" : "query", "description" : "The query parameter to inquire additional details.", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?keys[]=target", "enum" : [ "{target", "admin", "protection", "created", "updated}" ] }, "collectionFormat" : "multi", "x-example" : "?keys[]=target" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataMailProxy" } } } } }, "/mailProxy/{domain}" : { "get" : { "tags" : [ "MailProxy Tasks" ], "summary" : "MailProxy Info (0514)", "description" : "Inquiring the data for the specified mail proxy.", "operationId" : "mailProxyInfo", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "domain", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataMailProxy" } } } }, "put" : { "tags" : [ "MailProxy Tasks" ], "summary" : "MailProxy Update (0512)", "description" : "Updating an existing mailproxy.", "operationId" : "mailProxyUpdate", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "domain", "in" : "path", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "mailProxy", "required" : false, "schema" : { "$ref" : "#/definitions/MailProxy" } }, { "name" : "keys", "in" : "query", "description" : "The query parameter to inquire additional details.", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?keys[]=merge", "enum" : [ "merge" ] }, "collectionFormat" : "multi", "x-example" : "?keys[]=merge" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataJsonNoData" } } } }, "delete" : { "tags" : [ "MailProxy Tasks" ], "summary" : "MailProxy Delete (0513)", "description" : "Deleting an existing mail proxy.", "operationId" : "mailProxyDelete", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "domain", "in" : "path", "required" : true, "type" : "string" }, { "name" : "keys", "in" : "query", "description" : "If the dns should be provisioned if available.", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?keys[]=dnsProvisioning" }, "collectionFormat" : "multi", "x-example" : "?keys[]=dnsProvisioning" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataJsonNoData" } } } } }, "/mailServiceMessage/{id}" : { "get" : { "tags" : [ "Mail Tasks" ], "summary" : "Mail Info (1801004)", "description" : "Inquiring the data for the mail entry.", "operationId" : "mailInfo", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "id", "in" : "path", "required" : true, "type" : "integer", "format" : "int64" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataMailServiceMessage" } } } } }, "/object/_assignment" : { "put" : { "tags" : [ "ObjectUserAssignment Tasks" ], "summary" : "Object Owner Update (1308)", "description" : "Reassigning an object to a new owner.", "operationId" : "objectUserAssignment", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "object", "required" : false, "schema" : { "$ref" : "#/definitions/ObjectUserAssignment" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataObjectUserAssignment" } } } } }, "/object/_assignment/all" : { "put" : { "tags" : [ "ObjectUserAssignment Tasks" ], "summary" : "Object User Assignment All (1308001)", "description" : "Reassigning all objects from one user to another one.", "operationId" : "objectUserAssignmentAll", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "object", "required" : false, "schema" : { "$ref" : "#/definitions/ObjectUserAssignment" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataObjectUserAssignment" } } } } }, "/poll" : { "get" : { "tags" : [ "Poll Tasks" ], "summary" : "Poll Message Info (0905)", "description" : "Inqiring the latest poll message.", "operationId" : "pollInfo", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataPollMessage" } } } } }, "/poll/{id}" : { "put" : { "tags" : [ "Poll Tasks" ], "summary" : "Poll Message Confirm (0906)", "description" : "Confirming the specified poll message", "operationId" : "pollConfirm", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "id", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataJsonNoData" } } } } }, "/redirect" : { "post" : { "tags" : [ "Redirect Tasks" ], "summary" : "Redirect Create (0501)", "description" : "Creating a new redirect.", "operationId" : "redirectCreate", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "redirect", "required" : false, "schema" : { "$ref" : "#/definitions/Redirect" } }, { "name" : "keys", "in" : "query", "description" : "If the dns should be provisioned if available.", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?keys[]=dnsProvisioning" }, "collectionFormat" : "multi", "x-example" : "?keys[]=dnsProvisioning" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataRedirect" } } } } }, "/redirect/_search" : { "post" : { "tags" : [ "Redirect Tasks" ], "summary" : "Redirect List (0504)", "description" : "Inquiring a list of redirects with certain details. The following keys can be used for filtering, ordering and inquiring additional data via query parameter: mode, created, domain, source, type, title, updated, target.", "operationId" : "redirectList", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "query", "required" : false, "schema" : { "$ref" : "#/definitions/Query" } }, { "name" : "keys", "in" : "query", "description" : "The query parameter to inquire additional details.", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?keys[]=title", "enum" : [ "{mode", "created", "domain", "source", "type", "title", "updated", "target}" ] }, "collectionFormat" : "multi", "x-example" : "?keys[]=title" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataRedirect" } } } } }, "/redirect/{source}" : { "get" : { "tags" : [ "Redirect Tasks" ], "summary" : "Redirect Info (0504)", "description" : "Inquiring the data for a specified redirect.", "operationId" : "redirectInfo", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "source", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataRedirect" } } } }, "put" : { "tags" : [ "Redirect Tasks" ], "summary" : " Redirect Update (0502)", "description" : "Updating an existing redirect.", "operationId" : "redirectUpdate", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "source", "in" : "path", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "redirect", "required" : false, "schema" : { "$ref" : "#/definitions/Redirect" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataRedirect" } } } }, "delete" : { "tags" : [ "Redirect Tasks" ], "summary" : "Redirect Delete (0503)", "description" : "Deleting an existing redirect.", "operationId" : "redirectDelete", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "source", "in" : "path", "required" : true, "type" : "string" }, { "name" : "keys", "in" : "query", "description" : "If the dns should be provisioned if available.", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?keys[]=dnsProvisioning" }, "collectionFormat" : "multi", "x-example" : "?keys[]=dnsProvisioning" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataJsonNoData" } } } } }, "/sslcontact" : { "post" : { "tags" : [ "SslContact Tasks" ], "summary" : "SSL Contact Create (400201)", "description" : "Creating a new SSL contact.", "operationId" : "sslContactCreate", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "sslcontact", "required" : false, "schema" : { "$ref" : "#/definitions/SslContact" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataSslContact" } } } } }, "/sslcontact/_search" : { "post" : { "tags" : [ "SslContact Tasks" ], "summary" : "SSL Contact List (400205)", "description" : "Inquiring a list of SSL contacts with certain details. The following keys can be used for filtering, ordering and inquiring additional data via query parameter: country, fname, address, city, created, title, lname, phone, organization, state, id, fax, pcode, updated, email.", "operationId" : "sslContactList", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "query", "required" : false, "schema" : { "$ref" : "#/definitions/Query" } }, { "name" : "keys", "in" : "query", "description" : "The query parameter to inquire additional details.", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?keys[]=email", "enum" : [ "{country", "fname", "address", "city", "created", "title", "lname", "phone", "organization", "state", "id", "fax", "pcode", "updated", "email}" ] }, "collectionFormat" : "multi", "x-example" : "?keys[]=email" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataSslContact" } } } } }, "/sslcontact/{id}" : { "get" : { "tags" : [ "SslContact Tasks" ], "summary" : "SSL Contact Info (400204)", "description" : "Inquiring the data for a specified SSL contact.", "operationId" : "sslContactInfo", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "id", "in" : "path", "required" : true, "type" : "integer", "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataSslContact" } } } }, "put" : { "tags" : [ "SslContact Tasks" ], "summary" : "SSL Contact Update (400202)", "description" : "Updating an existing SSL contact.", "operationId" : "sslContactUpdate", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "id", "in" : "path", "required" : true, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "sslcontact", "required" : false, "schema" : { "$ref" : "#/definitions/SslContact" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataSslContact" } } } }, "delete" : { "tags" : [ "SslContact Tasks" ], "summary" : "SSL Contact Delete (400203)", "description" : "Deleting an existing SSL contact.", "operationId" : "sslContactDelete", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "id", "in" : "path", "required" : true, "type" : "integer", "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataJsonNoData" } } } } }, "/subjectProduct/_search" : { "post" : { "tags" : [ "subjectProduct Tasks" ], "summary" : "SubjectProduct List (0995001)", "description" : "Inquiring a list of subjectProduct with certain details. The data to be displayed can be extended per url paremeter.", "operationId" : "subjectProductList", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "query", "required" : false, "schema" : { "$ref" : "#/definitions/Query" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataSubjectProduct" } } } } }, "/subscription" : { "post" : { "tags" : [ "Subscription Tasks" ], "summary" : "Subscription Create (1701)", "description" : "Creating a new subscription contract.", "operationId" : "subscriptionCreate", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "subscription", "required" : false, "schema" : { "$ref" : "#/definitions/PeriodicBilling" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataPeriodicBilling" } } } } }, "/subscription/_search" : { "post" : { "tags" : [ "Subscription Tasks" ], "summary" : "Subscription List (1705)", "description" : "Inquiring a list of the subscription contracts", "operationId" : "subscriptionList", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "query", "required" : false, "schema" : { "$ref" : "#/definitions/Query" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataPeriodicBilling" } } } } }, "/subscription/{contractId}" : { "put" : { "tags" : [ "Subscription Tasks" ], "summary" : "Subscription Update (1702)", "description" : "Updating a subscription contract.", "operationId" : "subscriptionUpdate", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "contractId", "in" : "path", "required" : true, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "subscription", "required" : false, "schema" : { "$ref" : "#/definitions/PeriodicBilling" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataPeriodicBilling" } } } }, "delete" : { "tags" : [ "Subscription Tasks" ], "summary" : "Subscription Delete (1703)", "description" : "Deleting a subscription contract.", "operationId" : "subscriptionDelete", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "contractId", "in" : "path", "required" : true, "type" : "integer", "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataPeriodicBilling" } } } } }, "/subscription/{contractId}/_upgrade" : { "put" : { "tags" : [ "Subscription Tasks" ], "summary" : "Subscription Upgrade (1706)", "description" : "Upgrading a subscription contract.", "operationId" : "subscriptionUpgrade", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "contractId", "in" : "path", "required" : true, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "subscription", "required" : false, "schema" : { "$ref" : "#/definitions/PeriodicBilling" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataPeriodicBilling" } } } } }, "/subscription/{contractId}/cancelation" : { "post" : { "tags" : [ "Subscription Tasks" ], "summary" : "Subscription Create Cancelation", "description" : "Adding a cancelation for the subscription.", "operationId" : "subscriptionCancelationCreate", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "contractId", "in" : "path", "required" : true, "type" : "integer", "format" : "int32" }, { "name" : "date", "in" : "query", "description" : "Specifies the date of the cancelation execution. If not set the expire of the subscritn is used. Example : ?date=2020-10-21", "required" : false, "type" : "date" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataVoid" } } } }, "delete" : { "tags" : [ "Subscription Tasks" ], "summary" : "Subscription remove cancalation", "description" : "Removing an existing cancelation of a subscription.", "operationId" : "subscriptionCancelationDelete", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "contractId", "in" : "path", "required" : true, "type" : "integer", "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataVoid" } } } } }, "/tmchMark" : { "post" : { "tags" : [ "TmchMark Tasks" ], "summary" : "TmchMark Create (011441)", "description" : "Creating a new TmchMark.", "operationId" : "tmchMarkCreate", "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "tmchMark", "required" : false, "schema" : { "$ref" : "#/definitions/TmchMark" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataVoid" } } } } }, "/tmchMark/_import" : { "post" : { "tags" : [ "TmchMark Tasks" ], "summary" : "TmchMark Import (011449)", "description" : "Importing an existing TmchMark.", "operationId" : "tmchMarkImport", "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "tmchMark", "required" : false, "schema" : { "$ref" : "#/definitions/TmchMark" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataVoid" } } } } }, "/tmchMark/_search" : { "post" : { "tags" : [ "TmchMark Tasks" ], "summary" : "TmchMark List (011445)", "description" : "Inquiring a list of TmchMark with certain details. The following keys can be used for filtering, ordering and fetching additional data via query parameter: type, name, reference, description, period, renew, status, payable, sent.", "operationId" : "tmchMarkList", "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "query", "required" : false, "schema" : { "$ref" : "#/definitions/Query" } }, { "name" : "keys", "in" : "query", "description" : "The query parameter to inquire additional details.", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?keys[]=name", "enum" : [ "{type", "name", "reference", "description", "period", "renew", "status", "payable", "sent}" ] }, "collectionFormat" : "multi", "x-example" : "?keys[]=name" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataTmchMark" } } } } }, "/tmchMark/_transfer" : { "post" : { "tags" : [ "TmchMark Tasks" ], "summary" : "TmchMark Transfer Request (011450)", "description" : "Importing an existing TmchMark and starting the transfer.", "operationId" : "importAndtmchMarkTransfer", "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "tmchMark", "required" : false, "schema" : { "$ref" : "#/definitions/TmchMark" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataVoid" } } } } }, "/tmchMark/claim/_search" : { "post" : { "tags" : [ "TmchMark Claim Tasks" ], "summary" : "Tmch Claims List (011545)", "description" : "Inquiring a list of TmchClaim.", "operationId" : "claimList", "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "query", "required" : false, "schema" : { "$ref" : "#/definitions/Query" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataTmchClaimsNotice" } } } } }, "/tmchMark/claim/{reference}" : { "get" : { "tags" : [ "TmchMark Claim Tasks" ], "summary" : "Tmch Claims Info (011544)", "description" : " Inquiring a single TmchClaim.", "operationId" : "claimInfo", "produces" : [ "application/json" ], "parameters" : [ { "name" : "reference", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataTmchClaimsNotice" } } } } }, "/tmchMark/claim/{reference}/_confirm" : { "post" : { "tags" : [ "TmchMark Claim Tasks" ], "summary" : "Tmch Claim Reject (011546)", "description" : "Rejecting the specified TmchClaim.", "operationId" : "claimConfirm", "produces" : [ "application/json" ], "parameters" : [ { "name" : "reference", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataTmchClaimsNotice" } } } } }, "/tmchMark/claim/{reference}/_reject" : { "put" : { "tags" : [ "TmchMark Claim Tasks" ], "summary" : "Tmch Claim Reject (011547)", "description" : "Rejecting the specified TmchClaim.", "operationId" : "claimReject", "produces" : [ "application/json" ], "parameters" : [ { "name" : "reference", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataTmchClaimsNotice" } } } } }, "/tmchMark/{reference}" : { "get" : { "tags" : [ "TmchMark Tasks" ], "summary" : "TmchMark Info (011444)", "description" : "Inquiring the TmchMark entry for the given reference.", "operationId" : "tmchMarkInfo", "produces" : [ "application/json" ], "parameters" : [ { "name" : "reference", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataVoid" } } } }, "put" : { "tags" : [ "TmchMark Tasks" ], "summary" : "TmchMark Update (011442)", "description" : "Updating the TmchMark entry for the given reference.", "operationId" : "tmchMarkUpdate", "produces" : [ "application/json" ], "parameters" : [ { "name" : "reference", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataVoid" } } } }, "delete" : { "tags" : [ "TmchMark Tasks" ], "summary" : "TmchMark Delete (011443)", "description" : "Deleting the TmchMark entry for the given reference.", "operationId" : "tmchMArkDelete", "produces" : [ "application/json" ], "parameters" : [ { "name" : "reference", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataVoid" } } } } }, "/tmchMark/{reference}/_confirm" : { "post" : { "tags" : [ "TmchMark Tasks" ], "summary" : "TmchMark Confirm (011446)", "description" : "Confirming an existing TmchMark.", "operationId" : "tmchMarkConfirm", "produces" : [ "application/json" ], "parameters" : [ { "name" : "reference", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataVoid" } } } } }, "/tmchMark/{reference}/_transfer" : { "put" : { "tags" : [ "TmchMark Tasks" ], "summary" : "TmchMark Transfer Request (011450)", "description" : "Starting the transfer for given reference (External TmchMark).", "operationId" : "tmchMarkTransfer", "produces" : [ "application/json" ], "parameters" : [ { "name" : "reference", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataVoid" } } } } }, "/tmchMark/{reference}/document" : { "post" : { "tags" : [ "TmchMark Tasks" ], "summary" : "TmchMark Document Create (011451)", "description" : "Assinging an uploaded document to a tmch mark entry.", "operationId" : "tmchMarkDocumentCreate", "produces" : [ "application/json" ], "parameters" : [ { "name" : "reference", "in" : "path", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "tmchMark", "required" : false, "schema" : { "$ref" : "#/definitions/TmchMarkDocument" } }, { "name" : "keys", "in" : "query", "description" : "The query parameter to enable assignment replacment.", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?keys[]=override", "enum" : [ "{override}" ] }, "collectionFormat" : "multi", "x-example" : "?keys[]=override" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataTmchMarkDocument" } } } } }, "/tmchMark/{reference}/document/{type}" : { "get" : { "tags" : [ "TmchMark Tasks" ], "summary" : "TmchMark Document Info (011454)", "description" : "Inquiring a single TmchMark document for the given type.", "operationId" : "tmchMarkDocumentInfo", "produces" : [ "application/json" ], "parameters" : [ { "name" : "reference", "in" : "path", "required" : true, "type" : "string" }, { "name" : "type", "in" : "path", "required" : true, "type" : "string" }, { "name" : "keys", "in" : "query", "description" : "The query parameter to enable generate a download link.", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?keys[]=link", "enum" : [ "{link}" ] }, "collectionFormat" : "multi", "x-example" : "?keys[]=link" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataTmchMarkDocument" } } } }, "put" : { "tags" : [ "TmchMark Tasks" ], "summary" : "TmchMark Document Upload", "description" : "Uploading a specific document to a tmch mark entry.", "operationId" : "tmchMarkdocumentUpload", "consumes" : [ "multipart/form-data" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "file", "in" : "formData", "required" : false, "type" : "string" }, { "name" : "reference", "in" : "path", "required" : true, "type" : "string" }, { "name" : "type", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataTmchMarkDocument" } } } }, "delete" : { "tags" : [ "TmchMark Tasks" ], "summary" : "TmchMark Document Delete (011453)", "description" : "Deleting a single TmchMark document for the given type.", "operationId" : "tmchMarkDocumentDelete", "produces" : [ "application/json" ], "parameters" : [ { "name" : "reference", "in" : "path", "required" : true, "type" : "string" }, { "name" : "type", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataVoid" } } } } }, "/transferout/_search" : { "post" : { "tags" : [ "Transfer Request Tasks" ], "summary" : " TransferOut List (0106001)", "description" : "Inquiring a list of transferOut with certain details. The following keys can be used for filtering, ordering and inquiring additional data via query parameter: reminder, created, loosingRegistrar, start, sld, tld, type, subtld, end, gainingRegistrar, id, updated, transaction, status.", "operationId" : "transferOutList", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "query", "required" : false, "schema" : { "$ref" : "#/definitions/Query" } }, { "name" : "keys", "in" : "query", "description" : "The query parameter to inquire additional details.", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?keys[]=end", "enum" : [ "{reminder", "created", "loosingRegistrar", "start", "sld", "tld", "type", "subtld", "end", "gainingRegistrar", "id", "updated", "transaction", "status}" ] }, "collectionFormat" : "multi", "x-example" : "?keys[]=end" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataTransferOut" } } } } }, "/transferout/{domain}/{_type}" : { "post" : { "tags" : [ "Transfer Request Tasks" ], "summary" : " TransferOut Answer (0106002)", "description" : "Accepting (ACK) or rejecting (NACK) transfer request.", "operationId" : "transferOutAnswer", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "domain", "in" : "path", "required" : true, "type" : "string" }, { "name" : "_type", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataTransferOut" } } }, "deprecated" : true } }, "/transferout/{domain}/{type}" : { "put" : { "tags" : [ "Transfer Request Tasks" ], "summary" : "TransferOut Answer", "description" : "Accepting (ACK) or rejecting (NACK) transfer request. A nackReason is only required for rejecting GTLDs Domains. You can use the following values for type : ACK, NACK", "operationId" : "transferOutAnswerOld", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "domain", "in" : "path", "required" : true, "type" : "string" }, { "name" : "type", "in" : "path", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/TransferOut" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataTransferOut" } } } } }, "/transferout/{name}" : { "get" : { "tags" : [ "Transfer Request Tasks" ], "summary" : "Transfer Request Info (0106001)", "description" : "Inquires supplied .", "operationId" : "transferOutTaskInfo", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataTransfer" } } } } }, "/user" : { "post" : { "tags" : [ "User Tasks" ], "summary" : "User Create (1301001)", "description" : "Creating a new user.", "operationId" : "userCreate", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "user", "required" : false, "schema" : { "$ref" : "#/definitions/User" } }, { "name" : "replyUrl", "in" : "query", "description" : "Optional reply url in case of user invite", "required" : false, "type" : "string", "x-example" : "?replyUrl=https%3A%2F%2Fexample.com%2Finvite%2F%7Btoken%7D" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataUser" } } } } }, "/user/_2fa" : { "put" : { "tags" : [ "User 2fa Tasks" ], "summary" : "User Token Config Activate (1301042)", "description" : "Activating the 2fa authentication for the logged in user. The response contains the rescue tokens", "operationId" : "user2faAktivate", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataOTPAuth" } } } }, "delete" : { "tags" : [ "User 2fa Tasks" ], "summary" : "User Token Config Delete (1301043)", "description" : "Deactivating the 2fa of the logged in user. The auth type of the user is set back to password.", "operationId" : "user2faDelete", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataVoid" } } } } }, "/user/_guest" : { "post" : { "tags" : [ "Guest account tasks" ], "summary" : "Guest Account Create", "description" : "Creating a guest account.", "operationId" : "guestCreate", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "user", "required" : false, "schema" : { "$ref" : "#/definitions/User" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataJsonNoData" } } } } }, "/user/_guestverify/{token}" : { "get" : { "tags" : [ "Guest account tasks" ], "summary" : "Guest Account Verify", "description" : "Applying a verification code for a guest account.", "operationId" : "guestApplyVerify", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "token", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataUser" } } }, "deprecated" : true } }, "/user/_newPassword?token={token}" : { "put" : { "tags" : [ "User Tasks" ], "summary" : "New Password", "description" : "This route is for setting a new password for a user.", "operationId" : "newPassword", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "token", "in" : "path", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "user", "required" : false, "schema" : { "$ref" : "#/definitions/NewPassword" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataVoid" } } } } }, "/user/_newPasswordVerify?token={token}" : { "get" : { "tags" : [ "User Tasks" ], "summary" : "New Password Verify", "description" : "Verifying a passwort change request", "operationId" : "newPasswordVerify", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "token", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataVoid" } } } } }, "/user/_search" : { "post" : { "tags" : [ "User Tasks" ], "summary" : "User List (1301004)", "description" : "Inquiring a list of users with certain details. The data to be displayed can be extended per url paremeter.", "operationId" : "userList", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "query", "required" : false, "schema" : { "$ref" : "#/definitions/Query" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataUser" } } } } }, "/user/_sso/{token}" : { "get" : { "tags" : [ "User Tasks" ], "summary" : "SSO Action Verify", "description" : "Applying a verification code for a signle sign on.", "operationId" : "userSSOVerification", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "token", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataUser" } } } } }, "/user/_verify/{token}" : { "get" : { "tags" : [ "User Tasks" ], "summary" : "User Action Verify", "description" : "Applying a verification code for an user action.", "operationId" : "userConfirmVerification", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "token", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataUser" } } } } }, "/user/billinglimit" : { "get" : { "tags" : [ "User Tasks" ], "summary" : "Billing Object Limit Info (01144)", "description" : "Inquiring the billing limit data for the logged in user.", "operationId" : "userBillingLimitInfo", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "keys", "in" : "query", "description" : "Additional control keys, if the unlimited limits should be excluded, the key excludeUnlimited must be set. The key count, fetches the object counts of the selected limits", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?keys[]=excludeUnlimited", "enum" : [ "{excludeUnlimited", "count}" ] }, "collectionFormat" : "multi", "x-example" : "?keys[]=excludeUnlimited" }, { "name" : "articleTypes", "in" : "query", "description" : "Specifies whether the limits should be limited to the defined article type labesl. Example : ?articleTypes[]=domain&articleTypes[]=package", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?articleTypes[]=domain" }, "collectionFormat" : "multi", "x-example" : "?articleTypes[]=domain" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataBillingLimit" } } } } }, "/user/billingterm" : { "get" : { "tags" : [ "User Tasks" ], "summary" : "Billing Object Terms Info (09994)", "description" : "Inquiring the terms of the contact for the logged in user.", "operationId" : "UserBillingObjectTermsInfo", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataBillingObjectTerms" } } } } }, "/user/salesreport/_search" : { "post" : { "tags" : [ "SalesReport Tasks" ], "summary" : "Sales Report List (160105)", "description" : "Inquiring a list of sales with certain details. The following keys can be used for filtering, ordering and inquiring additional data via query parameter: date", "operationId" : "userSalesReportList", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "query", "required" : false, "schema" : { "$ref" : "#/definitions/Query" } }, { "name" : "keys", "in" : "query", "description" : "The query parameter to inquire additional details.", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?keys[]=date", "enum" : [ "{id", "date", "domainSales", "domainAddonSales", "certificateSales", "serverSales", "packageSales", "owner", "created", "updated}" ] }, "collectionFormat" : "multi", "x-example" : "?keys[]=date" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataUserSalesReport" } } } } }, "/user/tasklimit" : { "get" : { "tags" : [ "UserTaskLimit Task" ], "summary" : "User Limit Limit Info (01164)", "description" : "Inquiring the user limit data for the logged in user.", "operationId" : "userTaskLimitInfo", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataTaskUserLimit" } } } } }, "/user/{name}/{context}" : { "get" : { "tags" : [ "User Tasks" ], "summary" : "User Info (1301004)", "description" : "Inquiring the data for the specified user.", "operationId" : "userInfo", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" }, { "name" : "context", "in" : "path", "required" : true, "type" : "integer", "format" : "int32" }, { "name" : "acl", "in" : "query", "description" : "Specifies whether the acls are returned in the response. Returns extra data if parameter is set. Example : ?acl", "required" : false, "type" : "string" }, { "name" : "profiles", "in" : "query", "description" : "Specifies whether the user profile is returned in the response. Returns extra data if parameter is set. Example : ?profiles", "required" : false, "type" : "string" }, { "name" : "customer", "in" : "query", "description" : "Specifies whether the customer data is returned in the response. Returns extra data if parameter is set. Example : ?customer", "required" : false, "type" : "string" }, { "name" : "subscription", "in" : "query", "description" : "Specifies whether the subscriptions are returned in the response. Returns extra data if parameter is set. Example : ?subscription", "required" : false, "type" : "string" }, { "name" : "subscription", "in" : "query", "description" : "Specifies whether the used applications are returned in the response. Returns extra data if parameter is set. Example : ?application", "required" : false, "type" : "string" }, { "name" : "nameServerGroup", "in" : "query", "description" : "Specifies whether the nameserver groups are returned in the response. Returns extra data if parameter is set. Example : ?nameServerGroup", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataUser" } } } }, "put" : { "tags" : [ "User Tasks" ], "summary" : "User Update (1301002)", "description" : "Updating an existing user.", "operationId" : "userUpdate", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" }, { "name" : "context", "in" : "path", "required" : true, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "user", "required" : false, "schema" : { "$ref" : "#/definitions/User" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataUser" } } } }, "delete" : { "tags" : [ "User Tasks" ], "summary" : "User Delete (1301003)", "description" : "Deleting an existing user.", "operationId" : "userDelete", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" }, { "name" : "context", "in" : "path", "required" : true, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "user", "required" : false, "schema" : { "$ref" : "#/definitions/User" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataUser" } } } } }, "/user/{name}/{context}/_lock" : { "put" : { "tags" : [ "User Tasks" ], "summary" : "User Update - lock (1301002)", "description" : "Updating an existing user to lock him.", "operationId" : "userUpdateLock", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" }, { "name" : "context", "in" : "path", "required" : true, "type" : "integer", "format" : "int32" }, { "name" : "keys", "in" : "query", "description" : "Specifies whether the children should be unlocked as well. Example : ?keys[]=children", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?keys[]=children", "enum" : [ "{children}" ] }, "collectionFormat" : "multi", "x-example" : "?keys[]=children" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataUser" } } } } }, "/user/{name}/{context}/_resendInvite" : { "put" : { "tags" : [ "User Tasks" ], "summary" : "User update - resend invite (1301002)", "description" : "Invokes the resending of an invite for an invite user.", "operationId" : "userUpdateResendInvite", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" }, { "name" : "context", "in" : "path", "required" : true, "type" : "integer", "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataUser" } } } } }, "/user/{name}/{context}/_unlock" : { "put" : { "tags" : [ "User Tasks" ], "summary" : "Update User - unlock (1301002)", "description" : "Updating an an existing user to unlock him.", "operationId" : "userUpdateUnlock", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" }, { "name" : "context", "in" : "path", "required" : true, "type" : "integer", "format" : "int32" }, { "name" : "keys", "in" : "query", "description" : "Specifies whether the children should be unlocked as well. Example : ?keys[]=children", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?keys[]=children", "enum" : [ "{children}" ] }, "collectionFormat" : "multi", "x-example" : "?keys[]=children" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataUser" } } } } }, "/user/{name}/{context}/acl" : { "get" : { "tags" : [ "User Tasks" ], "summary" : "User ACL Info (1301024)", "description" : "Inquiring the ACL data for the specified user.", "operationId" : "userAclInfo", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" }, { "name" : "context", "in" : "path", "required" : true, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "user", "required" : false, "schema" : { "$ref" : "#/definitions/User" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataUser" } } } }, "put" : { "tags" : [ "User Tasks" ], "summary" : "ACL Update (1301022)", "description" : "Updating the ACLs for the specified user.", "operationId" : "userAclUpdate", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" }, { "name" : "context", "in" : "path", "required" : true, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "user", "required" : false, "schema" : { "$ref" : "#/definitions/User" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataUser" } } } } }, "/user/{name}/{context}/copy" : { "post" : { "tags" : [ "User Tasks" ], "summary" : "User Copy (1301016)", "description" : "Copying an existing user.", "operationId" : "userCopy", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" }, { "name" : "context", "in" : "path", "required" : true, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "user", "required" : false, "schema" : { "$ref" : "#/definitions/User" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataUser" } } } } }, "/user/{name}/{context}/document/{key}" : { "post" : { "tags" : [ "User Tasks" ], "summary" : "Upload Image", "description" : "Uploading an image to the user profile as a specific key.", "operationId" : "userDocumentUpload", "consumes" : [ "multipart/form-data" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "file", "in" : "formData", "required" : false, "type" : "string" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" }, { "name" : "context", "in" : "path", "required" : true, "type" : "integer", "format" : "int32" }, { "name" : "key", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataVoid" } } } } }, "/user/{name}/{context}/profile" : { "get" : { "tags" : [ "User Tasks" ], "summary" : "User Profile Info (1301017)", "description" : "Inquiring the user profile of the specified user.", "operationId" : "userProfileInfo", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" }, { "name" : "context", "in" : "path", "required" : true, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "user", "required" : false, "schema" : { "$ref" : "#/definitions/User" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataUserProfileViews" } } } }, "put" : { "tags" : [ "User Tasks" ], "summary" : "User Profile Update (1301014)", "description" : "Updating the profile of the specified user.", "operationId" : "userProfileUpdate", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" }, { "name" : "context", "in" : "path", "required" : true, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "user", "required" : false, "schema" : { "$ref" : "#/definitions/User" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataUserProfileViews" } } } } }, "/user/{name}/{context}/profile/{prefix}" : { "get" : { "tags" : [ "User Tasks" ], "summary" : "User Profile Info (1301017)", "description" : "Inquiring the user profile of the specified user.", "operationId" : "userProfileInfoWithPrefix", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" }, { "name" : "context", "in" : "path", "required" : true, "type" : "integer", "format" : "int32" }, { "name" : "prefix", "in" : "path", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "user", "required" : false, "schema" : { "$ref" : "#/definitions/User" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataUser" } } } } }, "/user/{name}/{context}/serviceProfile" : { "get" : { "tags" : [ "User Tasks" ], "summary" : "Service User Profile Info (1301054)", "description" : "Inquiring the service user profile for the specified user.", "operationId" : "serviceUserProfilInfo", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" }, { "name" : "context", "in" : "path", "required" : true, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "user", "required" : false, "schema" : { "$ref" : "#/definitions/User" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataServiceUsersProfile" } } } }, "put" : { "tags" : [ "User Tasks" ], "summary" : "Service User Profile Update (1301052)", "description" : "Updating the service user profile for the specified user.", "operationId" : "serviceUserProfileUpdate", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" }, { "name" : "context", "in" : "path", "required" : true, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "user", "required" : false, "schema" : { "$ref" : "#/definitions/User" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataServiceUsersProfile" } } } } }, "/user/{name}/{context}/serviceProfile/{prefix}" : { "get" : { "tags" : [ "User Tasks" ], "summary" : "Service User Profile (1301054)", "description" : "Inquiring the service user profile for the specified user.", "operationId" : "serviceUserProfilInfoWithPrefix", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" }, { "name" : "context", "in" : "path", "required" : true, "type" : "integer", "format" : "int32" }, { "name" : "prefix", "in" : "path", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "user", "required" : false, "schema" : { "$ref" : "#/definitions/User" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataServiceUsersProfile" } } } } }, "/user/{name}/{context}/verification" : { "post" : { "tags" : [ "User Tasks" ], "summary" : "User Verification Create (1321011)", "description" : "", "operationId" : "userVerificationCreate", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" }, { "name" : "context", "in" : "path", "required" : true, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "auth", "required" : false, "schema" : { "$ref" : "#/definitions/AuthSession" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataAuthSession" } } } } }, "/zone" : { "post" : { "tags" : [ "Zone Tasks" ], "summary" : "Zone Create (0201)", "description" : "Creating a zone.", "operationId" : "zoneCreate", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "zone", "required" : false, "schema" : { "$ref" : "#/definitions/Zone" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataZone" } } } } }, "/zone/_search" : { "post" : { "tags" : [ "Zone Tasks" ], "summary" : "Zone List (0205)", "description" : "Inquiring a list of zones with certain details. The following keys can be used for filtering, ordering and inquiring additional data via query parameter: dnssec, created, mainip, secondary1, secondary2, secondary3, secondary4, secondary5, secondary6, secondary7, virtualNameServer, domainsafe, name, comment, updated, action, primary, changed.", "operationId" : "zoneList", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "query", "required" : false, "schema" : { "$ref" : "#/definitions/Query" } }, { "name" : "keys", "in" : "query", "description" : "The query parameter to fetch additional details.", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?keys[]=primary", "enum" : [ "{dnssec", "created", "mainip", "secondary1", "secondary2", "secondary3", "secondary4", "secondary5", "secondary6", "secondary7", "virtualNameServer", "domainsafe", "name", "comment", "updated", "action", "primary", "changed}" ] }, "collectionFormat" : "multi", "x-example" : "?keys[]=primary" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataZone" } } } } }, "/zone/history/_search" : { "post" : { "tags" : [ "Zone Tasks" ], "summary" : "Zone History List (0225)", "description" : "Inquiring a list of zones history entries with certain details. The following keys can be used for filtering, ordering and inquiring additional data via query parameter: dnssec, created, mainip, secondary1, secondary2, secondary3, secondary4, secondary5, secondary6, secondary7, virtualNameServer, domainsafe, name, comment, updated, action, primary, changed.", "operationId" : "zoneHistoryList", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "query", "required" : false, "schema" : { "$ref" : "#/definitions/Query" } }, { "name" : "keys", "in" : "query", "description" : "The query parameter to fetch additional details.", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?keys[]=primary", "enum" : [ "{dnssec", "created", "mainip", "secondary1", "secondary2", "secondary3", "secondary4", "secondary5", "secondary6", "secondary7", "virtualNameServer", "domainsafe", "name", "comment", "updated", "action", "primary", "changed}" ] }, "collectionFormat" : "multi", "x-example" : "?keys[]=primary" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataZone" } } } } }, "/zone/history/{logId}" : { "get" : { "tags" : [ "Zone Tasks" ], "summary" : "Zone History Info (0224)", "description" : "Inquiring the data for the specified log.", "operationId" : "zoneHistoryInfo", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "logId", "in" : "path", "required" : true, "type" : "integer", "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataZone" } } } } }, "/zone/zoneQuery/_search" : { "post" : { "tags" : [ "Zone Query Tasks" ], "summary" : "Zone Query List (0265)", "description" : "Inquiring a list of zone querys with certain details.", "operationId" : "zoneQueryList", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "in" : "body", "name" : "body", "description" : "query", "required" : false, "schema" : { "$ref" : "#/definitions/Query" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataZoneQuery" } } } } }, "/zone/{name}/_stream" : { "post" : { "tags" : [ "Zone Tasks" ], "summary" : "Zone Stream Update (0202002)", "description" : "Adding or removing records for any zone with the given name.", "operationId" : "zoneStream", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "zoneStream", "required" : false, "schema" : { "$ref" : "#/definitions/ZoneStream" } }, { "name" : "keys", "in" : "query", "description" : "Contains the opional autofix parameter", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?keys[]=autofix", "enum" : [ "{autofix}" ] }, "collectionFormat" : "multi", "x-example" : "?keys[]=autofix" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataZone" } } } } }, "/zone/{name}/{systemNameServer}" : { "get" : { "tags" : [ "Zone Tasks" ], "summary" : "Zone Info (0205)", "description" : "Inquiring the data for the specified zone.", "operationId" : "zoneInfo", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" }, { "name" : "systemNameServer", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataZone" } } } }, "put" : { "tags" : [ "Zone Tasks" ], "summary" : "Zone Update (0202)", "description" : "Updating an existing zone.", "operationId" : "zoneUpdate", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" }, { "name" : "systemNameServer", "in" : "path", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "zone", "required" : false, "schema" : { "$ref" : "#/definitions/Zone" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataZone" } } } }, "delete" : { "tags" : [ "Zone Tasks" ], "summary" : "Zone Delete (0203)", "description" : "Deleting an existing zone.", "operationId" : "zoneDelete", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" }, { "name" : "systemNameServer", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataJsonNoData" } } } }, "patch" : { "tags" : [ "Zone Tasks" ], "summary" : "Zone Update (0202001)", "description" : "Updating an existing zone.", "operationId" : "zonePatch", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" }, { "name" : "systemNameServer", "in" : "path", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "zone", "required" : false, "schema" : { "$ref" : "#/definitions/ZoneBasePatchRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataZone" } } } } }, "/zone/{name}/{systemNameServer}/_axfr" : { "get" : { "tags" : [ "Zone Tasks" ], "summary" : "Zone Axfr (0210)", "description" : "Inquiring the AXFR data for the specified zone.", "operationId" : "zoneAxfr", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" }, { "name" : "systemNameServer", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataString" } } } } }, "/zone/{name}/{systemNameServer}/_comment" : { "put" : { "tags" : [ "Zone Tasks" ], "summary" : "Zone Comment Update (0202004)", "description" : "Updating an existing zone.", "operationId" : "zoneUpdateComment", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" }, { "name" : "systemNameServer", "in" : "path", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "zone", "required" : false, "schema" : { "$ref" : "#/definitions/Zone" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataZone" } } } } }, "/zone/{name}/{systemNameServer}/_copy" : { "put" : { "tags" : [ "Zone Tasks" ], "summary" : "Zone Update (0212)", "description" : "Copying an existing zone.", "operationId" : "zoneCopy", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" }, { "name" : "systemNameServer", "in" : "path", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "zone", "required" : false, "schema" : { "$ref" : "#/definitions/Zone" } }, { "name" : "keys", "in" : "query", "description" : "Defines addtional option for copy of the zone", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?keys[]=replace", "enum" : [ "{replace", "forceOwner}" ] }, "collectionFormat" : "multi", "x-example" : "?keys[]=replace" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataZone" } } } } }, "/zone/{name}/{systemNameServer}/_domainSafe" : { "put" : { "tags" : [ "Zone Tasks" ], "summary" : "Safe Object Create (0601)", "description" : "Adding the zone to the domain safe", "operationId" : "zoneAddDomainSafe", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" }, { "name" : "systemNameServer", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataJsonNoData" } } } }, "delete" : { "tags" : [ "Zone Tasks" ], "summary" : "Safe Object Delete (0603)", "description" : "Deleting the zone from the domain safe", "operationId" : "zoneDeleteDomainSafe", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" }, { "name" : "systemNameServer", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataJsonNoData" } } } } }, "/zone/{name}/{systemNameServer}/_import" : { "post" : { "tags" : [ "Zone Tasks" ], "summary" : "Zone Import (0204)", "description" : "Importing the specified zone.", "operationId" : "zoneImport", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" }, { "name" : "systemNameServer", "in" : "path", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "zone", "required" : false, "schema" : { "$ref" : "#/definitions/Zone" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataZone" } } } } }, "/zone/{name}/{systemNameServer}/_migrate" : { "put" : { "tags" : [ "Zone Tasks" ], "summary" : "Zone Update (0212)", "description" : "Copying an existing zone and updating the domain with the new name servers.", "operationId" : "zoneMigrate", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" }, { "name" : "systemNameServer", "in" : "path", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "zone", "required" : false, "schema" : { "$ref" : "#/definitions/Zone" } }, { "name" : "keys", "in" : "query", "description" : "Defining addtional option for copy of the zone", "required" : false, "type" : "array", "items" : { "type" : "string", "example" : "?keys[]=replace", "enum" : [ "{replace", "forceOwner}" ] }, "collectionFormat" : "multi", "x-example" : "?keys[]=replace" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataObjectJob" } } } } }, "/zone/{name}/{systemNameServer}/zoneQuery/_search" : { "post" : { "tags" : [ "ZoneQuery Tasks" ], "summary" : "Zone Query List (0265)", "description" : "Inquiring a list of zone querys for the given Zone .", "operationId" : "zoneBaseQueryList", "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-Domainrobot-Domain-Safe-Pin", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Domain-Safe-Transaction-Expire", "in" : "header", "required" : false, "type" : "string", "format" : "date-time" }, { "name" : "X-Domainrobot-Domain-Safe-Tan", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-User", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Owner-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-Demo", "in" : "header", "required" : false, "type" : "boolean" }, { "name" : "X-Domainrobot-SessionId", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Context", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-WS", "in" : "header", "required" : false, "type" : "string" }, { "name" : "X-Domainrobot-Bulk-Limit", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "X-Domainrobot-2FA-Token", "in" : "header", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "name", "in" : "path", "required" : true, "type" : "string" }, { "name" : "systemNameServer", "in" : "path", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "query", "required" : false, "schema" : { "$ref" : "#/definitions/Query" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JsonResponseDataZoneQuery" } } } } } }, "definitions" : { "ACLRestriction" : { "type" : "string", "enum" : [ "USER_LOCKED", "CHILDREN_LOCKED", "PARENT_LOCK", "NOT_LOCKED" ] }, "Account" : { "type" : "object", "required" : [ "customer" ], "properties" : { "customer" : { "description" : "The customer object.", "$ref" : "#/definitions/GenericCustomer" }, "currentAccountBalance" : { "type" : "number", "format" : "double", "description" : "The current account balance" }, "runningTotal" : { "type" : "number", "format" : "double", "description" : "The current total, the amount of all finished and unfinished transactions." }, "creditLimit" : { "type" : "number", "format" : "double", "description" : "The credit limit of the account." }, "currency" : { "type" : "string", "example" : "EUR", "description" : "Currency in which the account is held.", "x-custom-type" : "currency" }, "minRunningTotalNotification" : { "type" : "number", "format" : "double", "description" : "The minimum account balance at which a notification should be sent." }, "minRunningTotalNotificationEmail" : { "type" : "string", "description" : "Email address for notification. A notification is sent when the minimum account balance has been reached (minRunningTotalNotification). " }, "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "The date of the last update." }, "view" : { "description" : "The selected exchange for the account.", "$ref" : "#/definitions/CurrencyRate" }, "reserved" : { "type" : "number", "format" : "double", "description" : "Flag indication if the reserved", "readOnly" : true } } }, "AccountingDocumentTypeConstants" : { "type" : "string", "enum" : [ "INVOICE", "CREDIT", "REFUND", "CANCELED", "CHARGE" ] }, "AdoptExpiration" : { "type" : "object", "properties" : { "tlds" : { "type" : "array", "items" : { "type" : "string" } } } }, "Application" : { "type" : "object", "required" : [ "name" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "name" : { "type" : "string", "description" : "The name of the application." }, "functionCodes" : { "type" : "array", "description" : "The function codes for the application.", "uniqueItems" : true, "items" : { "type" : "string" } } } }, "Article" : { "type" : "object", "required" : [ "label", "type" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "owner" : { "description" : "The object owner.", "$ref" : "#/definitions/User" }, "updater" : { "description" : "User who performed the last update.", "$ref" : "#/definitions/User" }, "type" : { "type" : "string", "description" : "type of the article " }, "category" : { "type" : "string", "description" : "category of the article " }, "label" : { "type" : "string", "description" : "name of the article" } } }, "AuEligibilityIdTypeConstants" : { "type" : "string", "enum" : [ "ACN", "ABN", "VIC", "NSW", "SA", "NT", "WA", "TAS", "ACT", "QLD", "TM", "OTHER" ] }, "AuEligibilityTypeConstants" : { "type" : "string", "enum" : [ "COMPANY", "REGISTERED_BUSINESS", "SOLE_TRADER", "PARTNERSHIP", "TRADEMARK_OWNER", "PENDING_TM_OWNER", "CITIZEN_RESIDENT", "INCORPORATED_ASSOCIATION", "UNINCORPORATED_ASSOCIATION", "CLUB", "NON_PROFIT_ORGANISATION", "CHARITY", "TRADE_UNION", "INDUSTRY_BODY", "COMMERCIAL_STATUTORY_BODY", "POLITICAL_PARTY", "RELIGIOUS_CHURCH_GROUPS", "OTHER", "REGISTRABLE_BODY", "INDIGENOUS_CORPORATION", "REGISTERED_ORGANISATION", "COOPERATIVE", "TRUST", "EDUCATIONAL_INSTITUTION", "COMMONWEALTH_ENTITY", "STATUTORY_BODY", "TRADING_COOPERATIVE", "COMPANY_LIMITED_BY_GUARANTEE", "NON_DISTRIBUTING_COOPERATIVE", "NON_TRADING_COOPERATIVE", "CHARITABLE_TRUST", "PUBLIC_PRIVATE_ANCILLARY_FUND", "PEAK_STATE_TERRITORY_BODY", "NOT_FOR_PROFIT_COMMUNITY_GROUP", "FOREIGN_EMBASSY_OR_CONSULATE" ] }, "AuRegistrantIdTypeConstants" : { "type" : "string", "enum" : [ "ACN", "ABN", "OTHER", "TAS", "VIC", "NSW", "ACT", "QLD", "NT", "WA", "SA" ] }, "AuthInfo" : { "type" : "string", "enum" : [ "AUTHINFO1", "AUTHINFO2", "ALL" ] }, "AuthInfo1Location" : { "type" : "string", "enum" : [ "REGISTRAR", "REGISTRY", "REGISTRANT" ] }, "AuthMethodConstants" : { "type" : "string", "enum" : [ "DNS", "EMAIL", "FILE", "ORG" ] }, "AuthSession" : { "type" : "object", "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "owner" : { "description" : "The object owner.", "$ref" : "#/definitions/User" }, "updater" : { "description" : "User who performed the last update.", "$ref" : "#/definitions/User" }, "language" : { "type" : "string", "description" : "The language." }, "configuration" : { "description" : "Additional information", "$ref" : "#/definitions/Configuration" } } }, "AuthType" : { "type" : "string", "enum" : [ "PASSWORD", "PASSWORD_TOKEN", "ALIAS", "INVITE" ] }, "AuthenticateStatus" : { "type" : "string", "enum" : [ "COMPLETED", "ADDITIONAL_INFORMATION_REQUIRED", "IN_PROGRESS", "COMMUNICATION_SENT_TO_CUSTOMER", "ATTEMPTED_TO_REACH_CUSTOMER", "PENDING_CUSTOMER_APPROVAL", "NOT_COMPLETED", "COMPLETED_PASSED", "COMPLETED_FAILED", "UNABLE_TO_COMPLETE", "NOT_STARTED" ] }, "AuthenticationStep" : { "type" : "string", "enum" : [ "DOMAIN_VERIFICATION", "VERIFICATION_CALL", "ORGANIZATION_VERIFICATION", "CONSUMER_AUTHENTICATION", "CERTIFICATE", "CONTACT_CONFIRMED", "VERIFICATION", "CSR_CHECK", "DCV_CHECK", "OV_CALLBACK", "FREE_DVUP", "EV_CLICKTROUGH", "EXTENDED_VERIFICATION" ] }, "AutoDeleteDomain" : { "type" : "object", "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "owner" : { "description" : "The object owner.", "$ref" : "#/definitions/User" }, "updater" : { "description" : "User who performed the last update.", "$ref" : "#/definitions/User" }, "domain" : { "description" : "The domain.", "$ref" : "#/definitions/Domain" }, "changed" : { "type" : "string", "format" : "date-time", "description" : "The updated." }, "nicMemberLabel" : { "type" : "string", "description" : "The nic member label." }, "status" : { "description" : "The status.", "$ref" : "#/definitions/AutoDeleteStatus" }, "paymentLimit" : { "type" : "string", "format" : "date-time", "description" : "The limit of the payment." }, "payable" : { "type" : "string", "format" : "date-time", "description" : "The payable." } } }, "AutoDeleteStatus" : { "type" : "string", "enum" : [ "CONFIRMED", "DELETED", "NOTIFY", "NOTIFY_5", "NOTIFY_10", "NOTIFY_15", "NOTIFY_20", "NOTIFY_30", "NOTIFY_35", "NOTIFY_45", "PENDING", "RENEWED", "RESTORED", "CANCELED" ] }, "AutoRenewStatusConstants" : { "type" : "string", "enum" : [ "TRUE", "FALSE", "ONCE" ] }, "BackupMx" : { "type" : "object", "required" : [ "domain" ], "properties" : { "domain" : { "type" : "string", "description" : "Domain name for which the BackupMX Record is to be created." }, "idn" : { "type" : "string", "description" : "IDN version of the domain name written in Punycode." }, "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "owner" : { "description" : "The object owner.", "$ref" : "#/definitions/User" }, "updater" : { "description" : "User who performed the last update.", "$ref" : "#/definitions/User" } } }, "BasicCertificate" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int32", "description" : "The id of stored certificate" }, "product" : { "type" : "string", "description" : "The certificate product" } } }, "BasicCustomer" : { "type" : "object", "required" : [ "addressLines", "client", "name", "number", "payment" ], "properties" : { "number" : { "type" : "integer", "format" : "int64", "description" : "Customer number" }, "client" : { "type" : "string", "description" : "Account Label.", "minLength" : 1, "maxLength" : 2147483647 }, "group" : { "type" : "integer", "format" : "int64", "example" : 13516, "description" : "Customer group, first 5 numbers of the account number. e.g. " }, "name" : { "type" : "string", "description" : "The name of the customer.", "minLength" : 0, "maxLength" : 255 }, "type" : { "description" : "The type of the customer.", "$ref" : "#/definitions/CustomerType" }, "organization" : { "type" : "string", "description" : "The name of the organization.", "minLength" : 0, "maxLength" : 35 }, "organization2" : { "type" : "string", "description" : "The second line for the name of the organization.", "minLength" : 0, "maxLength" : 35 }, "vatNumber" : { "type" : "string", "description" : "The value added tax number." }, "gender" : { "description" : "The gender of the person.", "$ref" : "#/definitions/GenderConstants" }, "title" : { "type" : "string", "description" : "The title of the customer" }, "addressLines" : { "type" : "array", "description" : "The address of the customer", "items" : { "type" : "string" }, "maxItems" : 2147483647, "minItems" : 0 }, "city" : { "type" : "string", "description" : "The city of the customer." }, "state" : { "type" : "string", "description" : "The state of the customer." }, "country" : { "type" : "string", "description" : "The country of the customer." }, "phone" : { "type" : "string", "example" : "+49-123-12345", "description" : "The phone number of the customer", "x-custom-type" : "phone" }, "fax" : { "type" : "string", "example" : "+49-123-12345", "description" : "The fax number of the customer", "x-custom-type" : "phone" }, "emails" : { "type" : "array", "description" : "The email addresses.", "items" : { "type" : "string" }, "maxItems" : 2147483647, "minItems" : 1 }, "billingEmails" : { "type" : "array", "description" : "The billing recipients.", "items" : { "type" : "string" } }, "payment" : { "description" : "The payment typ of the customer.", "$ref" : "#/definitions/PaymentConstants" }, "paymentMode" : { "type" : "string", "description" : "The payment mode of the customer." }, "paymentCurrency" : { "type" : "string", "example" : "EUR", "description" : "The payment currency of the customer.", "x-custom-type" : "currency" }, "paymentCurrencyExchangeFee" : { "type" : "number", "format" : "float", "description" : "The payment currency exchange fee of the customer." }, "discount" : { "type" : "integer", "format" : "int32", "description" : "The discount of the customer." }, "discountNgtld" : { "type" : "integer", "format" : "int32", "description" : "The discount of the ngtld." }, "discountCertificate" : { "type" : "integer", "format" : "int32", "description" : "The discount of the certificate." }, "discountValid" : { "type" : "string", "format" : "date-time", "description" : "The end of a promo discount." }, "invoiceLanguage" : { "type" : "string", "description" : "The language to use for the invoice." }, "taxable" : { "type" : "boolean", "description" : "The taxable flag of the customer." }, "card" : { "description" : "The customers minimal credit card data if payament was post with credit card.", "$ref" : "#/definitions/Card" }, "contracts" : { "type" : "array", "description" : "The customers contracts.", "items" : { "$ref" : "#/definitions/CustomerContract" } }, "billingUsers" : { "type" : "array", "description" : "The billing users.", "items" : { "$ref" : "#/definitions/User" } }, "comments" : { "type" : "array", "description" : "The comments of the customer", "items" : { "$ref" : "#/definitions/Comment" } }, "contacts" : { "type" : "array", "description" : "The contacts of the customer", "items" : { "$ref" : "#/definitions/BasicCustomerContact" } }, "account" : { "description" : "The account of the customer in case of prepayment or if the customer has a credit limit", "$ref" : "#/definitions/Account" }, "priceListEntities" : { "type" : "array", "description" : "The attached price lists", "items" : { "$ref" : "#/definitions/CustomerPriceList" } }, "addPriceListEntities" : { "type" : "array", "description" : "Used by the update to task to attache new price lists", "items" : { "$ref" : "#/definitions/CustomerPriceList" } }, "remPriceListEntities" : { "type" : "array", "description" : "Used by the update to task to detache price lists", "items" : { "$ref" : "#/definitions/CustomerPriceList" } }, "clearAccount" : { "description" : "The period after the post payment account will be cleared to zero", "$ref" : "#/definitions/ClearAccountPeriod" }, "autodelete" : { "type" : "boolean", "description" : "Flag indication if the customer is autodelete" }, "pending" : { "type" : "boolean", "description" : "Flag indication if the customer data are pending" }, "verifications" : { "type" : "array", "description" : "Shows the pending email verifications", "items" : { "$ref" : "#/definitions/BasicCustomerSpoolVerification" } }, "tags" : { "type" : "array", "description" : "The customers tags.", "items" : { "$ref" : "#/definitions/CustomerTag" } }, "pin" : { "type" : "string", "description" : "The pin number." }, "persistent" : { "description" : "the current customer", "$ref" : "#/definitions/BasicCustomer" }, "active" : { "type" : "boolean", "description" : "Flag indication if the customer is active" }, "fname" : { "type" : "string", "description" : "The first name.", "minLength" : 0, "maxLength" : 35 }, "lname" : { "type" : "string", "description" : "The last name.", "minLength" : 0, "maxLength" : 35 }, "pcode" : { "type" : "string", "description" : "The postal code of the city." }, "technical" : { "description" : "technical Customer.", "$ref" : "#/definitions/TechnicalCustomer" }, "sepa" : { "description" : "The customers sepa mandate if payament was post with sepa.", "$ref" : "#/definitions/SEPAMandate" } } }, "BasicCustomerContact" : { "type" : "object", "required" : [ "customer", "type" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "owner" : { "description" : "The object owner.", "$ref" : "#/definitions/User" }, "updater" : { "description" : "User who performed the last update.", "$ref" : "#/definitions/User" }, "id" : { "type" : "integer", "format" : "int32", "description" : "ID of the domain contact." }, "customer" : { "description" : "Contains basic information that uniquely identifies a customer technically.", "$ref" : "#/definitions/GenericCustomer" }, "type" : { "example" : "BILLING, TECH, PRIMARY, LEGAL", "description" : "Type of domain contact. e.g.", "$ref" : "#/definitions/ContactType" }, "firstName" : { "type" : "string", "description" : "Contact first name." }, "lastName" : { "type" : "string", "description" : "Contact last name." }, "title" : { "type" : "string", "description" : "The title of the contact." }, "label" : { "type" : "string", "description" : "Designation of the contact. In most cases the last name is used." }, "language" : { "type" : "string", "example" : "ES, NL, EN, DE, FR, TR, PT", "description" : "The language for communication with the contact. Supported languages:" }, "gender" : { "description" : "The gender of the contact.", "$ref" : "#/definitions/GenderConstants" }, "postalCode" : { "type" : "string", "description" : "Zip code of the contact address." }, "city" : { "type" : "string", "description" : "The city of the contact." }, "country" : { "type" : "string", "description" : "The country of the contact." }, "state" : { "type" : "string", "description" : "The state of the contact." }, "phone" : { "type" : "string", "example" : "+49-123-12345", "description" : "The phone numbers of the contact", "x-custom-type" : "phone" }, "fax" : { "type" : "string", "example" : "+49-123-12345", "description" : "The fax numbers of the contact", "x-custom-type" : "phone" }, "email" : { "type" : "string", "description" : "The email address of the contact." }, "address" : { "type" : "array", "description" : "The address of the contact.", "items" : { "type" : "string" } } } }, "BasicCustomerSpoolVerification" : { "type" : "object", "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "email" : { "type" : "string", "description" : "The email address to verify" }, "status" : { "description" : "The status of the verification", "$ref" : "#/definitions/GenericStatusConstants" }, "customer" : { "description" : "The related customer", "$ref" : "#/definitions/GenericCustomer" } } }, "BasicDocument" : { "type" : "object", "required" : [ "uuid" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "id" : { "type" : "integer", "format" : "int64", "description" : "The unique identifier of the document" }, "comment" : { "type" : "string", "description" : "Document comment" }, "type" : { "type" : "string", "example" : "- tmchMarkDocument \n - contactDocument", "description" : "Type of document, related to InternetX." }, "mimeType" : { "type" : "string", "example" : "application/pdf (invalid for contact document)\nimage/png\nimage/jpeg \ntext/xml (invalid for contact document)\nimage/gif (invalid for contact document)", "description" : "MIME type (Multipurpose Internet Mail Extensions) \n Which MimeType is valid depends on the type of document" }, "data" : { "type" : "string", "example" : "The file in binary format" }, "size" : { "type" : "integer", "format" : "int64", "description" : "Document size\n(Maximum size for contact documents is 2MB)" }, "name" : { "type" : "string", "description" : "Name of the document. Can be freely chosen" }, "link" : { "type" : "string", "description" : "Link created by Internetx to download invoices." }, "uuid" : { "type" : "string", "description" : "The unique identifier of the document" }, "alias" : { "type" : "string", "description" : "The alias of the document" }, "owner" : { "description" : "The owner of the object.", "$ref" : "#/definitions/User" }, "updater" : { "description" : "The updating user of the object.", "$ref" : "#/definitions/User" }, "expire" : { "type" : "string", "format" : "date-time", "description" : "The expire date." } } }, "BillingEvent" : { "type" : "object", "required" : [ "payable" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "id" : { "type" : "integer", "format" : "int32", "example" : 1, "description" : "The unique identifier of the event" }, "owner" : { "description" : "The object owner.", "$ref" : "#/definitions/User" }, "updater" : { "description" : "User who performed the last update.", "$ref" : "#/definitions/User" }, "status" : { "description" : "Billing status of the subscription.", "$ref" : "#/definitions/BillingStatus" }, "object" : { "type" : "string", "description" : "Name of the subscription or the contract number." }, "description" : { "type" : "string", "description" : "The human readable name of the subscription, e.g. the name of a package" }, "period" : { "description" : "The period used by the subscription, e.g. 1 month", "$ref" : "#/definitions/TimePeriod" }, "articleTypeLabel" : { "type" : "string", "description" : "The article type label of the subscription, e.g. domain" }, "payable" : { "type" : "string", "format" : "date-time", "description" : "The date then the event should be billed." }, "articleLabel" : { "type" : "string", "description" : "The article label of the subscription, e.g. backup_mx" }, "businessCase" : { "type" : "string", "description" : "The businessCase of the subscription, e.g. create" }, "extensions" : { "description" : "Additional information, such as rights and limits.", "$ref" : "#/definitions/BillingEventExtensions" } } }, "BillingEventExtensions" : { "type" : "object", "properties" : { "externalReference" : { "type" : "string" } } }, "BillingLimit" : { "type" : "object", "required" : [ "user" ], "properties" : { "user" : { "$ref" : "#/definitions/User" }, "entries" : { "type" : "array", "items" : { "$ref" : "#/definitions/BillingObjectLimit" } } } }, "BillingObjectLimit" : { "type" : "object", "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "articleLabel" : { "type" : "string", "example" : "com, de", "description" : "Article name. e.g." }, "limitSelf" : { "type" : "integer", "format" : "int32", "description" : "Limits of the user, of the daily, hourly or monthly ordering amount in currency." }, "limitChildren" : { "type" : "integer", "format" : "int32", "description" : "Limits of the sub user, of the daily, hourly or monthly ordering amount in currency." }, "articleTypeLabel" : { "type" : "string", "example" : "domain", "description" : "Article Type designation e.g." }, "count" : { "type" : "integer", "format" : "int32", "description" : "The current count if available of allowed api requests in a specific timeframe" } } }, "BillingObjectTerm" : { "type" : "object", "required" : [ "cancelation", "customer", "initial", "renew" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "owner" : { "description" : "The object owner.", "$ref" : "#/definitions/User" }, "updater" : { "description" : "User who performed the last update.", "$ref" : "#/definitions/User" }, "cancelation" : { "$ref" : "#/definitions/TimePeriod" }, "cancelationExpireOnly" : { "type" : "boolean" }, "initial" : { "$ref" : "#/definitions/TimePeriod" }, "renew" : { "$ref" : "#/definitions/TimePeriod" }, "renewTerm" : { "$ref" : "#/definitions/TimePeriod" }, "customer" : { "description" : "the related customer or group", "$ref" : "#/definitions/GenericCustomer" }, "articleTypeLabel" : { "type" : "string", "description" : "The label of the article group" }, "articleLabel" : { "type" : "string", "description" : "The label of the articel, e.g. domain" }, "autodeleteable" : { "type" : "boolean", "description" : "Flag indication if the article can be autodeleted" }, "restoreable" : { "type" : "boolean", "description" : "Flag indication if the article can be restored" } } }, "BillingObjectTerms" : { "type" : "object", "properties" : { "billingObjectTerms" : { "type" : "array", "items" : { "$ref" : "#/definitions/BillingObjectTerm" } } } }, "BillingStatus" : { "type" : "string", "enum" : [ "ADD", "REMOVE", "UPDATE", "IGNORE", "CUSTOMER_CHANGED", "USER_CHANGED", "UPGRADE", "ACTIVE", "CANCELED", "CANCELED_EXPIRE", "RESTORE", "AUTODELETE", "REMOVED", "DROP" ] }, "BillingTerm" : { "type" : "object", "properties" : { "terms" : { "type" : "array", "items" : { "$ref" : "#/definitions/BillingTldTerm" } } } }, "BillingTldTerm" : { "type" : "object" }, "BulkBackupMxDeleteRequest" : { "type" : "object", "properties" : { "objects" : { "type" : "array", "description" : "The objects to process", "items" : { "$ref" : "#/definitions/BackupMx" } }, "query" : { "description" : "The query to fetch the object instead of defined list", "$ref" : "#/definitions/Query" } } }, "BulkBackupMxPostRequest" : { "type" : "object", "properties" : { "objects" : { "type" : "array", "description" : "The objects to process", "items" : { "$ref" : "#/definitions/BackupMx" } }, "template" : { "description" : "The template for objects to process", "$ref" : "#/definitions/BackupMx" } } }, "BulkBillingEventDeleteRequest" : { "type" : "object", "properties" : { "objects" : { "type" : "array", "description" : "The objects to process", "items" : { "$ref" : "#/definitions/BillingEvent" } }, "query" : { "description" : "The query to fetch the object instead of defined list", "$ref" : "#/definitions/Query" } } }, "BulkBillingEventDropRequest" : { "type" : "object", "properties" : { "objects" : { "type" : "array", "description" : "The objects to process", "items" : { "$ref" : "#/definitions/BillingEvent" } }, "query" : { "description" : "The query to fetch the object instead of defined list", "$ref" : "#/definitions/Query" } } }, "BulkBillingEventReactivateRequest" : { "type" : "object", "properties" : { "objects" : { "type" : "array", "description" : "The objects to process", "items" : { "$ref" : "#/definitions/BillingEvent" } }, "query" : { "description" : "The query to fetch the object instead of defined list", "$ref" : "#/definitions/Query" } } }, "BulkBillingEventRejectRequest" : { "type" : "object", "properties" : { "objects" : { "type" : "array", "description" : "The objects to process", "items" : { "$ref" : "#/definitions/BillingEvent" } }, "query" : { "description" : "The query to fetch the object instead of defined list", "$ref" : "#/definitions/Query" } } }, "BulkCertificateDeleteRequest" : { "type" : "object", "properties" : { "objects" : { "type" : "array", "description" : "The objects to process", "items" : { "$ref" : "#/definitions/Certificate" } }, "query" : { "description" : "The query to fetch the object instead of defined list", "$ref" : "#/definitions/Query" } } }, "BulkCertificatePatchRequest" : { "type" : "object", "properties" : { "objects" : { "type" : "array", "description" : "The objects to process", "items" : { "$ref" : "#/definitions/Certificate" } }, "query" : { "description" : "The query to fetch the object instead of defined list", "$ref" : "#/definitions/Query" } } }, "BulkCertificatePostRequest" : { "type" : "object", "properties" : { "objects" : { "type" : "array", "description" : "The objects to process", "items" : { "$ref" : "#/definitions/Certificate" } }, "query" : { "description" : "The query to fetch the object instead of defined list", "$ref" : "#/definitions/Query" } } }, "BulkContactDeleteRequest" : { "type" : "object", "properties" : { "objects" : { "type" : "array", "description" : "The objects to process", "items" : { "$ref" : "#/definitions/Contact" } }, "query" : { "description" : "The query to fetch the object instead of defined list", "$ref" : "#/definitions/Query" } } }, "BulkCustomerPriceListDeleteRequest" : { "type" : "object", "properties" : { "objects" : { "type" : "array", "description" : "The objects to process", "items" : { "$ref" : "#/definitions/CustomerPriceList" } }, "template" : { "description" : "The template for objects to process", "$ref" : "#/definitions/CustomerPriceList" }, "query" : { "description" : "The query to fetch the object instead of defined list", "$ref" : "#/definitions/Query" } } }, "BulkCustomerPriceListPostRequest" : { "type" : "object", "properties" : { "objects" : { "type" : "array", "description" : "The objects to process", "items" : { "$ref" : "#/definitions/CustomerPriceList" } }, "template" : { "description" : "The template for objects to process", "$ref" : "#/definitions/CustomerPriceList" }, "query" : { "description" : "The query to fetch the object instead of defined list", "$ref" : "#/definitions/Query" }, "options" : { "type" : "array", "description" : "The objects to process", "items" : { "$ref" : "#/definitions/CustomerPriceList" } } } }, "BulkDomainCancelationDeleteRequest" : { "type" : "object", "properties" : { "objects" : { "type" : "array", "description" : "The objects to process", "items" : { "$ref" : "#/definitions/DomainCancelation" } }, "query" : { "description" : "The query to fetch the object instead of defined list", "$ref" : "#/definitions/Query" } } }, "BulkDomainCancelationPatchRequest" : { "type" : "object", "properties" : { "objects" : { "type" : "array", "description" : "The objects to process", "items" : { "$ref" : "#/definitions/DomainCancelation" } }, "template" : { "description" : "The template for objects to process", "$ref" : "#/definitions/DomainCancelation" }, "query" : { "description" : "The query to fetch the object instead of defined list", "$ref" : "#/definitions/Query" } } }, "BulkDomainCancelationPostRequest" : { "type" : "object", "properties" : { "objects" : { "type" : "array", "description" : "The objects to process", "items" : { "$ref" : "#/definitions/DomainCancelation" } }, "template" : { "description" : "The template for objects to process", "$ref" : "#/definitions/DomainCancelation" } } }, "BulkDomainCommentRequest" : { "type" : "object", "properties" : { "objects" : { "type" : "array", "description" : "The objects to process", "items" : { "$ref" : "#/definitions/Domain" } }, "template" : { "description" : "The template for objects to process", "$ref" : "#/definitions/Domain" }, "query" : { "description" : "The query to fetch the object instead of defined list", "$ref" : "#/definitions/Query" } } }, "BulkDomainDeleteRequest" : { "type" : "object", "properties" : { "objects" : { "type" : "array", "description" : "The objects to process", "items" : { "$ref" : "#/definitions/Domain" } }, "query" : { "description" : "The query to fetch the object instead of defined list", "$ref" : "#/definitions/Query" } } }, "BulkDomainPatchRequest" : { "type" : "object", "properties" : { "objects" : { "type" : "array", "description" : "The objects to process", "items" : { "$ref" : "#/definitions/Domain" } }, "template" : { "description" : "The template for objects to process", "$ref" : "#/definitions/Domain" }, "query" : { "description" : "The query to fetch the object instead of defined list", "$ref" : "#/definitions/Query" }, "modifiers" : { "type" : "array", "description" : "The modifer to apply on the objects", "items" : { "$ref" : "#/definitions/Modifier" } } } }, "BulkDomainPostRequest" : { "type" : "object", "properties" : { "objects" : { "type" : "array", "description" : "The objects to process", "items" : { "$ref" : "#/definitions/Domain" } }, "template" : { "description" : "The template for objects to process", "$ref" : "#/definitions/Domain" } } }, "BulkDomainPreregDeleteRequest" : { "type" : "object", "properties" : { "objects" : { "type" : "array", "description" : "The objects to process", "items" : { "$ref" : "#/definitions/DomainPrereg" } }, "query" : { "description" : "The query to fetch the object instead of defined list", "$ref" : "#/definitions/Query" } } }, "BulkDomainPreregPatchRequest" : { "type" : "object", "properties" : { "objects" : { "type" : "array", "description" : "The objects to process", "items" : { "$ref" : "#/definitions/DomainPrereg" } }, "template" : { "description" : "The template for objects to process", "$ref" : "#/definitions/DomainPrereg" }, "query" : { "description" : "The query to fetch the object instead of defined list", "$ref" : "#/definitions/Query" } } }, "BulkDomainPreregPostRequest" : { "type" : "object", "properties" : { "objects" : { "type" : "array", "description" : "The objects to process", "items" : { "$ref" : "#/definitions/DomainPrereg" } }, "template" : { "description" : "The template for objects to process", "$ref" : "#/definitions/DomainPrereg" } } }, "BulkDomainSafeContactRequest" : { "type" : "object", "properties" : { "objects" : { "type" : "array", "description" : "The objects to process", "items" : { "$ref" : "#/definitions/Contact" } }, "query" : { "description" : "The query to fetch the object instead of defined list", "$ref" : "#/definitions/Query" } } }, "BulkDomainSafeDomainRequest" : { "type" : "object", "properties" : { "objects" : { "type" : "array", "description" : "The objects to process", "items" : { "$ref" : "#/definitions/Domain" } }, "query" : { "description" : "The query to fetch the object instead of defined list", "$ref" : "#/definitions/Query" } } }, "BulkDomainSafeZoneRequest" : { "type" : "object", "properties" : { "objects" : { "type" : "array", "description" : "The objects to process", "items" : { "$ref" : "#/definitions/Zone" } }, "query" : { "description" : "The query to fetch the object instead of defined list", "$ref" : "#/definitions/Query" } } }, "BulkExternalCustomerDeleteRequest" : { "type" : "object", "properties" : { "objects" : { "type" : "array", "description" : "The objects to process", "items" : { "$ref" : "#/definitions/ExternalCustomer" } }, "template" : { "description" : "The template for objects to process", "$ref" : "#/definitions/ExternalCustomer" }, "query" : { "description" : "The query to fetch the object instead of defined list", "$ref" : "#/definitions/Query" } } }, "BulkExternalCustomerPostRequest" : { "type" : "object", "properties" : { "objects" : { "type" : "array", "description" : "The objects to process", "items" : { "$ref" : "#/definitions/ExternalCustomer" } }, "template" : { "description" : "The template for objects to process", "$ref" : "#/definitions/ExternalCustomer" }, "query" : { "description" : "The query to fetch the object instead of defined list", "$ref" : "#/definitions/Query" } } }, "BulkMailProxyDeleteRequest" : { "type" : "object", "properties" : { "objects" : { "type" : "array", "description" : "The objects to process", "items" : { "$ref" : "#/definitions/MailProxy" } }, "query" : { "description" : "The query to fetch the object instead of defined list", "$ref" : "#/definitions/Query" } } }, "BulkMailProxyPatchRequest" : { "type" : "object", "properties" : { "objects" : { "type" : "array", "description" : "The objects to process", "items" : { "$ref" : "#/definitions/MailProxy" } }, "template" : { "description" : "The template for objects to process", "$ref" : "#/definitions/MailProxy" }, "query" : { "description" : "The query to fetch the object instead of defined list", "$ref" : "#/definitions/Query" } } }, "BulkMailProxyPostRequest" : { "type" : "object", "properties" : { "objects" : { "type" : "array", "description" : "The objects to process", "items" : { "$ref" : "#/definitions/MailProxy" } }, "template" : { "description" : "The template for objects to process", "$ref" : "#/definitions/MailProxy" } } }, "BulkObjectUserAssignmentPatchRequest" : { "type" : "object", "properties" : { "objects" : { "type" : "array", "description" : "The objects to process", "items" : { "$ref" : "#/definitions/ObjectUserAssignment" } }, "template" : { "description" : "The template for objects to process", "$ref" : "#/definitions/ObjectUserAssignment" } } }, "BulkPriceDeleteRequest" : { "type" : "object", "properties" : { "objects" : { "type" : "array", "description" : "The objects to process", "items" : { "$ref" : "#/definitions/Price" } }, "query" : { "description" : "The query to fetch the object instead of defined list", "$ref" : "#/definitions/Query" } } }, "BulkPricePatchRequest" : { "type" : "object", "properties" : { "objects" : { "type" : "array", "description" : "The objects to process", "items" : { "$ref" : "#/definitions/Price" } }, "template" : { "description" : "The template for objects to process", "$ref" : "#/definitions/Price" } } }, "BulkPricePostRequest" : { "type" : "object", "properties" : { "objects" : { "type" : "array", "description" : "The objects to process", "items" : { "$ref" : "#/definitions/Price" } }, "template" : { "description" : "The template for objects to process", "$ref" : "#/definitions/Price" } } }, "BulkRedirectDeleteRequest" : { "type" : "object", "properties" : { "objects" : { "type" : "array", "description" : "The objects to process", "items" : { "$ref" : "#/definitions/Redirect" } }, "query" : { "description" : "The query to fetch the object instead of defined list", "$ref" : "#/definitions/Query" } } }, "BulkRedirectPatchRequest" : { "type" : "object", "properties" : { "objects" : { "type" : "array", "description" : "The objects to process", "items" : { "$ref" : "#/definitions/Redirect" } }, "template" : { "description" : "The template for objects to process", "$ref" : "#/definitions/Redirect" }, "query" : { "description" : "The query to fetch the object instead of defined list", "$ref" : "#/definitions/Query" } } }, "BulkRedirectPostRequest" : { "type" : "object", "properties" : { "objects" : { "type" : "array", "description" : "The objects to process", "items" : { "$ref" : "#/definitions/Redirect" } }, "template" : { "description" : "The template for objects to process", "$ref" : "#/definitions/Redirect" } } }, "BulkSslContactDeleteRequest" : { "type" : "object", "properties" : { "objects" : { "type" : "array", "description" : "The objects to process", "items" : { "$ref" : "#/definitions/SslContact" } }, "query" : { "description" : "The query to fetch the object instead of defined list", "$ref" : "#/definitions/Query" } } }, "BulkZoneCommentRequest" : { "type" : "object", "properties" : { "objects" : { "type" : "array", "description" : "The objects to process", "items" : { "$ref" : "#/definitions/Zone" } }, "template" : { "description" : "The template for objects to process", "$ref" : "#/definitions/Zone" }, "query" : { "description" : "The query to fetch the object instead of defined list", "$ref" : "#/definitions/Query" } } }, "BulkZoneDeleteRequest" : { "type" : "object", "properties" : { "objects" : { "type" : "array", "description" : "The objects to process", "items" : { "$ref" : "#/definitions/Zone" } }, "query" : { "description" : "The query to fetch the object instead of defined list", "$ref" : "#/definitions/Query" } } }, "BulkZonePatchRequest" : { "type" : "object", "properties" : { "objects" : { "type" : "array", "description" : "The objects to process", "items" : { "$ref" : "#/definitions/ZoneBasePatchRequest" } }, "template" : { "description" : "The template for objects to process", "$ref" : "#/definitions/ZoneBasePatchRequest" }, "query" : { "description" : "The query to fetch the object instead of defined list", "$ref" : "#/definitions/Query" }, "modifiers" : { "type" : "array", "description" : "The modifer to apply on the objects", "items" : { "$ref" : "#/definitions/Modifier" } } } }, "BulkZonePostRequest" : { "type" : "object", "properties" : { "objects" : { "type" : "array", "description" : "The objects to process", "items" : { "$ref" : "#/definitions/Zone" } }, "template" : { "description" : "The template for objects to process", "$ref" : "#/definitions/Zone" } } }, "BusinessCase" : { "type" : "object", "required" : [ "label" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "label" : { "type" : "string", "description" : "The unique identifier" } } }, "BusinessCategory" : { "type" : "string", "enum" : [ "PRIVATE_ORGANIZATION", "GOVERNMENT_ENTITY", "BUSINESS_ENTITY" ] }, "CaCertificate" : { "type" : "object", "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "caType" : { "type" : "string", "description" : "The type of the intermediate certificate." }, "caCertificate" : { "type" : "string", "description" : "The plain intermediate certificate." } } }, "CancelationStatusConstants" : { "type" : "string", "enum" : [ "DELETE", "DELETE_EXPIRE", "TRANSIT", "TRANSIT_EXPIRE", "PREACK", "PREACK_EXPIRE" ] }, "CancelationTypeConstants" : { "type" : "string", "enum" : [ "DELETE", "TRANSIT", "PREACK" ] }, "Card" : { "type" : "object", "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "provider" : { "description" : "The provider", "$ref" : "#/definitions/Provider" }, "type" : { "description" : "The credit card vendor", "$ref" : "#/definitions/CreditCardVendor" }, "status" : { "description" : "Credit card status", "$ref" : "#/definitions/CardStatus" }, "validFrom" : { "type" : "string", "format" : "date-time", "description" : "Start of the credit card validity period" }, "validTo" : { "type" : "string", "format" : "date-time", "description" : "End of the credit card validity period" } } }, "CardStatus" : { "type" : "string", "enum" : [ "LOST", "EXPIRED", "ACTIVE" ] }, "CertAuthentication" : { "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "The domain name the authentication data belongs to." }, "method" : { "description" : "The authentication method.", "$ref" : "#/definitions/AuthMethodConstants" }, "dns" : { "type" : "string", "description" : "The dns entry for dns based authentication. A zone record as string." }, "fileName" : { "type" : "string", "description" : "The filename for file based authentication." }, "fileContent" : { "type" : "string", "description" : "The content for file based authentication." }, "approverEmails" : { "type" : "array", "description" : "The approver addresses for email based authentication.", "items" : { "type" : "string" } }, "provisioning" : { "type" : "boolean", "example" : false, "description" : "Automatic zone provisioning for DNS validation." }, "domains" : { "type" : "array", "description" : "The authentication data for every domain.", "items" : { "$ref" : "#/definitions/CertAuthentication" } }, "scope" : { "description" : "The authentication scope.", "$ref" : "#/definitions/DcvValidationScope" }, "status" : { "description" : "The status of the DCV.", "$ref" : "#/definitions/AuthenticateStatus" } } }, "CertAuthenticationStatus" : { "type" : "object", "properties" : { "status" : { "description" : "The status of the authentication step.", "$ref" : "#/definitions/AuthenticateStatus" }, "step" : { "description" : "The authentication step.", "$ref" : "#/definitions/AuthenticationStep" }, "updated" : { "type" : "string", "format" : "date-time", "description" : "The date of the last modification" } } }, "Certificate" : { "type" : "object", "required" : [ "lifetime", "product" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "owner" : { "description" : "The object owner.", "$ref" : "#/definitions/User" }, "updater" : { "description" : "User who performed the last update.", "$ref" : "#/definitions/User" }, "id" : { "type" : "integer", "format" : "int32", "description" : "The ID of the certificate" }, "partnerOrderId" : { "type" : "string", "description" : "The order number of the related request" }, "orderId" : { "type" : "string", "description" : "The unique certificate order number" }, "adminContact" : { "description" : "The administrative contact", "$ref" : "#/definitions/SslContact" }, "technicalContact" : { "description" : "The technical contact", "$ref" : "#/definitions/SslContact" }, "name" : { "type" : "string", "description" : "The name of the certificate" }, "lifetime" : { "description" : "The certificate term in months", "$ref" : "#/definitions/TimePeriod" }, "software" : { "description" : "The webserver software in use, relevant values: 'II5' for Mircosoft, 'APACHE2' for Linux", "$ref" : "#/definitions/ServerSoftwareTypeConstants" }, "comment" : { "type" : "string", "description" : "A custom field. Can only be updated via PUT /certificate/{id}/_comment. Requires appropriate ACLs." }, "csr" : { "type" : "string", "description" : "CSR - Key (Certificate Signing Request)" }, "server" : { "type" : "string", "description" : "The certificate" }, "serialNumber" : { "type" : "string", "description" : "Serial number of the certificate" }, "product" : { "type" : "string", "description" : "The ordered product" }, "codeSigningType" : { "description" : "The type of code signing", "$ref" : "#/definitions/CodeSigningType" }, "codeSigningProvisioningMethod" : { "description" : "The provisioning method for the code signing token. Only for DigiCert products!", "$ref" : "#/definitions/DigiCertCodeSigningProvisioningMethod" }, "codeSigningHardwarePlatform" : { "description" : "The hardware platform for the code signing token for DigiCert codesigning products.", "$ref" : "#/definitions/DigiCertCodeSigningHardwarePlatform" }, "globalSignPickupMethod" : { "description" : "The pickup method for globalsign products.", "$ref" : "#/definitions/GlobalSignPickupMethod" }, "hardwareInitToken" : { "type" : "string", "description" : "The token for initializing a EV CodeSigning" }, "certificateType" : { "description" : "The type of the certificate", "$ref" : "#/definitions/CertificateType" }, "signatureHashAlgorithm" : { "description" : "The signature hash algorithm which was used", "$ref" : "#/definitions/SignatureHashAlgorithmConstants" }, "expire" : { "type" : "string", "format" : "date-time", "description" : "The notAfter date of the certificate" }, "payable" : { "type" : "string", "format" : "date-time", "description" : "The payable date for the certificate. Indicates when a runtime renewal must take place." }, "extension" : { "description" : "The certificate extensions for comodo.", "$ref" : "#/definitions/ExtendedValidationExtension" }, "subjectAlternativeNames" : { "type" : "array", "description" : "Subject Alternative Names (SANs)", "items" : { "$ref" : "#/definitions/SubjectAlternativeName" } }, "histories" : { "type" : "array", "description" : "The history of the certificate (old certificate versions)", "items" : { "$ref" : "#/definitions/CertificateHistory" } }, "certificationAuthority" : { "type" : "array", "description" : "The certificate authority chain", "items" : { "$ref" : "#/definitions/CaCertificate" } }, "password" : { "type" : "string", "description" : "The password that is to be used for the certificate download. Only for S/MIME!", "pattern" : "^[a-zA-Z0-9]{8,32}$" }, "firstname" : { "type" : "string", "description" : "First Name. Only for S/MIME!" }, "lastname" : { "type" : "string", "description" : "Last Name. Only for S/MIME!" }, "technicalContactEmail" : { "type" : "string", "description" : "The technical contact email address. Only used in realtime orders!" }, "organizationUnitName" : { "type" : "string", "description" : "The organization unit. Only for S/MIME!" }, "authentication" : { "description" : "The authentication of the certificate", "$ref" : "#/definitions/CertAuthentication" }, "certificateTransparency" : { "type" : "boolean", "description" : "Activates the certificate transparency for a certificate. Default is \"True\"." }, "certificateTransparencyPrivacy" : { "description" : "The privacy settings for certificate transparency. Default is \"Redacted\".", "$ref" : "#/definitions/CertificateTransparencyPrivacyConstants" }, "domain" : { "type" : "string", "description" : "The domain, which the redirect belongs." }, "hasCsr" : { "type" : "boolean", "description" : "States if a self created CSR is to be used for S/MIME. Default is false. Only for S/MIME!" }, "fortify" : { "type" : "boolean", "description" : "States the certificate should be issued via the Fortify app. Default is false. Only for GlobalSign code and document signing products!" }, "idn" : { "type" : "string", "description" : "The IDN version of the URL of the target domain." }, "multiyear" : { "type" : "boolean", "description" : "Defines whether the certificate is a multiyear or not" }, "reissueRequired" : { "type" : "boolean", "description" : "Defines whether a reissue is required for this certificate" }, "reissueStatus" : { "type" : "string", "description" : "Describes the status of a reissue for this certificate" }, "vmcLogo" : { "type" : "string", "description" : "The base64 encoded SVG logo" }, "vmcTrademarkRegistrationNumber" : { "type" : "string", "description" : "The trademark registration number" }, "vmcTrademarkCountryOrRegion" : { "description" : "Two-letter code for the country or region where the logo is trademarked", "$ref" : "#/definitions/VmcTrademarkCountryOrRegion" }, "keyAttestation" : { "type" : "string", "description" : "Base64 encoded Proof that the keypair has been generated. Only for Sectigo Codesigning products!" }, "hsmType" : { "description" : "Hardware type used to generate the keypair in a non-exportable format, CSR and key attestation. Only for Sectigo Codesigning products!", "$ref" : "#/definitions/SectigoHsmType" } } }, "CertificateData" : { "type" : "object", "properties" : { "plain" : { "type" : "string", "description" : "The CSR key as a string." }, "name" : { "type" : "string", "description" : "The name of the certificate which is contained within the CSR key." }, "subjectAlternativeNames" : { "type" : "array", "description" : "The SubjectAlternativeNames contained within the CSR key.", "items" : { "$ref" : "#/definitions/SubjectAlternativeName" } }, "histories" : { "type" : "array", "description" : "The certificate history (old version).", "items" : { "$ref" : "#/definitions/CertificateHistory" } }, "keySize" : { "type" : "integer", "format" : "int32", "description" : "The key length of the CSR key." }, "countryCode" : { "type" : "string", "description" : "The country code which is contained within the CSR key." }, "challengePassword" : { "type" : "string", "description" : "The password defined in the csr." }, "state" : { "type" : "string", "description" : "The state defined in the csr." }, "city" : { "type" : "string", "description" : "The city contained within the CSR key." }, "organization" : { "type" : "string", "description" : "The organisation contained within the CSR key." }, "organizationUnit" : { "type" : "string", "description" : "The organisation contained within the CSR key." }, "email" : { "type" : "string", "description" : "The email address contained within the CSR key." }, "product" : { "type" : "string", "description" : "The SSL product." }, "authentication" : { "type" : "array", "description" : "The generated authentication data.", "items" : { "$ref" : "#/definitions/CertAuthentication" } }, "algorithm" : { "description" : "The algorithm used in the CSR key.", "$ref" : "#/definitions/CsrHashAlgorithmConstants" }, "signatureHashAlgorithm" : { "description" : "The hash algorithm which was used for the CSR.", "$ref" : "#/definitions/SignatureHashAlgorithmConstants" }, "certificate" : { "description" : "The certificate.", "$ref" : "#/definitions/Certificate" }, "idn" : { "type" : "string", "description" : "The common name written in punycode format." }, "checkCaa" : { "type" : "boolean", "description" : "Activates the CAA record check.\nfalse = off\ntrue = on\nDefault value = false" }, "businessCase" : { "type" : "string", "description" : "Describes the business case (CREATE, RENEW, REISSUE, DELETE) for which preparation is to be performed." }, "ecCurve" : { "description" : "The ec curve of the public key.", "$ref" : "#/definitions/CsrHashAlgorithmConstants" }, "vmcLogo" : { "type" : "string", "description" : "The base64 encoded SVG logo" }, "vmcTrademarkRegistrationNumber" : { "type" : "string", "description" : "The trademark registration number" }, "vmcTrademarkCountryOrRegion" : { "description" : "Two-letter code for the country or region where the logo is trademarked", "$ref" : "#/definitions/VmcTrademarkCountryOrRegion" }, "scope" : { "description" : "The DCV scope to use for generating the dcv data", "$ref" : "#/definitions/DcvValidationScope" }, "hasMultiValueDN" : { "type" : "boolean", "description" : "Describes whether the CSR contains multi value DN data" }, "validSignature" : { "type" : "boolean", "description" : "Describes whether the CSR contains a valid signature or not" }, "includedSans" : { "type" : "array", "description" : "Included subject alternativ names for the current order", "items" : { "type" : "string" } } } }, "CertificateHistory" : { "type" : "object", "properties" : { "serialNumber" : { "type" : "string", "description" : "The serialnumber of the certificate." }, "orderId" : { "type" : "string", "description" : "The unique certificate order number" }, "revoked" : { "type" : "string", "format" : "date-time", "description" : "The revoked date of the certificate." } } }, "CertificateInstallCheckData" : { "type" : "object", "properties" : { "ip" : { "type" : "string", "description" : "The ip that was checked" }, "secured" : { "type" : "boolean", "description" : "Defines wether the hostname name is secured by a certificate or not" }, "redirect" : { "type" : "boolean", "description" : "Defines wether the server behind the hostname has a automated redirect to https" }, "redirectMatch" : { "type" : "boolean", "description" : "Defines wether the certificate at the end of a redirect matches the certificate under https" }, "caa" : { "type" : "boolean", "description" : "Describes whether the zone associated with the hostname contains a CAA record." }, "multipleCaa" : { "type" : "boolean", "description" : "Describes whether the zone associated with the hostname contains multiple CAA records." }, "selfSigned" : { "type" : "boolean", "description" : "Describes whether the hostname is secured by a self signed certificate." }, "chainOk" : { "type" : "boolean", "description" : "Defines wether the certificate chain is installed in a correct way" }, "inventory" : { "type" : "boolean", "description" : "Defines wether a certificate with the same serial number was found within the owned inventory" }, "certificate" : { "description" : "The corresponding certificate from the portfolio", "$ref" : "#/definitions/Certificate" }, "tls" : { "type" : "array", "example" : "SSL_V1, TLS1.0, TLS1.1, TLS1.2, TLS1.3", "description" : "The supported tls version by server behind the hostname", "items" : { "$ref" : "#/definitions/TlsData" } }, "certificateData" : { "description" : "Then data of the certificate installed on the server", "$ref" : "#/definitions/X509CertificateData" }, "redirectCertificateData" : { "description" : "Then data of the redirect certificate installed on the server", "$ref" : "#/definitions/X509CertificateData" }, "chain" : { "type" : "array", "description" : "Then certificate chain", "items" : { "$ref" : "#/definitions/X509CertificateData" } }, "notices" : { "type" : "array", "description" : "Notices for the check", "items" : { "$ref" : "#/definitions/CertificateInstallCheckNotice" } } } }, "CertificateInstallCheckNotice" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The type of the notice" }, "label" : { "type" : "string", "description" : "The label of the notice" }, "value" : { "type" : "string", "description" : "The value of the notice" } } }, "CertificateInstallCheckRequest" : { "type" : "object", "properties" : { "hostname" : { "type" : "string", "description" : "The hostname to check" } } }, "CertificateInstallCheckResult" : { "type" : "object", "properties" : { "hostname" : { "type" : "string", "description" : "The hostname to check" }, "data" : { "type" : "array", "description" : "The data for the check", "items" : { "$ref" : "#/definitions/CertificateInstallCheckData" } } } }, "CertificateTransparencyPrivacyConstants" : { "type" : "string", "enum" : [ "PUBLIC", "REDACTED" ] }, "CertificateType" : { "type" : "string", "enum" : [ "FQDN", "MAIL", "CODE", "DOCUMENT", "VMC" ] }, "Charset" : { "type" : "string", "enum" : [ "BIG5", "EUC_JP", "EUC_KR", "ISCII", "KOI8_R", "KOI8_U", "SHIFT_JIS", "TIS_620", "ISO_8859_1", "ISO_8859_7" ] }, "CiraCprConstants" : { "type" : "string", "enum" : [ "CCT", "RES", "CCO", "ABO", "TDM", "MAJ", "GOV", "LGR", "TRS", "PRT", "ASS", "TRD", "PLT", "EDU", "LAM", "HOP", "INB", "OMK" ] }, "ClearAccountPeriod" : { "type" : "string", "enum" : [ "DAY", "MONTH", "BILL", "WEEK", "NONE" ] }, "CodeSigningType" : { "type" : "string", "enum" : [ "JAVASOFT", "MS_AUTHENTICODE", "VBA", "ADOBE_AIR", "APPLE", "MOZILLA", "OTHER" ] }, "Comment" : { "type" : "object", "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "id" : { "type" : "integer", "format" : "int32", "description" : "The id." }, "customer" : { "$ref" : "#/definitions/GenericCustomer" }, "text" : { "type" : "string" }, "user" : { "$ref" : "#/definitions/User" } } }, "Condition" : { "type" : "object", "properties" : { "text" : { "type" : "string" }, "language" : { "type" : "string" } } }, "ConditionType" : { "type" : "string", "enum" : [ "AND", "OR" ] }, "Configuration" : { "type" : "object" }, "Contact" : { "type" : "object", "required" : [ "address", "city", "country", "lname", "pcode", "type" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "id" : { "type" : "integer", "format" : "int32", "example" : 1, "description" : "The unique identifier of the contact" }, "owner" : { "description" : "The object owner.", "$ref" : "#/definitions/User" }, "updater" : { "description" : "User who performed the last update.", "$ref" : "#/definitions/User" }, "alias" : { "type" : "string", "example" : "John-Doe-1", "description" : "A string that is either automatically generated when an alias is not sent or a self-defined string that can be set by the user for the purpose of identifying the domain contact." }, "type" : { "description" : "Domain contact type", "$ref" : "#/definitions/ContactTypeConstants" }, "organization" : { "type" : "string", "example" : "Company", "description" : "The name of the organization" }, "title" : { "type" : "string", "example" : "Dr.", "description" : "A prefix to a person’s name." }, "city" : { "type" : "string", "example" : "Anytown", "description" : "The city of the contact" }, "country" : { "type" : "string", "example" : "DE", "description" : "Country (ISO 3166-1 alpha-2). \n Country Code. \n Certain strings, such as \"Germany\", are mapped to DE.", "x-custom-type" : "country" }, "state" : { "type" : "string", "example" : "BY", "description" : "The local country state of the contact", "x-custom-type" : "state" }, "email" : { "type" : "string", "example" : "john.doe@domain.com", "description" : "Email address", "x-custom-type" : "email" }, "protection" : { "description" : "The protection of the contact", "$ref" : "#/definitions/ContactProtectionConstants" }, "sip" : { "type" : "string", "description" : "The sip of the contact" }, "domainsafe" : { "type" : "boolean", "description" : "Indicates whether the domain contact is in the DomainSafe." }, "confirmOwnerConsent" : { "type" : "boolean", "description" : "Confirmation of the domain holder that he agrees to the changes. \n\n false or blank= Refuse confirmation. Order will not be accepted. \n true = Confirm \n default value = false \n\n This confirmation has been required since December 7, 2016 due to ICANN's new change of ownership procedure for changes to the domain holder's name, email address or organization. Only for gTLDs and new gTLDs." }, "comment" : { "type" : "string", "description" : "A freely definable text that can be set for a contact. May only be composed of ASCII characters." }, "verification" : { "example" : "SUCCESS - Domain contact verification successful. \n PENDING - Domain contact verification in progress. \n FAILED - Domain contact verification failed. \n NOT_SET - Domain contact verification not started.", "description" : "The status of domain contact verification.", "$ref" : "#/definitions/GenericStatusConstants" }, "documents" : { "type" : "array", "items" : { "$ref" : "#/definitions/ContactDocument" } }, "fname" : { "type" : "string", "example" : "John", "description" : "First name" }, "lname" : { "type" : "string", "example" : "Doe", "description" : "Last name" }, "address" : { "type" : "array", "description" : "Street or post box. Depending on the registry, up to 65,536 characters may be possible.", "items" : { "type" : "string" }, "maxItems" : 2147483647, "minItems" : 1 }, "pcode" : { "type" : "string", "example" : "Canada: M5V 3H5, H3Z2Y7 \nNorway: 0010 \nPoland: 12-345 \nSpain: 28040", "description" : "The postal code (“zip-code”) of the contact. For countries Canada, Norway, Poland and Spain the format of the postal code is checked for validity. \nCanada (ca): Six characters in the following format 'LNL NLN', where 'L' represents a letter and 'N' represents a number. \nNorway (co): Four characters between 0001 and 9990. \nPoland (pl): Consists of five digits, with a hyphen ('-') between the second and third digits. \nSpain (es): Consisting of exactly five digits. No letters or special characters, only numbers. Each of the five positions can be any digit from 0 to 9." }, "phone" : { "type" : "string", "example" : "+49-123-12345", "description" : "The phone number of the contact", "x-custom-type" : "phone" }, "fax" : { "type" : "string", "example" : "+49-123-12345", "description" : "The fax number of the contact", "x-custom-type" : "phone" }, "nicRef" : { "type" : "array", "description" : "Manually create a NIC reference for the domain contact. This is not required, since the NIC references are always created automatically.\n This will no longer be supported in the future.", "items" : { "$ref" : "#/definitions/ContactReference" } }, "extensions" : { "description" : "Additional data for contacts required by certain TLDs.", "$ref" : "#/definitions/ContactExtensions" } } }, "ContactAeroExtensions" : { "type" : "object", "properties" : { "ensAuthId" : { "type" : "string", "description" : "Aero Authentication ID." }, "ensKey" : { "type" : "string", "description" : "Aero ENS key." } } }, "ContactAuExtensions" : { "type" : "object", "properties" : { "eligibilityId" : { "type" : "string", "description" : "The corresponding ID number for the eligibility name if applicable, if in doubt just use the same details as your Registrant ID." }, "eligibilityIdType" : { "description" : "The type of eligibility id as above.", "$ref" : "#/definitions/AuEligibilityIdTypeConstants" }, "eligibilityName" : { "type" : "string", "description" : "\tThis field is usually optional and whether it is required is determined by your policy reason for the domain registration, if in doubt just use the same details as your Registrant Name." }, "eligibilityType" : { "description" : "The type of entity that the registrant is.", "$ref" : "#/definitions/AuEligibilityTypeConstants" }, "policyReason" : { "type" : "integer", "format" : "int32", "description" : "Reason for eligibility." }, "registrantId" : { "type" : "string", "description" : "Australian Business Number or Registered Business Number." }, "registrantIdType" : { "description" : "Concerns the Registrant ID which you have selected in the Registrant ID form field.", "$ref" : "#/definitions/AuRegistrantIdTypeConstants" }, "registrantName" : { "type" : "string", "description" : "Name of the registrant." } } }, "ContactBankExtensions" : { "type" : "object", "properties" : { "ftldToken" : { "type" : "string", "description" : "Registration token that you receive by email after successful verification by the registry." } } }, "ContactBarcelonaExtensions" : { "type" : "object", "properties" : { "intendedUse" : { "type" : "string", "description" : "The intended use for the domain." } } }, "ContactBirthExtensions" : { "type" : "object", "properties" : { "country" : { "type" : "string", "example" : "DE", "description" : "Birth country (ISO 3166 Country Code).", "x-custom-type" : "country" }, "day" : { "type" : "string", "format" : "date", "example" : "1987-10-04", "description" : "Birthday (yyyy-MM-dd).", "x-custom-type" : "date" }, "postalCode" : { "type" : "string", "description" : "Postal code of the birth place.", "x-custom-type" : "pcode" }, "place" : { "type" : "string", "description" : "Birth place." } } }, "ContactCaExtensions" : { "type" : "object", "properties" : { "cpr" : { "description" : "Canadian Presence Requirements.\n Enter the reason for the authorization to register a .ca domain.", "$ref" : "#/definitions/CiraCprConstants" }, "agreementVersion" : { "type" : "number", "format" : "double", "description" : "The agreement version." }, "originatingIp" : { "type" : "string", "description" : "The originating ip.", "x-custom-type" : "ip" }, "officialRepresentative" : { "type" : "string", "description" : "Offical representative." }, "trusteePercentage" : { "type" : "number", "format" : "double", "description" : "Share of Canadians in a trust. \n Value must be <= 66. Mandatory if CPR = TRS (Trust)." } } }, "ContactCatExtensions" : { "type" : "object", "properties" : { "intendedUse" : { "type" : "string", "description" : "The intended use for the domain." } } }, "ContactDocument" : { "type" : "object", "required" : [ "contact", "document", "type" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "contact" : { "$ref" : "#/definitions/Contact" }, "document" : { "$ref" : "#/definitions/Document" }, "type" : { "$ref" : "#/definitions/ContactDocumentType" }, "verification" : { "description" : "The verification status of the contact", "$ref" : "#/definitions/GenericStatusConstants" }, "expire" : { "type" : "string", "format" : "date-time", "description" : "The expire date." } } }, "ContactDocumentType" : { "type" : "string", "enum" : [ "ID_CARD", "PASSPORT", "OTHER_ID_CARD", "COLLEGE_ID_CARD", "ORG_CERTIFICATE", "PROOF_TRADE", "PROOF_TRADEMARK", "IE_TAX_CLEARANCE_CERTIFICATE", "IE_HMRC_CORRESPONDENCE", "IE_IRISH_BANK_STATEMENT", "IE_PUBLIC_SERVICE_CARD", "IE_IRISH_REVENUE_CORRESPONDENCE", "JP_REGISTRATION_FORM", "JP_UPDATE_FORM", "TR_FORM", "TH_CHANGE_LOGIN_FORM", "CN_MAINLAND_TRAVEL_PERMIT_HK_MO", "CN_MAINLAND_TRAVEL_PERMIT_TW", "PERMANENT_RESIDENCE_PERMIT_FOREIGNERS", "CN_RESIDENCE_PERMIT_HK_MO", "CN_RESIDENCE_PERMIT_TW", "MILITARY_ID_CARD", "CN_ORG_ID", "CN_BUSINESS_ID", "CN_SOCIAL_CREDIT_LICENSE", "MILITARY_UNIT_CODE", "MILITARY_UNIT_EXTERNAL_PERMIT", "INSTITUTION_LEGAL_PERSON", "CN_FOREIGN_ENTERPRISE_REGISTRATION", "SOCIAL_ORG_LEGAL_PERSON", "RELIGIOUS_ACTIVITY", "PRIVATE_NON_ENTERPRISE_REGISTRATION", "FOUNDATION_LEGAL_PERSON", "LAW_FIRM_LICENSE", "CN_FOREIGN_CULTURAL_CENTER", "CN_FOREIGN_TOURISM_DEPARTMENT_REGISTRATION", "FORENSIC_EXPERTISE_LICENSE", "SOCIAL_AGENCY_CERTIFICATE", "PRIVATE_SCHOOL_PERMIT", "MEDICAL_INSTITUTION_LICENSE", "NOTARY_ORG_LICENSE", "CN_FOREIGN_EMBASSY_CHILDREN_PERMIT_BEIJING", "OTHER_ORG_DOC" ] }, "ContactExtensions" : { "type" : "object", "properties" : { "aero" : { "description" : "The .aero contact extensions.", "$ref" : "#/definitions/ContactAeroExtensions" }, "au" : { "description" : "The .au contact extensions.", "$ref" : "#/definitions/ContactAuExtensions" }, "cat" : { "description" : "The .cat contact extensions.", "$ref" : "#/definitions/ContactCatExtensions" }, "jobs" : { "description" : "The .jobs contact extensions.", "$ref" : "#/definitions/ContactJobsExtensions" }, "it" : { "description" : "The .it contact extensions.", "$ref" : "#/definitions/ContactItExtensions" }, "jp" : { "description" : "The .jp contact extensions.", "$ref" : "#/definitions/ContactJpExtensions" }, "xxx" : { "description" : "The .xxx contact extensions.", "$ref" : "#/definitions/ContactXxxExtensions" }, "hk" : { "description" : "The .hk contact extensions.", "$ref" : "#/definitions/ContactHkExtensions" }, "bank" : { "description" : "The .bank contact extensions.", "$ref" : "#/definitions/ContactBankExtensions" }, "swiss" : { "description" : "The .swiss contact extensions.", "$ref" : "#/definitions/ContactSwissExtensions" }, "ru" : { "description" : "The .ru contact extensions.", "$ref" : "#/definitions/ContactRuExtensions" }, "uk" : { "description" : "The .uk contact extensions.", "$ref" : "#/definitions/ContactUkExtensions" }, "ca" : { "description" : "The .ca contact extensions.", "$ref" : "#/definitions/ContactCaExtensions" }, "ro" : { "description" : "The .ro contact extensions.", "$ref" : "#/definitions/ContactRoExtensions" }, "barcelona" : { "description" : "The .barcelona contact extensions.", "$ref" : "#/definitions/ContactBarcelonaExtensions" }, "general" : { "description" : "The general contact extensions.", "$ref" : "#/definitions/ContactGeneralExtensions" }, "nz" : { "description" : "The .nz contact extensions", "$ref" : "#/definitions/ContactNzExtensions" }, "sport" : { "description" : "The .sport contact extensions.", "$ref" : "#/definitions/ContactSportExtensions" }, "luxe" : { "description" : "The .luxe contact extensions.", "$ref" : "#/definitions/ContactLuxeExtensions" }, "madrid" : { "description" : "The .madrid contact extensions.", "$ref" : "#/definitions/ContactMadridExtensions" }, "scot" : { "description" : "The .scot contact extensions.", "$ref" : "#/definitions/ContactScotExtensions" }, "ie" : { "description" : "The .ie contact extensions.", "$ref" : "#/definitions/ContactIeExtensions" }, "zuerich" : { "description" : "The .zuerich contact extensions.", "$ref" : "#/definitions/ContactZuerichExtensions" } } }, "ContactGeneralExtensions" : { "type" : "object", "properties" : { "birth" : { "description" : "The birth extensions.", "$ref" : "#/definitions/ContactBirthExtensions" }, "trademark" : { "description" : "The trademark extensions.", "$ref" : "#/definitions/ContactTrademarkExtensions" }, "identification" : { "description" : "The identification extensions.", "$ref" : "#/definitions/ContactIdentificationExtensions" }, "language" : { "type" : "string", "example" : "\"de\" or \"de_ch\"", "description" : "Language of the contact RFC 3066.", "x-custom-type" : "language" }, "companyNumber" : { "type" : "string", "description" : "Company number." }, "gender" : { "description" : "Gender.", "$ref" : "#/definitions/GenderConstants" }, "vatNumber" : { "type" : "string", "description" : "VAT number." }, "citizenship" : { "type" : "string", "description" : "Citizenship. For EU citizens living outside the EU.", "x-custom-type" : "country" }, "strict" : { "type" : "boolean", "description" : "If strict mode should be used for the registry mapping." }, "mobilePhone" : { "type" : "string", "example" : "+49-123-123", "description" : "Mobile phone number.", "x-custom-type" : "phone" } } }, "ContactHkExtensions" : { "type" : "object", "properties" : { "documentType" : { "description" : "Dokument type für persons and organizations.", "$ref" : "#/definitions/HkDocumentTypeConstants" }, "others" : { "type" : "string", "description" : "Additional descriptions for OTHIDV and OTHORG." }, "documentNumber" : { "type" : "string", "description" : "Document number, e.g. id card number." }, "documentOrigin" : { "type" : "string", "description" : "Country of issuing authority.", "x-custom-type" : "country" }, "above18" : { "type" : "boolean", "example" : false, "description" : "For \"Person\" only. Is the person 18 years of age or older?. " }, "industryType" : { "description" : "Industry type.", "$ref" : "#/definitions/HkIndustryTypeConstants" } } }, "ContactIdentificationExtensions" : { "type" : "object", "properties" : { "number" : { "type" : "string", "description" : "Id card number." }, "authority" : { "type" : "string", "description" : "Issuing authority of the identification card." }, "dateOfIssue" : { "type" : "string", "format" : "date", "description" : "Date on which the identification card was issued.", "x-custom-type" : "date" }, "validTill" : { "type" : "string", "format" : "date", "description" : "Date on which the validity of the identification card expires.", "x-custom-type" : "date" } } }, "ContactIeExtensions" : { "type" : "object", "properties" : { "contactType" : { "type" : "string", "description" : "Describes the connection to Ireland that is eligible for domain registration. \n Possible values:\n Company - for Irish companies with CRO number\n Charity - is not supported by us\n Other - person or organization without CRO number" }, "supportingNumber" : { "type" : "string", "description" : "Can be an EU trademark number or an Irish RBN. Needed for other person or organization of type OTH (Other).\n For type COM (Commercial) the company number from the general contact details is used." } } }, "ContactItExtensions" : { "type" : "object", "properties" : { "entityType" : { "description" : "Entity the contact belongs to. \n Depending on what you have entered in it_entity_type, other data must also be specified. You can find a description of this data in the section \"General Extensions\".", "$ref" : "#/definitions/ItEntityTypeConstants" } } }, "ContactJobsExtensions" : { "type" : "object", "properties" : { "adminType" : { "type" : "boolean", "example" : false, "description" : "Here you enter whether the contact is the administrative contact with the permission to act as an independent agent /recruiter on behalf of the listed registrant." }, "contactTitle" : { "type" : "string", "description" : "Title of the domain contact in the organization." }, "hrMember" : { "type" : "boolean", "example" : false, "description" : "Choose whether the contact is is a member of the Human Resource Organization" }, "industryClass" : { "type" : "integer", "format" : "int32", "description" : "The industry class in which the company is active in." }, "website" : { "type" : "string", "description" : "The website URL of the company.", "x-custom-type" : "uri" } } }, "ContactJpExtensions" : { "type" : "object", "properties" : { "first" : { "type" : "string", "description" : "First Name. Japanese characters must be used." }, "last" : { "type" : "string", "description" : "Last Name. Japanese characters must be used." }, "organization" : { "type" : "string", "description" : "Organization Name. Japanese characters must be used." }, "adressLine1" : { "type" : "string", "description" : "First address line. Japanese characters must be used." }, "adressLine2" : { "type" : "string", "description" : "Second address line. Japanese characters must be used." }, "adressLine3" : { "type" : "string", "description" : "Third address line. Japanese characters must be used." } } }, "ContactLuxeExtensions" : { "type" : "object", "properties" : { "walletAddress" : { "type" : "string", "description" : "The wallet address" } } }, "ContactMadridExtensions" : { "type" : "object", "properties" : { "intendedUse" : { "type" : "string", "description" : "The intended use for the domain." } } }, "ContactNzExtensions" : { "type" : "object", "properties" : { "irpo" : { "type" : "boolean", "example" : false, "description" : "Hide contact data in the Whois. Address, telephone, fax are affected. \n Permitted only for natural persons (\"individuals\") who do not use the domain name to a significant extent in \"trading\" as defined and used in the Fair Trading Act 1986." } } }, "ContactProtectionConstants" : { "type" : "string", "enum" : [ "SHOW_ALL", "SHOW_NONE" ] }, "ContactReference" : { "type" : "object", "properties" : { "nic" : { "description" : "The nic", "$ref" : "#/definitions/NicMember" }, "status" : { "description" : "The status", "$ref" : "#/definitions/ObjectStatus" }, "type" : { "description" : "The contact reference type", "$ref" : "#/definitions/ContactReferenceType" }, "role" : { "description" : "The role as contact reference type", "$ref" : "#/definitions/ContactReferenceType" }, "verification" : { "description" : "The external verification status", "$ref" : "#/definitions/GenericStatusConstants" }, "name" : { "type" : "string", "description" : "The nic reference" } } }, "ContactReferenceType" : { "type" : "string", "enum" : [ "ALL", "OWNERC", "ADMINC", "TECHC", "ZONEC", "BILLINGC" ] }, "ContactRoExtensions" : { "type" : "object", "properties" : { "personType" : { "description" : "Type of group that the contact belongs to.", "$ref" : "#/definitions/RoPersonTypeConstants" } } }, "ContactRuExtensions" : { "type" : "object", "properties" : { "taxpayerIdentificationNumber" : { "type" : "string", "description" : "Taxpayer Identification Number (code). Mandatory for organisations which belong to the Russian Federation." }, "territoryLinkedTaxpayerNumber" : { "type" : "string", "description" : "Territory-linked Taxpayer Number (kpp). Mandatory for organisations which belong to the Russian Federation." } } }, "ContactScotExtensions" : { "type" : "object", "properties" : { "intendedUse" : { "type" : "string", "description" : "The intended use for the domain." } } }, "ContactSportExtensions" : { "type" : "object", "properties" : { "intendedUse" : { "type" : "string", "description" : "The intended use for the domain." } } }, "ContactSwissExtensions" : { "type" : "object", "properties" : { "enterpriseId" : { "type" : "string", "description" : "The enterprise ID, in the specific context of .swiss based on current rules, is the Swiss UID/IDE/IDI.The full name is in German \"Unternehmens-ID\", in French \"Numéro d’identification des entreprises (IDE)\" and in Italian \"Numero d’identificazione delle imprese\" (IDI)." }, "intendedUse" : { "type" : "string", "description" : "The intended use for the domain." } } }, "ContactTrademarkExtensions" : { "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "Trademark name." }, "number" : { "type" : "string", "description" : "Trademark number." }, "country" : { "type" : "string", "example" : "DE", "description" : "Country in which the trade mark is valid (ISO 3166 Country Code).", "x-custom-type" : "country" }, "regdate" : { "type" : "string", "format" : "date", "description" : "Registration date.", "x-custom-type" : "date" }, "appdate" : { "type" : "string", "format" : "date", "example" : "2022-07-29", "description" : "Application date of the trade mark (yyyy-MM-dd).", "x-custom-type" : "date" }, "office" : { "type" : "string", "description" : "The trademark office where the trademark is registered at." } } }, "ContactType" : { "type" : "string", "enum" : [ "BILLING", "TECH", "LEGAL", "PRIMARY", "DOMAIN", "SSL", "SERVER", "ABUSE" ] }, "ContactTypeConstants" : { "type" : "string", "enum" : [ "PERSON", "ORG", "ROLE" ] }, "ContactUkExtensions" : { "type" : "object", "properties" : { "entityType" : { "description" : "Organization type. \n For the sub domains ltd.uk, net.uk and plc.uk the selection of is mandatory.\n For co.uk and me.uk the selection of is not mandatory.", "$ref" : "#/definitions/UkTypeConstants" } } }, "ContactVerification" : { "type" : "object", "required" : [ "confirmIp", "contact" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "owner" : { "description" : "The object owner.", "$ref" : "#/definitions/User" }, "updater" : { "description" : "User who performed the last update.", "$ref" : "#/definitions/User" }, "reference" : { "type" : "string", "description" : "The unique reference of the Verification" }, "messageSend" : { "type" : "string", "format" : "date-time", "description" : "The date when the last verification email was sent." }, "confirmed" : { "type" : "string", "format" : "date-time", "description" : "The date when the last verification email was confirmed." }, "confirmIp" : { "description" : "The IP address from which the verification was confirmed.", "$ref" : "#/definitions/InetAddress" }, "failed" : { "type" : "string", "format" : "date-time", "description" : "The date on which the verification failed." }, "domains" : { "type" : "array", "description" : "Domain for which verification was/is required.", "items" : { "$ref" : "#/definitions/ContactVerificationDomain" } }, "verificationMails" : { "type" : "array", "description" : "The verification mails. For each mail sent, it is recorded here whether the verification was successful or not.", "items" : { "$ref" : "#/definitions/ContactVerificationMessage" } }, "comment" : { "type" : "string", "description" : "The verification comment. Can be included in the confirmation." }, "action" : { "type" : "string", "description" : "Action for which the verification was triggered or updated." }, "contact" : { "description" : "the contact of the Verification", "$ref" : "#/definitions/Contact" } } }, "ContactVerificationDomain" : { "type" : "object", "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "name" : { "type" : "string", "description" : "The domain name associated with the contact verification" }, "idn" : { "type" : "string", "description" : "The domain name written in Punycode syntax(IDN)" }, "status" : { "description" : "The status of the domain Verification", "$ref" : "#/definitions/GenericStatusConstants" }, "deactivation" : { "type" : "string", "format" : "date-time", "description" : "The date on which the associated domain is deactivated if the contact verification is not completed" } } }, "ContactVerificationMessage" : { "type" : "object", "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "mail" : { "description" : "The notification that was sent for verification", "$ref" : "#/definitions/MailServiceMessage" }, "status" : { "description" : "The status of the verification mail", "$ref" : "#/definitions/GenericStatusConstants" }, "lastResponse" : { "type" : "string", "description" : "The last response of the mail server" } } }, "ContactXxxExtensions" : { "type" : "object", "properties" : { "membershipID" : { "type" : "string", "description" : "Membership ID (token) for the .XXX community. \n You receive your ID after you have finished the ICM registry membership process successfully and having created an account there." }, "nonResolverDomain" : { "type" : "boolean", "example" : false, "description" : "XXX community membership. Members have a membership ID (token)." } } }, "ContactZuerichExtensions" : { "type" : "object", "properties" : { "enterpriseId" : { "type" : "string", "description" : "The enterprise ID, in the specific context of .zuerich based on current rules, is the Swiss UID/IDE/IDI." }, "isAuthority" : { "type" : "boolean", "example" : false, "description" : "Indicates whether the registrant is a public corporation or not." } } }, "ContextHost" : { "type" : "object", "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "master" : { "type" : "boolean", "description" : "Show if host is default value" }, "csr" : { "type" : "string", "description" : "The csr of the certificate" }, "serverCert" : { "type" : "string", "description" : "The server certificate." }, "caCert" : { "type" : "string", "description" : "The intermediates of the certificate" }, "status" : { "description" : "The job status", "$ref" : "#/definitions/JobStatusConstants" }, "subStatus" : { "type" : "string", "description" : "The job substatus" }, "zone" : { "description" : "The zones of the host", "$ref" : "#/definitions/ContextHostZone" }, "certificate" : { "description" : "The zones of the host", "$ref" : "#/definitions/BasicCertificate" }, "name" : { "type" : "string", "description" : "The host name" } } }, "ContextHostZone" : { "type" : "object", "properties" : { "origin" : { "type" : "string", "description" : "The zone origin" }, "sub" : { "type" : "string", "description" : "The name of the sub zone" }, "zones" : { "type" : "array", "description" : "The found zone entries", "items" : { "$ref" : "#/definitions/HostSubZone" } } } }, "Country" : { "type" : "object", "properties" : { "isoCode" : { "type" : "string" }, "countrynameDe" : { "type" : "string" }, "countrynameEn" : { "type" : "string" } } }, "CreditCardVendor" : { "type" : "string", "enum" : [ "MC", "VISA", "AMEX", "DIC", "DISC", "CB" ] }, "CryptoFormatConstants" : { "type" : "string", "enum" : [ "SHA1", "SHA256", "SHA512" ] }, "CsrHashAlgorithmConstants" : { "type" : "string", "enum" : [ "PRIME_256_V1", "SECP_384_R1" ] }, "Currency" : { "type" : "object" }, "CurrencyRate" : { "type" : "object", "properties" : { "currency" : { "type" : "string", "example" : "EUR", "description" : "Currency of the customer's prepayment account.", "x-custom-type" : "currency" }, "rate" : { "type" : "number", "format" : "double", "description" : "Exchange rate." } } }, "Custom" : { "type" : "object", "required" : [ "key" ], "properties" : { "key" : { "type" : "string", "description" : "The key of the additional data of a booking item" } } }, "CustomerContract" : { "type" : "object", "required" : [ "contract" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "contract" : { "description" : "The contract.", "$ref" : "#/definitions/GenericLabelEntity" }, "accountManager" : { "description" : "The name of the manager.", "$ref" : "#/definitions/accountManager" }, "classification" : { "type" : "string", "description" : "The classification." }, "invoiceNotice" : { "type" : "string", "description" : "The invoiceNotice." }, "notice" : { "type" : "string", "description" : "The notices." }, "ticketNumber" : { "type" : "string", "description" : "The ticketing number if available." } } }, "CustomerPriceList" : { "type" : "object", "required" : [ "customer" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "id" : { "type" : "integer", "format" : "int32", "description" : "The id." }, "customer" : { "$ref" : "#/definitions/GenericCustomer" }, "priceList" : { "description" : "The priceList label.", "$ref" : "#/definitions/PriceList" } } }, "CustomerTag" : { "type" : "object", "required" : [ "tag" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "tag" : { "description" : "The tag.", "$ref" : "#/definitions/GenericLabelEntity" } } }, "CustomerType" : { "type" : "string", "enum" : [ "PERSON", "ORGANIZATION" ] }, "DNSSec" : { "type" : "object", "required" : [ "algorithm", "flags", "protocol", "publicKey" ], "properties" : { "algorithm" : { "type" : "integer", "format" : "int32", "description" : "The algorithm." }, "flags" : { "type" : "integer", "format" : "int32", "description" : "DNSSEC type\nSupported values:\n256 (zone signing key)\n257 (key signing key)", "minimum" : 256, "maximum" : 257 }, "protocol" : { "type" : "integer", "format" : "int32", "description" : "The protocol." }, "publicKey" : { "type" : "string", "description" : "The public key. With the pattern ^[\\sA-Za-z0-9+\\/]+[=]*$", "pattern" : "^[\\sa-zA-Z0-9+\\/\\n=]{8,}$" } } }, "DNSSecJob" : { "type" : "object" }, "DcvValidationScope" : { "type" : "string", "enum" : [ "FQDN", "BASEDOMAIN" ] }, "DeliveryStatus" : { "type" : "string", "enum" : [ "PENDING", "SUCCESS", "FAILED", "EXPIRED", "ATTEMPTING", "PARTIAL" ] }, "DigiCertCodeSigningHardwarePlatform" : { "type" : "string", "enum" : [ "SAFE_NET_E_TOKEN_5110_FIPS", "SAFE_NET_E_TOKEN_5110_CC", "SAFE_NET_E_TOKEN_5110_PLUS_FIPS", "OTHER" ] }, "DigiCertCodeSigningProvisioningMethod" : { "type" : "string", "enum" : [ "SOFTWARE", "SHIPPING" ] }, "Document" : { "type" : "object", "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "id" : { "type" : "integer", "format" : "int64", "description" : "The unique identifier of the document" }, "comment" : { "type" : "string", "description" : "Document comment" }, "type" : { "type" : "string", "example" : "- tmchMarkDocument \n - contactDocument", "description" : "Type of document, related to InternetX." }, "mimeType" : { "type" : "string", "example" : "application/pdf (invalid for contact document)\nimage/png\nimage/jpeg \ntext/xml (invalid for contact document)\nimage/gif (invalid for contact document)", "description" : "MIME type (Multipurpose Internet Mail Extensions) \n Which MimeType is valid depends on the type of document" }, "data" : { "type" : "string", "example" : "The file in binary format" }, "size" : { "type" : "integer", "format" : "int64", "description" : "Document size\n(Maximum size for contact documents is 2MB)" }, "name" : { "type" : "string", "description" : "Name of the document. Can be freely chosen" }, "link" : { "type" : "string", "description" : "Link created by Internetx to download invoices." } } }, "DocumentType" : { "type" : "string", "enum" : [ "CONTACT", "JOB" ] }, "DocumentTypeConstants" : { "type" : "string", "enum" : [ "TM_LICENSEE_DECL", "TM_ASSIGNEE_DECL", "TM_OTHER", "DECL_PROOF_OF_USE_ONE_SAMPLE", "PROOF_OF_USE_OTHER", "COPY_OF_COURT_ORDER", "TMCH_AGENT_AUTHORISATION_FORM", "TM_OTHER_COPY_OF_TM_CERTIFICATE", "TM_OTHER_COPY_OF_RENEWAL_REQUEST", "TM_OTHER_COPY_OF_TREATY_OR_STATUTE", "TM_OTHER_COPY_OF_CERTIFICATE" ] }, "Domain" : { "type" : "object", "required" : [ "name", "payable", "removeCancelation" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "owner" : { "description" : "The object owner.", "$ref" : "#/definitions/User" }, "updater" : { "description" : "User who performed the last update.", "$ref" : "#/definitions/User" }, "name" : { "type" : "string", "example" : "domain.de", "description" : "The name of the domain." }, "idn" : { "type" : "string", "example" : "müller.org", "description" : "The unicode domain name" }, "domainCreated" : { "type" : "string", "format" : "date-time", "description" : "The domain creation of the domain at the registry." }, "nicMemberLabel" : { "type" : "string", "description" : "The nic member label." }, "registryStatus" : { "description" : "The registry status.", "$ref" : "#/definitions/RegistryStatusConstants" }, "nameServers" : { "type" : "array", "description" : "The nameservers.", "items" : { "$ref" : "#/definitions/NameServer" } }, "nameServerEntries" : { "type" : "array", "description" : "NSentry is only be provided for .DE. If NSentry is used, nameServers is not allowed.", "items" : { "type" : "string" } }, "period" : { "description" : "The period in years, depends on the requested action", "$ref" : "#/definitions/TimePeriod" }, "trustee" : { "type" : "boolean", "description" : "Enable trustee service for the domain." }, "privacy" : { "type" : "boolean", "description" : "Enable privacy service for the domain." }, "authinfo" : { "type" : "string", "description" : "The authinfo." }, "authinfoExpire" : { "type" : "string", "format" : "date-time", "description" : "The expire date of the authinfo." }, "domainsafe" : { "type" : "boolean", "description" : "Enable domainsafe." }, "parking" : { "description" : "The parking provider.", "$ref" : "#/definitions/ParkingProviderConstants" }, "extensions" : { "description" : "The domain extensions.", "$ref" : "#/definitions/DomainExtensions" }, "logId" : { "type" : "integer", "format" : "int64", "description" : "The logId" }, "confirmOrder" : { "type" : "boolean", "description" : "Some TLDs require a confirmation of the “Terms and Conditions of Registration." }, "confirmOwnerConsent" : { "type" : "boolean", "description" : "Confirms the consent of the domainowner for the changes. Required for gTLDs and new gTLDs when changing the name, the email address or the organization of the domain owner." }, "ignoreWhois" : { "type" : "boolean", "description" : "Ignore whois." }, "comment" : { "type" : "string", "description" : "A custom field. Can only be updated via PUT /domain/{name}/_comment. Requires appropriate ACLs." }, "registrarStatus" : { "description" : "The registrar status.", "$ref" : "#/definitions/RegistryStatusConstants" }, "registrarStatusReason" : { "type" : "string", "description" : "The registrar status reason." }, "removeCancelation" : { "type" : "boolean", "description" : "Remove cancelation." }, "autodnsSecJob" : { "description" : "AutodnsSecJob", "$ref" : "#/definitions/DNSSecJob" }, "priceClass" : { "type" : "string", "description" : "The priceclass for the registration of the domain." }, "priceClassRenew" : { "type" : "string", "description" : "The priceclass for the renew of the domain." }, "abuseEmail" : { "type" : "string", "description" : "The abuse email." }, "generalRequestEmail" : { "type" : "string", "description" : "The general request mail." }, "privacyPlusMail" : { "type" : "string", "description" : "The privacy plus mail." }, "privacyPlus" : { "type" : "boolean", "description" : "Enable privacy plus." }, "nameServerGroup" : { "type" : "string", "description" : "The nameserver group." }, "rddsOptIn" : { "description" : "Enables the whois output to show redacted contacts.", "$ref" : "#/definitions/RddsOptInConstants" }, "servicesAdd" : { "description" : "Adds pending services like BackupMX and MailProxy.", "$ref" : "#/definitions/DomainServices" }, "servicesRem" : { "description" : "Removes pending services like BackupMX and MailProxy.", "$ref" : "#/definitions/DomainServices" }, "ownerc" : { "description" : "The owner contact.", "$ref" : "#/definitions/Contact" }, "adminc" : { "description" : "The administrative contact.", "$ref" : "#/definitions/Contact" }, "techc" : { "description" : "The technical contact reference.", "$ref" : "#/definitions/Contact" }, "zonec" : { "description" : "The dns contact.", "$ref" : "#/definitions/Contact" }, "expire" : { "type" : "string", "format" : "date-time", "description" : "The expire date of the domain." }, "payable" : { "type" : "string", "format" : "date-time", "description" : "The payable date of the domain." }, "action" : { "description" : "The last action.", "$ref" : "#/definitions/DomainActionConstants" }, "autoDnssec" : { "type" : "boolean", "description" : "Enables or disables automatic DNSSEC for certain name servers (e.g. NodeSecure)." }, "dnssec" : { "type" : "boolean", "description" : "Indicates whether DNSSEC is enabled for the domain or not." }, "validCertificate" : { "type" : "boolean", "description" : "Domain has an matching certificate." }, "cancelationStatus" : { "description" : "The cancelation status.", "$ref" : "#/definitions/CancelationStatusConstants" }, "autoRenewStatus" : { "description" : "The autorenew status.", "$ref" : "#/definitions/AutoRenewStatusConstants" }, "dnssecData" : { "type" : "array", "description" : "Submits the key material to the registry. If the list is empty, the key material is deleted at the registry. If the key is omitted during an update, the data is retained.", "items" : { "$ref" : "#/definitions/DNSSec" } }, "zone" : { "description" : "The zone to create.", "$ref" : "#/definitions/Zone" } } }, "DomainActionConstants" : { "type" : "string", "enum" : [ "CREATE", "UPDATE", "UPDATE_OWNER_CHANGE", "UPDATE_DNSSEC", "UPDATE_NAMESERVER", "DELETE", "TRANSIT", "TRANSFER", "TRANSFER_INTERN", "TRANSFER_INTERN_REGISTRAR_CHANGE", "TRANSFER_INTERN_REGISTRAR_CHANGE_RUNTIME_TAKEOVER", "IMPORT", "MIGRATE", "RESTORE", "RESTORE_NE", "RESTORE_RENEW", "RESTORE_ARGP", "RENEW", "AUTHINFO", "AUTHINFO_2", "UPDATE_STATUS", "REGISTRAR_UPDATE_STATUS", "UPDATE_COMMENT", "AUTOUPDATE_DNS", "AUTOUPDATE_DNSSEC", "OWNERCHANGE", "OWNERCHANGE_TRANSFER", "OWNERCHANGE_TRANSFER_INTERN", "OWNERCHANGE_TRANSFER_INTERN_REGISTRAR_CHANGE", "PREACK", "WHOIS_REGISTRY_STATUS", "DOMAIN_AWAY", "TRANSFER_OUT_AUTOACK", "DROP", "AUTHINFO_CREATE", "AUTHINFO_DELETE", "AUTOUPDATE_DEFERRED", "DOMAIN_BUY", "CONTACT_CREATE", "DELETE_EXPIRE" ] }, "DomainAutodeleteExtensions" : { "type" : "object", "properties" : { "autodeletePaymentLimit" : { "type" : "string", "format" : "date-time" }, "autodeleteLastUpdated" : { "type" : "string", "format" : "date-time" }, "autoDeleteStatus" : { "$ref" : "#/definitions/AutoDeleteStatus" } } }, "DomainBuyExtensions" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "format" : "double", "description" : "Purchase price of the domain." }, "currency" : { "type" : "string", "example" : "EUR", "description" : "Currency of the purchase price.", "x-custom-type" : "currency" } } }, "DomainCancelation" : { "type" : "object", "required" : [ "domain", "execution", "registryWhen", "type" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "owner" : { "description" : "The object owner.", "$ref" : "#/definitions/User" }, "updater" : { "description" : "User who performed the last update.", "$ref" : "#/definitions/User" }, "domain" : { "type" : "string", "description" : "Domain to be cancelled." }, "registryWhen" : { "type" : "string", "format" : "date-time", "description" : "The date on which the registry should perform the domain cancelation. Only necessary when ExecutionType equals DATE." }, "gainingRegistrar" : { "type" : "string", "description" : "The registrar to which the domain is to be transferred. Only possible with preack, for which it is required. \n accept_all = All registrars are accepted \n Designated registrar (e.g. DENIC-104).\nAsk the registry for the provider ID of your reseller. The transfer is then only possible to the selected registrar." }, "disconnect" : { "type" : "boolean", "example" : false, "description" : "Specifies whether the domain is disconnected during a transit. Only possible with transit, for which it is necessary. Default value = false" }, "notice" : { "type" : "string", "description" : "Some remarks" }, "logId" : { "type" : "integer", "format" : "int64", "description" : "Identifier specifically used for this transfer." }, "registryStatus" : { "$ref" : "#/definitions/RegistryStatusConstants" }, "status" : { "description" : "Status of the cancelation request.", "$ref" : "#/definitions/CancelationStatusConstants" }, "type" : { "description" : "The cancelation type. TRANSIT is only possible for certain TLDs.", "$ref" : "#/definitions/CancelationTypeConstants" }, "execution" : { "description" : "Date and Time at which the domain is to be canceled.", "$ref" : "#/definitions/ExecutionTypeConstants" } } }, "DomainCancelationExtensions" : { "type" : "object", "properties" : { "cancelation" : { "type" : "string", "format" : "date-time", "description" : "The cancelation date" }, "disconnected" : { "type" : "boolean", "description" : "The disconnected" } } }, "DomainControllValidationStatus" : { "type" : "object", "properties" : { "status" : { "type" : "string", "description" : "The status of the dcv." }, "domain" : { "type" : "string", "description" : "The domain." } } }, "DomainEnvelope" : { "type" : "object", "properties" : { "domain" : { "type" : "string", "example" : "domain.de", "description" : "The domain" }, "idn" : { "type" : "string", "example" : "müller.org", "description" : "The unicode domain name" }, "tld" : { "type" : "string", "example" : "com", "description" : "The tld for the given domain name" }, "subTld" : { "type" : "string", "example" : "co", "description" : "The subTld for the given domain name" }, "source" : { "description" : "Source", "$ref" : "#/definitions/DomainStudioDomainSource" }, "services" : { "description" : "Source", "$ref" : "#/definitions/DomainStudioService" }, "debugTime" : { "type" : "integer", "format" : "int64", "description" : "The processing time for this domain." }, "portfolio" : { "type" : "boolean", "description" : "Defines if the user already owns this domain." }, "forceDnsCheck" : { "type" : "boolean", "description" : "All whois checks will be done via dns check." }, "whoisTimeout" : { "type" : "integer", "format" : "int32", "description" : "Defines the timeout for the whois duration in seconds" }, "onlyAvailable" : { "type" : "boolean", "description" : "Defines whether to return only free domain names when service WHOIS is used for a source." }, "isPrereg" : { "type" : "boolean", "description" : "Defines whether this domain name is only available for preregistration.", "readOnly" : true }, "notification" : { "description" : "Notification", "$ref" : "#/definitions/Notification" } } }, "DomainEnvelopeSearchRequest" : { "type" : "object", "properties" : { "searchToken" : { "type" : "string", "description" : "Domain search token" }, "currency" : { "type" : "string", "description" : "The currency for every price lookup" }, "debug" : { "type" : "boolean", "description" : "Activates debugging" }, "checkPortfolio" : { "type" : "boolean", "description" : "Activates the check for each domain whether the user already owns it." }, "forceDnsCheck" : { "type" : "boolean", "description" : "All whois checks will be done via dns check." }, "allowDuplicates" : { "type" : "boolean", "description" : "Allow duplicate domain names from different sources." }, "sources" : { "description" : "Wrapper for the configuration for each source", "$ref" : "#/definitions/DomainStudioSources" }, "clientIp" : { "type" : "string", "description" : "The ip of the client" }, "ctid" : { "type" : "string", "description" : "The ctid of the request. Only readable!" }, "stid" : { "type" : "string", "description" : "The stid of the request. Only readable!" }, "agent" : { "type" : "string", "description" : "The user agent of the request. Only readable!" }, "onlyAvailable" : { "type" : "boolean", "description" : "Defines whether to return only free domain names when service WHOIS is used for a source." }, "whoisTimeout" : { "type" : "integer", "format" : "int32", "description" : "Defines the timeout for the whois duration in seconds" }, "ignorePremium" : { "type" : "boolean", "description" : "If set to true, the inital, recommended, geo, custom and suggestion sources are filtered for premium domains. This can result in empty lists!" }, "ignoreMarket" : { "type" : "boolean", "description" : "If set to true, the inital, recommended, geo, custom and suggestion sources are filtered for market domains. This can result in empty lists!" } } }, "DomainEnvelopeSearchService" : { "type" : "string", "enum" : [ "WHOIS", "PRICE", "ESTIMATION" ] }, "DomainExtensions" : { "type" : "object", "properties" : { "domainBuyExtensions" : { "$ref" : "#/definitions/DomainBuyExtensions" }, "domainAutodeleteExtensions" : { "$ref" : "#/definitions/DomainAutodeleteExtensions" }, "parkingExtensions" : { "$ref" : "#/definitions/DomainParkingExtensions" }, "tmchClaimsNoticeExtensions" : { "$ref" : "#/definitions/DomainTmchClaimNoticeExtensions" }, "verificationExtensions" : { "$ref" : "#/definitions/ContactVerificationDomain" }, "cancelationExtensions" : { "$ref" : "#/definitions/DomainCancelationExtensions" }, "sellExtensions" : { "$ref" : "#/definitions/DomainSellExtensions" } } }, "DomainMonitoring" : { "type" : "object", "required" : [ "name" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "owner" : { "description" : "The object owner.", "$ref" : "#/definitions/User" }, "updater" : { "description" : "User who performed the last update.", "$ref" : "#/definitions/User" }, "name" : { "type" : "string", "example" : "domain.de", "description" : "Domain to be monitored." }, "idn" : { "type" : "string", "description" : "The IDN version of the domain written in Punycode syntax to be monitored." }, "notificationMobiles" : { "type" : "array", "description" : "Mobile phone number to which an SMS is sent when the status changes.", "items" : { "$ref" : "#/definitions/Phone" } }, "ocval" : { "type" : "boolean", "description" : "Monitoring setting for OwnerC validation.\nfalse = OwnerC validation should not be monitored.\ntrue = OwnerC validation should be monitored.\nDefault value = false" }, "cancelation" : { "type" : "boolean", "description" : "Monitoring setting for domain cancelations.\nfalse = Domain cancelations should not be monitored.\ntrue = Domain cancelations should be monitored.\nDefault value = false" }, "removed" : { "type" : "boolean", "description" : "Monitoring setting for domain deletions.\nfalse = Domain deletions should not be monitored.\ntrue = Domain deletions should be monitored.\nDefault value = false" }, "monitoringSetups" : { "type" : "array", "description" : "Contains the setup data for domain monitoring.", "items" : { "$ref" : "#/definitions/DomainMonitoringSetup" } }, "notificationEmails" : { "type" : "array", "description" : "Email addresses to which an email is sent when the status changes.", "items" : { "type" : "string" }, "maxItems" : 2147483647, "minItems" : 1 } } }, "DomainMonitoringSetup" : { "type" : "object", "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "data" : { "type" : "string", "description" : "The data" } } }, "DomainParkingExtensions" : { "type" : "object", "properties" : { "parkingCategory" : { "type" : "string" }, "currency" : { "type" : "string", "example" : "EUR", "description" : "The currency of the sale", "x-custom-type" : "currency" }, "domainLanguage" : { "type" : "string", "description" : "The parking" }, "forSale" : { "type" : "boolean", "description" : "Should the domain be listed for sale" }, "keyword" : { "type" : "string", "description" : "The keywords to use" }, "price" : { "type" : "number", "format" : "double", "description" : "The price to use" }, "fixedPrice" : { "type" : "boolean", "description" : "Is the price fix" }, "minPrice" : { "type" : "number", "format" : "double", "description" : "The minimum of price" } } }, "DomainPremium" : { "type" : "object", "required" : [ "name", "priceClass", "provider" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "name" : { "type" : "string", "example" : "example.org", "description" : "Domain name." }, "idn" : { "type" : "string", "example" : "müller.org", "description" : "The domain name written in Punycode syntax(IDN)." }, "priceClass" : { "type" : "string", "description" : "The price class of the domain when registering." }, "priceClassRenew" : { "type" : "string", "description" : "The price class of the domain at renew." }, "price" : { "type" : "number", "format" : "double", "description" : "The current domain price." }, "currency" : { "type" : "string", "example" : "EUR, USD", "description" : "A system of money in common use within a specific environment over time. Currency codes are used in the ISO 4217 format.", "x-custom-type" : "currency" }, "provider" : { "type" : "string", "description" : "Name of the provider who provides this domain." }, "configuration" : { "example" : "comment_en=Without any guarantee, batchsize=1, threads=1, url=https://www.internetx.com", "description" : "Additional information.", "$ref" : "#/definitions/Configuration" }, "metric" : { "example" : "length of the sld", "description" : "Metrics of the domain, e.g.", "$ref" : "#/definitions/Metric" }, "owner" : { "description" : "The object owner.", "$ref" : "#/definitions/User" }, "updater" : { "description" : "User who performed the last update.", "$ref" : "#/definitions/User" }, "premiumStatus" : { "example" : "FREE, ASSIGNED, INACTIVE, EAP, ON_HOLD, OFFERED, SYNC_ERROR", "description" : "The domain status.", "$ref" : "#/definitions/PremiumStatusConstants" } } }, "DomainPrereg" : { "type" : "object", "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "owner" : { "description" : "The object owner.", "$ref" : "#/definitions/User" }, "updater" : { "description" : "User who performed the last update.", "$ref" : "#/definitions/User" }, "ownerc" : { "description" : "The owner contact.", "$ref" : "#/definitions/Contact" }, "adminc" : { "description" : "The administrative contact.", "$ref" : "#/definitions/Contact" }, "techc" : { "description" : "The technical contact reference.", "$ref" : "#/definitions/Contact" }, "zonec" : { "description" : "The dns contact.", "$ref" : "#/definitions/Contact" }, "name" : { "type" : "string", "description" : "Name of the domain to be pre-registered." }, "authinfo" : { "type" : "string", "description" : "AuthInfo for the domain." }, "nameServers" : { "type" : "array", "description" : "The nameserver hostnames used for the domain which contains the DNS information.", "items" : { "$ref" : "#/definitions/NameServer" } }, "nameServerEntries" : { "type" : "array", "description" : "The nameserver hostnames used for connecting the domain in the DNS. \nIs only used for .de domains.", "items" : { "type" : "string" } }, "status" : { "description" : "Preregistration status.", "$ref" : "#/definitions/DomainPreregStatusConstants" }, "phase" : { "type" : "string", "description" : "The name of the preregistration phase whose name depends on the TLD." }, "extension" : { "description" : "The preregistration extensions.", "$ref" : "#/definitions/DomainPreregAddon" }, "orderReference" : { "type" : "string", "description" : "The unique reference value of the domain preregistration order." }, "tmchMark" : { "description" : "TMCH mark reference number.", "$ref" : "#/definitions/TmchMark" }, "preregConfig" : { "description" : "The preregistration configuration.", "$ref" : "#/definitions/PreregConfig" }, "idn" : { "type" : "string", "description" : "The domain written in IDN form (Punycode syntax)." }, "confirmed" : { "type" : "string", "format" : "date-time", "description" : "The date on which the preregistration was confirmed by the user." }, "trustee" : { "type" : "boolean", "description" : "Is a trustee used or not?\nfalse = No trustee is used\ntrue = A trustee is used\nDefault value = false\nFor XML, 0 (false) and 1 (true) can also be used.." }, "domainCreated" : { "type" : "string", "format" : "date-time", "description" : "Date on which the domain was registered at the registry." }, "domainExpire" : { "type" : "string", "format" : "date-time", "description" : "Date on which the domain expires at the registry." }, "registryStatus" : { "description" : "Status of the domain at the registry.", "$ref" : "#/definitions/RegistryStatusConstants" }, "recommended" : { "type" : "boolean", "description" : "\"Setting for visibility in list view. Recommended preregistrations \nare visible for power users only.\nfalse = Not recommended\ntrue = Recommended\nDefault value = false\nFor XML, 0 (false) and 1 (true) can also be used.\"" } } }, "DomainPreregAddon" : { "type" : "object", "properties" : { "irpAppCapacit" : { "type" : "string", "description" : "The Irp App Capacity." }, "irpAppDate" : { "type" : "string", "format" : "date-time", "description" : "Date on which the trademark was applied for." }, "irpCcLocality" : { "type" : "string", "description" : "Country code of where the trademark is registered." }, "irpName" : { "type" : "string", "description" : "Name of the right or trademark." }, "irpNumber" : { "type" : "string", "description" : "Number of the right or trademark." }, "irpPvrc" : { "type" : "string", "description" : "The pre-validation code." }, "irpRegDate" : { "type" : "string", "format" : "date-time", "description" : "Date on which the mark was assigned." }, "mode" : { "type" : "string", "example" : "MERGE, REPLACE", "description" : "The addon update mode, defining the procedure upon updating addons." }, "confirmOrder" : { "type" : "boolean", "description" : "Confirmation of the order\n\nfalse = No confirmation\ntrue = Confirmation\nDefault value = false" }, "externalReference" : { "type" : "string", "description" : "Reference of the trademark entry." }, "notAfter" : { "type" : "string", "format" : "date-time", "description" : "Date until which the trademark registration is valid." }, "confirmed" : { "type" : "string", "format" : "date-time", "description" : "Date on which the trademark registration was confirmed." }, "confirmIp" : { "type" : "string", "description" : "IP from which the trademark registration was confirmed." }, "priceClass" : { "type" : "string", "description" : "Price class of the domain." } } }, "DomainPreregStatusConstants" : { "type" : "string", "enum" : [ "PENDING", "PENDING_SENT", "PENDING_DOCUMENT_SENT", "PENDING_PROGRESS", "PENDING_UPDATE", "PENDING_SENT_UPDATE", "TIMEOUT", "ACCEPT", "DECLINE", "INVALID_NAME", "FAILED", "CANCEL", "AUTO_CANCEL", "ACTIVE", "SENT", "OPEN", "TMCH_CLAIM", "TMCH_CLAIM_CONFIRMED", "TMCH_CLAIM_REJECTED", "TMCH_CLAIM_EXPIRED", "TMCH_CLAIM_PENDING", "TMCH_CLAIM_FAILED", "FAILED_REF" ] }, "DomainRestore" : { "type" : "object", "required" : [ "name", "payable", "removeCancelation" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "owner" : { "description" : "The object owner.", "$ref" : "#/definitions/User" }, "updater" : { "description" : "User who performed the last update.", "$ref" : "#/definitions/User" }, "name" : { "type" : "string", "example" : "domain.de", "description" : "The name of the domain." }, "idn" : { "type" : "string", "example" : "müller.org", "description" : "The unicode domain name" }, "domainCreated" : { "type" : "string", "format" : "date-time", "description" : "The domain creation of the domain at the registry." }, "nicMemberLabel" : { "type" : "string", "description" : "The nic member label." }, "registryStatus" : { "description" : "The registry status.", "$ref" : "#/definitions/RegistryStatusConstants" }, "nameServers" : { "type" : "array", "description" : "The nameservers.", "items" : { "$ref" : "#/definitions/NameServer" } }, "nameServerEntries" : { "type" : "array", "description" : "NSentry is only be provided for .DE. If NSentry is used, nameServers is not allowed.", "items" : { "type" : "string" } }, "period" : { "description" : "The period in years, depends on the requested action", "$ref" : "#/definitions/TimePeriod" }, "trustee" : { "type" : "boolean", "description" : "Enable trustee service for the domain." }, "privacy" : { "type" : "boolean", "description" : "Enable privacy service for the domain." }, "authinfo" : { "type" : "string", "description" : "The authinfo." }, "authinfoExpire" : { "type" : "string", "format" : "date-time", "description" : "The expire date of the authinfo." }, "domainsafe" : { "type" : "boolean", "description" : "Enable domainsafe." }, "parking" : { "description" : "The parking provider.", "$ref" : "#/definitions/ParkingProviderConstants" }, "extensions" : { "description" : "The domain extensions.", "$ref" : "#/definitions/DomainExtensions" }, "logId" : { "type" : "integer", "format" : "int64", "description" : "The logId" }, "confirmOrder" : { "type" : "boolean", "description" : "Some TLDs require a confirmation of the “Terms and Conditions of Registration." }, "confirmOwnerConsent" : { "type" : "boolean", "description" : "Confirms the consent of the domainowner for the changes. Required for gTLDs and new gTLDs when changing the name, the email address or the organization of the domain owner." }, "ignoreWhois" : { "type" : "boolean", "description" : "Ignore whois." }, "comment" : { "type" : "string", "description" : "A custom field. Can only be updated via PUT /domain/{name}/_comment. Requires appropriate ACLs." }, "registrarStatus" : { "description" : "The registrar status.", "$ref" : "#/definitions/RegistryStatusConstants" }, "registrarStatusReason" : { "type" : "string", "description" : "The registrar status reason." }, "removeCancelation" : { "type" : "boolean", "description" : "Remove cancelation." }, "autodnsSecJob" : { "description" : "AutodnsSecJob", "$ref" : "#/definitions/DNSSecJob" }, "priceClass" : { "type" : "string", "description" : "The priceclass for the registration of the domain." }, "priceClassRenew" : { "type" : "string", "description" : "The priceclass for the renew of the domain." }, "abuseEmail" : { "type" : "string", "description" : "The abuse email." }, "generalRequestEmail" : { "type" : "string", "description" : "The general request mail." }, "privacyPlusMail" : { "type" : "string", "description" : "The privacy plus mail." }, "privacyPlus" : { "type" : "boolean", "description" : "Enable privacy plus." }, "nameServerGroup" : { "type" : "string", "description" : "The nameserver group." }, "rddsOptIn" : { "description" : "Enables the whois output to show redacted contacts.", "$ref" : "#/definitions/RddsOptInConstants" }, "servicesAdd" : { "description" : "Adds pending services like BackupMX and MailProxy.", "$ref" : "#/definitions/DomainServices" }, "servicesRem" : { "description" : "Removes pending services like BackupMX and MailProxy.", "$ref" : "#/definitions/DomainServices" }, "deleted" : { "type" : "string", "format" : "date-time", "description" : "The date at deletion of the domain" }, "restorePhaseEnd" : { "type" : "string", "format" : "date-time", "description" : "The end of current restore phase" }, "ownerc" : { "description" : "The owner contact.", "$ref" : "#/definitions/Contact" }, "adminc" : { "description" : "The administrative contact.", "$ref" : "#/definitions/Contact" }, "techc" : { "description" : "The technical contact reference.", "$ref" : "#/definitions/Contact" }, "zonec" : { "description" : "The dns contact.", "$ref" : "#/definitions/Contact" }, "expire" : { "type" : "string", "format" : "date-time", "description" : "The expire date of the domain." }, "payable" : { "type" : "string", "format" : "date-time", "description" : "The payable date of the domain." }, "action" : { "description" : "The last action.", "$ref" : "#/definitions/DomainActionConstants" }, "autoDnssec" : { "type" : "boolean", "description" : "Enables or disables automatic DNSSEC for certain name servers (e.g. NodeSecure)." }, "dnssec" : { "type" : "boolean", "description" : "Indicates whether DNSSEC is enabled for the domain or not." }, "validCertificate" : { "type" : "boolean", "description" : "Domain has an matching certificate." }, "cancelationStatus" : { "description" : "The cancelation status.", "$ref" : "#/definitions/CancelationStatusConstants" }, "autoRenewStatus" : { "description" : "The autorenew status.", "$ref" : "#/definitions/AutoRenewStatusConstants" }, "dnssecData" : { "type" : "array", "description" : "Submits the key material to the registry. If the list is empty, the key material is deleted at the registry. If the key is omitted during an update, the data is retained.", "items" : { "$ref" : "#/definitions/DNSSec" } }, "zone" : { "description" : "The zone to create.", "$ref" : "#/definitions/Zone" } } }, "DomainSafeAccount" : { "type" : "object", "required" : [ "mobile", "pin" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "owner" : { "description" : "The object owner.", "$ref" : "#/definitions/User" }, "updater" : { "description" : "User who performed the last update.", "$ref" : "#/definitions/User" }, "name" : { "type" : "string", "description" : "The name of the object." }, "mobile" : { "description" : "The mobile of the object.", "$ref" : "#/definitions/Phone" }, "pin" : { "type" : "string", "description" : "The pin of the object." }, "revalidationNumber" : { "description" : "The revalidationNumber of the object.", "$ref" : "#/definitions/Phone" }, "safeuser" : { "type" : "array", "description" : "The safeUser of the object.", "items" : { "$ref" : "#/definitions/DomainSafeUser" } } } }, "DomainSafeObject" : { "type" : "object", "required" : [ "name", "type" ], "properties" : { "type" : { "type" : "string", "description" : "The type of the object." }, "name" : { "type" : "string", "description" : "The name of the object." }, "idn" : { "type" : "string", "description" : "The idn of the object." }, "owner" : { "description" : "The owner of the object", "$ref" : "#/definitions/User" }, "updater" : { "description" : "The updating user of the object", "$ref" : "#/definitions/User" }, "updated" : { "type" : "string", "format" : "date-time", "description" : "The updated date." } } }, "DomainSafeUser" : { "type" : "object", "required" : [ "context", "user" ], "properties" : { "context" : { "type" : "integer", "format" : "int32", "description" : "The context." }, "mobile" : { "description" : "The mobile of the user.", "$ref" : "#/definitions/Phone" }, "user" : { "type" : "string", "description" : "The user name." }, "pin" : { "type" : "string", "description" : "The pin." } } }, "DomainSellExtensions" : { "type" : "object", "properties" : { "currency" : { "type" : "string", "example" : "EUR", "description" : "The currency of the sale", "x-custom-type" : "currency" }, "price" : { "type" : "number", "format" : "double", "description" : "The price to use" }, "keywords" : { "type" : "array", "description" : "The keywords to use", "items" : { "type" : "string" } }, "fixedPrice" : { "type" : "boolean", "description" : "Is the price fix" }, "minPrice" : { "type" : "number", "format" : "double", "description" : "The minimum of price" }, "mode" : { "description" : "The mode.", "$ref" : "#/definitions/SellMode" } } }, "DomainServices" : { "type" : "object", "properties" : { "backupMx" : { "type" : "array", "description" : "This object contains possible domain services that can be configured during a DomainCreate or DomainUpdate.", "items" : { "$ref" : "#/definitions/BackupMx" } }, "mailProxy" : { "type" : "array", "description" : "This object contains possible domain services that can be configured during a DomainCreate or DomainUpdate.", "items" : { "$ref" : "#/definitions/MailProxy" } }, "redirect" : { "type" : "array", "description" : "This object contains possible domain services that can be configured during a DomainCreate or DomainUpdate.", "items" : { "$ref" : "#/definitions/Redirect" } }, "domainMonitoring" : { "type" : "array", "description" : "This object contains possible domain services that can be configured during a DomainCreate or DomainUpdate.", "items" : { "$ref" : "#/definitions/DomainMonitoring" } } } }, "DomainServicesUpdate" : { "type" : "object", "properties" : { "domains" : { "type" : "array", "description" : "The name of the domain.", "items" : { "$ref" : "#/definitions/Domain" } }, "servicesAdd" : { "description" : "The services to add.", "$ref" : "#/definitions/DomainServices" }, "servicesRem" : { "description" : "The services to remove.", "$ref" : "#/definitions/DomainServices" } } }, "DomainStudioClassifyRequest" : { "type" : "object", "properties" : { "searchToken" : { "type" : "string", "description" : "Domain search token" }, "useTldSuggestions" : { "type" : "boolean", "description" : "Whether to suggest tlds for the given search token or not" }, "useTldScoring" : { "type" : "boolean", "description" : "Wheter to create a tld scoring or not" }, "tldSuggestionSize" : { "type" : "integer", "format" : "int32", "description" : "The amount of suggested tlds" }, "language" : { "type" : "string", "description" : "The language to be used. Allowed values : en, de, es, fr, it" }, "taxonomy" : { "type" : "string", "description" : "The taxonomy to be used for categorising. Allowed values : dit, internetx" } } }, "DomainStudioDomainSource" : { "type" : "string", "enum" : [ "INITIAL", "SUGGESTION", "PREMIUM", "GEO", "SIMILAR", "RECOMMENDED", "CUSTOM", "ONLINE_PRESENCE", "SPIN_WORD", "PERSONAL_NAMES", "UPCOMING", "MARKET", "DOMAINSBOT", "PLACEMENT_PLUS" ] }, "DomainStudioDomainStatus" : { "type" : "string", "enum" : [ "FREE", "ASSIGNED", "MARKET", "PREMIUM", "INVALID", "ERROR", "TIMEOUT", "RESERVED", "PREMIUM_CLAIM", "CLAIM", "OFFER" ] }, "DomainStudioService" : { "type" : "object", "properties" : { "whois" : { "description" : "The data for the whois service", "$ref" : "#/definitions/WhoisServiceData" }, "price" : { "description" : "The data for the price service", "$ref" : "#/definitions/PriceServiceData" }, "estimation" : { "description" : "The data for the estimation service", "$ref" : "#/definitions/EstimationServiceData" } } }, "DomainStudioServiceStatus" : { "type" : "string", "enum" : [ "RUNNING", "SUCCESS", "FAILED", "TIMEOUT" ] }, "DomainStudioSourceCustom" : { "type" : "object", "properties" : { "services" : { "type" : "array", "description" : "The services to fetch extra data from for this source", "items" : { "$ref" : "#/definitions/DomainEnvelopeSearchService" } }, "onlyAvailable" : { "type" : "boolean", "description" : "Defines whether to return only free domain names when service WHOIS is used for a source." }, "domains" : { "type" : "array", "description" : "Custom list of domains", "items" : { "type" : "string" } } } }, "DomainStudioSourceDomainsBot" : { "type" : "object", "properties" : { "services" : { "type" : "array", "description" : "The services to fetch extra data from for this source", "items" : { "$ref" : "#/definitions/DomainEnvelopeSearchService" } }, "onlyAvailable" : { "type" : "boolean", "description" : "Defines whether to return only free domain names when service WHOIS is used for a source." }, "domains" : { "type" : "array", "description" : "The generated domains of this source", "items" : { "type" : "string" } }, "language" : { "type" : "string", "description" : "Suggestion language" }, "max" : { "type" : "integer", "format" : "int32", "description" : "Maximum fetched suggested domains" }, "useDash" : { "type" : "boolean", "description" : "Suggest domains with dash" }, "useIdn" : { "type" : "boolean", "description" : "Suggest domains with idn" }, "tlds" : { "type" : "array", "description" : "Selected tlds", "items" : { "type" : "string" } }, "func" : { "type" : "string", "description" : "Defines the type of recommendation. Accepted values: 0 (default),1,2,3 and 4. 0 allows both TLD and Domain Recommendation.\n1 allows only TLD Recommendations to be displayed.\n2 allows only Domain Recommendations to be displayed\n3 allows only TLD Recommendations to be displayed plus simple domain variations\nallows both TLD and Domain Recommendation (like func=0) BUT only returns Domains\nRecommendations that are either a top legacy TLD such as com, net or org or any TLD IF the confidence score is higher than a minimum threshold." }, "adult" : { "type" : "boolean", "description" : "Exclude adult related and possibly offensive domains" }, "minConfidence" : { "type" : "number", "format" : "float", "description" : "filter our domains whose confidence score is lower than your threshold. This parameters accepts values between 0.0 and 1.0. The default value is set to 0.0." }, "defScore" : { "type" : "array", "description" : "Override the default selection of generic TLDs and their base score. TLD and their custom score must be separated by the column sign “:”. Example org:1,club:0.5,xyz:0.0", "items" : { "type" : "string" } }, "sid" : { "type" : "string", "description" : "The acronym for Session Identifier" }, "aid" : { "type" : "string", "description" : "The acronym for AccountIdentifier" }, "rid" : { "type" : "string", "description" : "The acronym for ResellerIdentifier" } } }, "DomainStudioSourceGeo" : { "type" : "object", "properties" : { "services" : { "type" : "array", "description" : "The services to fetch extra data from for this source", "items" : { "$ref" : "#/definitions/DomainEnvelopeSearchService" } }, "onlyAvailable" : { "type" : "boolean", "description" : "Defines whether to return only free domain names when service WHOIS is used for a source." }, "domains" : { "type" : "array", "description" : "The generated domains of this source", "items" : { "type" : "string" } }, "max" : { "type" : "integer", "format" : "int32", "description" : "The maximum amount of fetched geo domains." } } }, "DomainStudioSourceInitial" : { "type" : "object", "properties" : { "services" : { "type" : "array", "description" : "The services to fetch extra data from for this source", "items" : { "$ref" : "#/definitions/DomainEnvelopeSearchService" } }, "onlyAvailable" : { "type" : "boolean", "description" : "Defines whether to return only free domain names when service WHOIS is used for a source." }, "domains" : { "type" : "array", "description" : "The generated domains of this source", "items" : { "type" : "string" } }, "tlds" : { "type" : "array", "description" : "Selected tlds", "items" : { "type" : "string" } } } }, "DomainStudioSourceMarket" : { "type" : "object", "properties" : { "services" : { "type" : "array", "description" : "The services to fetch extra data from for this source", "items" : { "$ref" : "#/definitions/DomainEnvelopeSearchService" } }, "onlyAvailable" : { "type" : "boolean", "description" : "Defines whether to return only free domain names when service WHOIS is used for a source." }, "domains" : { "type" : "array", "description" : "The generated domains of this source", "items" : { "type" : "string" } }, "promoTlds" : { "type" : "array", "description" : "Promo tlds", "items" : { "type" : "string" } }, "topTlds" : { "type" : "array", "description" : "Top tlds", "items" : { "type" : "string" } }, "max" : { "type" : "integer", "format" : "int32", "description" : "The maximum amount of fetched premium and market domains." }, "priceMin" : { "type" : "integer", "format" : "int32", "description" : "The minumum price." }, "priceMax" : { "type" : "integer", "format" : "int32", "description" : "The maximum price." } } }, "DomainStudioSourceOnlinePresence" : { "type" : "object", "properties" : { "services" : { "type" : "array", "description" : "The services to fetch extra data from for this source", "items" : { "$ref" : "#/definitions/DomainEnvelopeSearchService" } }, "onlyAvailable" : { "type" : "boolean", "description" : "Defines whether to return only free domain names when service WHOIS is used for a source." }, "domains" : { "type" : "array", "description" : "The generated domains of this source", "items" : { "type" : "string" } }, "max" : { "type" : "integer", "format" : "int32", "description" : "Maximum fetched suggested domains" }, "maxSldLength" : { "type" : "integer", "format" : "int32", "description" : "Maximum sld length for suggested domains" }, "useDash" : { "type" : "boolean", "description" : "Suggested domains with dash" }, "tlds" : { "type" : "array", "description" : "Selected tlds", "items" : { "type" : "string" } }, "onlinePresenceUrl" : { "type" : "string", "description" : "The primary online presence URL." }, "onlinePresenceTitle" : { "type" : "string", "description" : "The title of a website or a page." }, "relatedUrls" : { "type" : "array", "description" : "List of related URLs.", "items" : { "type" : "string" } }, "category" : { "type" : "string", "description" : "Business category." }, "onlinePresenceDescription" : { "type" : "string", "description" : "Description of the page." }, "preferredName" : { "type" : "string", "description" : "Preferred name. This parameter value isused to create exact match suggestions inpreferred TLDs prioritizing them aboveother suggestions." }, "location" : { "type" : "string", "description" : "Location of the business." }, "business" : { "type" : "boolean", "description" : "A flag indicating if the online presence is a business ornot." }, "shortName" : { "type" : "string", "description" : "Short name (nick name)." }, "fullName" : { "type" : "string", "description" : "Full name." }, "firstName" : { "type" : "string", "description" : "First name." }, "middleNames" : { "type" : "array", "description" : "List of middle names.", "items" : { "type" : "string" } }, "lastName" : { "type" : "string", "description" : "Last name." }, "email" : { "type" : "string", "description" : "Email." }, "hometown" : { "type" : "string", "description" : "Hometown." }, "skills" : { "type" : "array", "description" : "List of skills.", "items" : { "type" : "string" } } } }, "DomainStudioSourcePersonalNames" : { "type" : "object", "properties" : { "services" : { "type" : "array", "description" : "The services to fetch extra data from for this source", "items" : { "$ref" : "#/definitions/DomainEnvelopeSearchService" } }, "onlyAvailable" : { "type" : "boolean", "description" : "Defines whether to return only free domain names when service WHOIS is used for a source." }, "domains" : { "type" : "array", "description" : "The generated domains of this source", "items" : { "type" : "string" } }, "max" : { "type" : "integer", "format" : "int32", "description" : "Maximum fetched suggested domains" }, "maxSldLength" : { "type" : "integer", "format" : "int32", "description" : "Maximum sld length for suggested domains" }, "useDash" : { "type" : "boolean", "description" : "Suggested domains with dash" }, "spinFirstName" : { "type" : "boolean", "description" : "Spin the first-name with relevant nicknames" }, "tlds" : { "type" : "array", "description" : "Selected tlds", "items" : { "type" : "string" } }, "firstName" : { "type" : "string", "description" : "First name." }, "middleNames" : { "type" : "array", "description" : "List of middle names.", "items" : { "type" : "string" } }, "lastName" : { "type" : "string", "description" : "Last name." }, "useIdn" : { "type" : "boolean", "description" : "Suggested domains with idn" } } }, "DomainStudioSourcePlacementPlus" : { "type" : "object", "properties" : { "services" : { "type" : "array", "description" : "The services to fetch extra data from for this source", "items" : { "$ref" : "#/definitions/DomainEnvelopeSearchService" } }, "onlyAvailable" : { "type" : "boolean", "description" : "Defines whether to return only free domain names when service WHOIS is used for a source." }, "domains" : { "type" : "array", "description" : "The generated domains of this source", "items" : { "type" : "string" } }, "language" : { "type" : "string", "description" : "Suggestion language" }, "max" : { "type" : "integer", "format" : "int32", "description" : "Maximum fetched suggested domains" }, "useDash" : { "type" : "boolean", "description" : "Suggest domains with dash" }, "useIdn" : { "type" : "boolean", "description" : "Suggest domains with idn" }, "tlds" : { "type" : "array", "description" : "Selected tlds", "readOnly" : true, "items" : { "type" : "string" } }, "func" : { "type" : "string", "description" : "Defines the type of recommendation. Accepted values: 0 (default),1,2,3 and 4. 0 allows both TLD and Domain Recommendation.\n1 allows only TLD Recommendations to be displayed.\n2 allows only Domain Recommendations to be displayed\n3 allows only TLD Recommendations to be displayed plus simple domain variations\nallows both TLD and Domain Recommendation (like func=0) BUT only returns Domains\nRecommendations that are either a top legacy TLD such as com, net or org or any TLD IF the confidence score is higher than a minimum threshold." }, "adult" : { "type" : "boolean", "description" : "Exclude adult related and possibly offensive domains" }, "minConfidence" : { "type" : "number", "format" : "float", "description" : "filter our domains whose confidence score is lower than your threshold. This parameters accepts values between 0.0 and 1.0. The default value is set to 0.0." }, "defScore" : { "type" : "array", "description" : "Override the default selection of generic TLDs and their base score. TLD and their custom score must be separated by the column sign “:”. Example org:1,club:0.5,xyz:0.0", "items" : { "type" : "string" } }, "sid" : { "type" : "string", "description" : "The acronym for Session Identifier" }, "aid" : { "type" : "string", "description" : "The acronym for AccountIdentifier" }, "rid" : { "type" : "string", "description" : "The acronym for ResellerIdentifier" } } }, "DomainStudioSourcePrefixSuffix" : { "type" : "object", "properties" : { "services" : { "type" : "array", "description" : "The services to fetch extra data from for this source", "items" : { "$ref" : "#/definitions/DomainEnvelopeSearchService" } }, "onlyAvailable" : { "type" : "boolean", "description" : "Defines whether to return only free domain names when service WHOIS is used for a source." }, "domains" : { "type" : "array", "description" : "The generated domains of this source", "items" : { "type" : "string" } }, "language" : { "type" : "string", "description" : "Suggestion language" }, "max" : { "type" : "integer", "format" : "int32", "description" : "Maximum fetched suggested domains" }, "maxSldLength" : { "type" : "integer", "format" : "int32", "description" : "Maximum sld length for suggested domains" }, "tlds" : { "type" : "array", "description" : "Selected tlds", "items" : { "type" : "string" } }, "prefixVocabulary" : { "type" : "array", "description" : "Vocabulary to use when picking the prefixes. Can be a custom list of words. If this is null or empty, a predefined list of prefixes will be used.", "items" : { "type" : "string" } }, "suffixVocabulary" : { "type" : "array", "description" : "Vocabulary to use when picking the suffixes. Can be a custom list of words. If this is null or empty, a predefined list of suffixes will be used.", "items" : { "type" : "string" } }, "useIdn" : { "type" : "boolean", "description" : "Suggested domains with idn" }, "useDash" : { "type" : "boolean", "description" : "Suggested domains with dash" } } }, "DomainStudioSourcePremium" : { "type" : "object", "properties" : { "services" : { "type" : "array", "description" : "The services to fetch extra data from for this source", "items" : { "$ref" : "#/definitions/DomainEnvelopeSearchService" } }, "onlyAvailable" : { "type" : "boolean", "description" : "Defines whether to return only free domain names when service WHOIS is used for a source." }, "domains" : { "type" : "array", "description" : "The generated domains of this source", "items" : { "type" : "string" } }, "promoTlds" : { "type" : "array", "description" : "Promo tlds", "items" : { "type" : "string" } }, "topTlds" : { "type" : "array", "description" : "Top tlds", "items" : { "type" : "string" } }, "max" : { "type" : "integer", "format" : "int32", "description" : "The maximum amount of fetched premium and market domains." }, "priceMin" : { "type" : "integer", "format" : "int32", "description" : "The minumum price." }, "priceMax" : { "type" : "integer", "format" : "int32", "description" : "The maximum price." } } }, "DomainStudioSourceRecommended" : { "type" : "object", "properties" : { "services" : { "type" : "array", "description" : "The services to fetch extra data from for this source", "items" : { "$ref" : "#/definitions/DomainEnvelopeSearchService" } }, "onlyAvailable" : { "type" : "boolean", "description" : "Defines whether to return only free domain names when service WHOIS is used for a source." }, "domains" : { "type" : "array", "description" : "The generated domains of this source", "items" : { "type" : "string" } }, "max" : { "type" : "integer", "format" : "int32", "description" : "The maximum amount of generated similar domains." } } }, "DomainStudioSourceSimilar" : { "type" : "object", "properties" : { "services" : { "type" : "array", "description" : "The services to fetch extra data from for this source", "items" : { "$ref" : "#/definitions/DomainEnvelopeSearchService" } }, "onlyAvailable" : { "type" : "boolean", "description" : "Defines whether to return only free domain names when service WHOIS is used for a source." }, "domains" : { "type" : "array", "description" : "The generated domains of this source", "items" : { "type" : "string" } }, "max" : { "type" : "integer", "format" : "int32", "description" : "The maximum amount of generated similar domains." }, "tlds" : { "type" : "array", "description" : "Selected tlds", "items" : { "type" : "string" } } } }, "DomainStudioSourceSpinWord" : { "type" : "object", "properties" : { "services" : { "type" : "array", "description" : "The services to fetch extra data from for this source", "items" : { "$ref" : "#/definitions/DomainEnvelopeSearchService" } }, "onlyAvailable" : { "type" : "boolean", "description" : "Defines whether to return only free domain names when service WHOIS is used for a source." }, "domains" : { "type" : "array", "description" : "The generated domains of this source", "items" : { "type" : "string" } }, "max" : { "type" : "integer", "format" : "int32", "description" : "Maximum fetched suggested domains" }, "maxSldLength" : { "type" : "integer", "format" : "int32", "description" : "Maximum sld length for suggested domains" }, "tlds" : { "type" : "array", "description" : "Selected tlds", "items" : { "type" : "string" } }, "useIdn" : { "type" : "boolean", "description" : "Suggested domains with idn" }, "similarity" : { "type" : "number", "format" : "double", "description" : "Double with a value between 0.00 and 1.00.The higher this value, the closer thealternate word will be to the original word." }, "position" : { "type" : "integer", "format" : "int32", "description" : "Position of the word for selective wordsuggestion starting with “0” for the firstword. If no position is supplied, allpositions are spinned." } } }, "DomainStudioSourceSuggestion" : { "type" : "object", "properties" : { "services" : { "type" : "array", "description" : "The services to fetch extra data from for this source", "items" : { "$ref" : "#/definitions/DomainEnvelopeSearchService" } }, "onlyAvailable" : { "type" : "boolean", "description" : "Defines whether to return only free domain names when service WHOIS is used for a source." }, "domains" : { "type" : "array", "description" : "The generated domains of this source", "items" : { "type" : "string" } }, "language" : { "type" : "string", "description" : "Suggestion language" }, "max" : { "type" : "integer", "format" : "int32", "description" : "Maximum fetched suggested domains" }, "maxSldLength" : { "type" : "integer", "format" : "int32", "description" : "Maximum sld length for suggested domains" }, "useDash" : { "type" : "boolean", "description" : "Suggested domains with dash" }, "useNumber" : { "type" : "boolean", "description" : "Suggested domains with numbers" }, "useIdn" : { "type" : "boolean", "description" : "Suggested domains with idn" }, "tlds" : { "type" : "array", "description" : "Selected tlds", "items" : { "type" : "string" } }, "debugTime" : { "type" : "integer", "format" : "int64", "description" : "The debug time" } } }, "DomainStudioSourceSuggestion2" : { "type" : "object", "properties" : { "services" : { "type" : "array", "description" : "The services to fetch extra data from for this source", "items" : { "$ref" : "#/definitions/DomainEnvelopeSearchService" } }, "onlyAvailable" : { "type" : "boolean", "description" : "Defines whether to return only free domain names when service WHOIS is used for a source." }, "domains" : { "type" : "array", "description" : "The generated domains of this source", "items" : { "type" : "string" } }, "language" : { "type" : "string", "description" : "Suggestion language" }, "max" : { "type" : "integer", "format" : "int32", "description" : "Maximum fetched suggested domains" }, "maxSimilarWords" : { "type" : "integer", "format" : "int32", "description" : "?" }, "maxPrefixSuffix" : { "type" : "integer", "format" : "int32", "description" : "?" }, "useDash" : { "type" : "boolean", "description" : "Suggested domains with dash" }, "useWordSegmentation" : { "type" : "boolean", "description" : "Suggested domains with idn" }, "tlds" : { "type" : "array", "description" : "Selected tlds", "items" : { "type" : "string" } }, "debugTime" : { "type" : "integer", "format" : "int64", "description" : "The debug time" } } }, "DomainStudioSourceUpcoming" : { "type" : "object", "properties" : { "services" : { "type" : "array", "description" : "The services to fetch extra data from for this source", "items" : { "$ref" : "#/definitions/DomainEnvelopeSearchService" } }, "onlyAvailable" : { "type" : "boolean", "description" : "Defines whether to return only free domain names when service WHOIS is used for a source." }, "domains" : { "type" : "array", "description" : "The generated domains of this source", "items" : { "type" : "string" } }, "max" : { "type" : "integer", "format" : "int32", "description" : "Maximum fetched upcoming domains" } } }, "DomainStudioSources" : { "type" : "object", "properties" : { "initial" : { "description" : "The configuration for the initial source", "$ref" : "#/definitions/DomainStudioSourceInitial" }, "suggestion" : { "description" : "The configuration for the suggestion source", "$ref" : "#/definitions/DomainStudioSourceSuggestion" }, "premium" : { "description" : "The configuration for the premium source", "$ref" : "#/definitions/DomainStudioSourcePremium" }, "market" : { "description" : "The configuration for the market source", "$ref" : "#/definitions/DomainStudioSourceMarket" }, "geo" : { "description" : "The configuration for the geo source", "$ref" : "#/definitions/DomainStudioSourceGeo" }, "similar" : { "description" : "The configuration for the similar source", "$ref" : "#/definitions/DomainStudioSourceSimilar" }, "recommended" : { "description" : "The configuration for the recommended source", "$ref" : "#/definitions/DomainStudioSourceRecommended" }, "custom" : { "description" : "The configuration for the custom source", "$ref" : "#/definitions/DomainStudioSourceCustom" }, "onlinePresence" : { "description" : "The configuration for the online presence source", "$ref" : "#/definitions/DomainStudioSourceOnlinePresence" }, "personalNames" : { "description" : "The configuration for the personal names source", "$ref" : "#/definitions/DomainStudioSourcePersonalNames" }, "spinWord" : { "description" : "The configuration for the spin word source", "$ref" : "#/definitions/DomainStudioSourceSpinWord" }, "upcoming" : { "description" : "The configuration for the upcoming source", "$ref" : "#/definitions/DomainStudioSourceUpcoming" }, "domainsbot" : { "description" : "The configuration for the domainsbot", "$ref" : "#/definitions/DomainStudioSourceDomainsBot" }, "placementPlus" : { "description" : "The configuration for the PlacementPlus source", "$ref" : "#/definitions/DomainStudioSourcePlacementPlus" }, "prefixSuffix" : { "description" : "The configuration for the prefix suffix source", "$ref" : "#/definitions/DomainStudioSourcePrefixSuffix" }, "semantic" : { "description" : "The configuration for the suggestion2 source", "$ref" : "#/definitions/DomainStudioSourceSuggestion2" } } }, "DomainTmchClaimNoticeExtensions" : { "type" : "object", "properties" : { "externalReference" : { "type" : "string", "description" : "The external refernce" }, "notAfter" : { "type" : "string", "format" : "date-time", "description" : "Date after the claim expires" }, "confirmed" : { "type" : "string", "format" : "date-time", "description" : "The date of confirmation" }, "confirmIp" : { "type" : "string", "description" : "The confirm ip" } } }, "DomainstudioSocialMediaRequest" : { "type" : "object", "properties" : { "searchToken" : { "type" : "string", "description" : "Domain search token" }, "platforms" : { "type" : "array", "description" : "The platforms to check", "items" : { "$ref" : "#/definitions/SocialMediaPlatform" } }, "clientIp" : { "type" : "string", "description" : "The ip of the client" } } }, "EstimationData" : { "type" : "object", "properties" : { "currency" : { "description" : "The currency", "$ref" : "#/definitions/Currency" }, "amount" : { "type" : "number", "format" : "double", "description" : "The amount" } } }, "EstimationServiceData" : { "type" : "object", "properties" : { "debugTime" : { "type" : "integer", "format" : "int64", "description" : "The debug time" }, "status" : { "description" : "The status", "$ref" : "#/definitions/DomainStudioServiceStatus" }, "message" : { "type" : "string", "description" : "A message with more information, if the status is FAILED." }, "data" : { "description" : "The service data", "$ref" : "#/definitions/EstimationData" } } }, "ExchangedPrice" : { "type" : "object", "required" : [ "amount", "currency" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "id" : { "type" : "integer", "format" : "int32", "example" : 1, "description" : "The unique identifier of the price" }, "owner" : { "description" : "The object owner.", "$ref" : "#/definitions/User" }, "updater" : { "description" : "User who performed the last update.", "$ref" : "#/definitions/User" }, "amount" : { "type" : "number", "format" : "double", "description" : "Amount" }, "type" : { "description" : "The price type", "$ref" : "#/definitions/PriceTypeConstants" }, "currency" : { "type" : "string", "example" : "EUR", "description" : "Used currency ", "x-custom-type" : "currency" }, "priority" : { "description" : "Priority", "$ref" : "#/definitions/PriorityConstants" }, "customer" : { "description" : "Customer", "$ref" : "#/definitions/GenericCustomer" }, "period" : { "description" : "The activity period of a product", "$ref" : "#/definitions/TimePeriod" }, "discountable" : { "type" : "boolean", "description" : "Indicates if price discountable is possible" }, "logId" : { "type" : "integer", "format" : "int64", "description" : "Id of the created log" }, "refund" : { "type" : "integer", "format" : "int32", "description" : "Refund" }, "priceConditions" : { "type" : "array", "description" : "Price condition", "items" : { "$ref" : "#/definitions/PriceServiceEntity" } }, "comment" : { "type" : "string", "description" : "Comments" }, "taskComment" : { "type" : "string", "description" : "TaskComment" }, "priceList" : { "description" : "The related priceList label", "$ref" : "#/definitions/PriceList" }, "from" : { "type" : "string", "format" : "date-time", "description" : "from" }, "until" : { "type" : "string", "format" : "date-time", "description" : "until" }, "normalPrice" : { "description" : "Normal price", "$ref" : "#/definitions/ExchangedPrice" }, "newPrice" : { "description" : "new price", "$ref" : "#/definitions/ExchangedPrice" }, "valid" : { "type" : "string", "format" : "date-time", "description" : "Date until the price is valid" }, "priceChange" : { "description" : "The price change", "$ref" : "#/definitions/PriceChange" }, "vatRate" : { "type" : "number", "format" : "double", "description" : "The vat rate of the price" }, "vatAmount" : { "type" : "number", "format" : "double", "description" : "The calculated vat amount" }, "rate" : { "type" : "number", "format" : "double", "description" : "The exchange rate between account and price" }, "exchangeFee" : { "type" : "number", "format" : "float", "description" : "The exchange fee if the price currency does not match the billing currency" } } }, "ExecutionTypeConstants" : { "type" : "string", "enum" : [ "DATE", "EXPIRE", "NOW" ] }, "ExtendedValidationExtension" : { "type" : "object", "properties" : { "joiCountryName" : { "type" : "string", "description" : "Country of judicial formation." }, "joiLocality" : { "type" : "string", "description" : "Locality or city of judicial formation." }, "joiStateOrProvince" : { "type" : "string", "description" : "State or province of judicial formation." }, "companyNumber" : { "type" : "string", "description" : "The company number." }, "businessCategory" : { "description" : "Type of business.", "$ref" : "#/definitions/BusinessCategory" } } }, "ExternalAccounting" : { "type" : "object", "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "owner" : { "description" : "The object owner.", "$ref" : "#/definitions/User" }, "updater" : { "description" : "User who performed the last update.", "$ref" : "#/definitions/User" }, "provider" : { "description" : "The provider of the external_accounting", "$ref" : "#/definitions/ProviderEntity" }, "label" : { "type" : "string", "description" : "The label to identify the provider" }, "reportTo" : { "type" : "string", "description" : "The email address for reporting" }, "priceType" : { "description" : "The price type", "$ref" : "#/definitions/PriceTypeConstants" }, "priceMarkupType" : { "description" : "The type of markup", "$ref" : "#/definitions/PriceMarkupType" }, "priceMarkup" : { "type" : "number", "format" : "double", "description" : "markup value in percent or absolute", "minimum" : 0, "maximum" : 10000 }, "priceRounding" : { "description" : "The type of rounding", "$ref" : "#/definitions/PriceRoundingConstants" }, "enablePromoPrice" : { "type" : "boolean", "description" : "Enables promo prices syncronization" }, "currency" : { "type" : "string", "example" : "EUR", "description" : "Used currency ", "x-custom-type" : "currency" }, "country" : { "type" : "string", "example" : "DE", "description" : "Used country. Needed for calculation of taxes" }, "creditorIdentifier" : { "type" : "string", "description" : "The creditor identifier" }, "customerNumberMin" : { "type" : "integer", "format" : "int64", "description" : "The lower end of the generated customer group numbers" }, "customerNumberMax" : { "type" : "integer", "format" : "int64", "description" : "The upper end of the generated customer group numbers" }, "creditLimit" : { "type" : "number", "format" : "double", "description" : "The creditLimit for the customer of the accounting" }, "priceListSyncStatus" : { "description" : "The status of the pricelist sync", "$ref" : "#/definitions/GenericStatusConstants" }, "priceListSync" : { "type" : "string", "format" : "date-time", "description" : "The date when the last pricelist sync finished" } } }, "ExternalCustomer" : { "type" : "object", "required" : [ "client", "number" ], "properties" : { "number" : { "type" : "integer", "format" : "int64", "description" : "Customer number" }, "client" : { "type" : "string", "description" : "Account Label.", "minLength" : 1, "maxLength" : 2147483647 }, "group" : { "type" : "integer", "format" : "int64", "example" : 13516, "description" : "Customer group, first 5 numbers of the account number. e.g. " }, "billing" : { "description" : "The billing user.", "$ref" : "#/definitions/User" }, "externalReference" : { "type" : "string", "description" : "The external reference gives a hint on the creation or use case of the external customer." }, "creditLimit" : { "type" : "number", "format" : "double", "description" : "The credit limit the external customer." }, "created" : { "type" : "string", "format" : "date-time", "description" : "The created date." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "The updated date." }, "priceLists" : { "type" : "array", "items" : { "$ref" : "#/definitions/PriceListEntity" } }, "customer" : { "description" : "The customer data.", "$ref" : "#/definitions/BasicCustomer" } } }, "GenderConstants" : { "type" : "string", "enum" : [ "MALE", "FEMALE" ] }, "GenericCustomer" : { "type" : "object", "required" : [ "client", "number" ], "properties" : { "number" : { "type" : "integer", "format" : "int64", "description" : "Customer number" }, "client" : { "type" : "string", "description" : "Account Label.", "minLength" : 1, "maxLength" : 2147483647 }, "group" : { "type" : "integer", "format" : "int64", "example" : 13516, "description" : "Customer group, first 5 numbers of the account number. e.g. " } } }, "GenericLabelEntity" : { "type" : "object", "required" : [ "label" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "label" : { "type" : "string", "description" : "The unique identifier" } } }, "GenericObject" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "Object type.\n\nPossible values:\n\ndomain\nhandle\nzone\ndomainzone (domain and zone)\ndomain_prereg (preregistration)\nserver_redirect (redirect)\nbackup_mx\ntmch_mark" }, "value" : { "type" : "string", "description" : "The value contained in the object." } } }, "GenericStatusConstants" : { "type" : "string", "enum" : [ "PENDING", "SUCCESS", "FAILED", "NOT_SET" ] }, "GlobalSignPickupMethod" : { "type" : "string", "enum" : [ "EDGE_IE_COMPATIBILITY_MODE", "FORTIFY" ] }, "HkDocumentTypeConstants" : { "type" : "string", "enum" : [ "HKID", "OTHID", "PASSNO", "BIRTHCERT", "OTHIDV", "BR", "CI", "CRS", "HKSARG", "HKORDINANCE", "OTHORG" ] }, "HkIndustryTypeConstants" : { "type" : "string", "enum" : [ "_0", "_010100", "_010200", "_010300", "_010400", "_010500", "_020100", "_020200", "_020300", "_020400", "_020500", "_030100", "_030200", "_040100", "_040200", "_040300", "_040400", "_040500", "_040600", "_040700", "_050100", "_050200", "_050300", "_050400", "_050500", "_050600", "_050700", "_060100", "_060200", "_060300", "_070100", "_070200", "_070300", "_070400", "_070500", "_070600", "_070700", "_070800", "_070900", "_080100", "_080200", "_080300", "_080400", "_080500", "_080600", "_080700", "_080800", "_080900", "_081000", "_081100", "_090100", "_090200", "_090300", "_090400", "_090500", "_100100", "_100200", "_100300", "_100400", "_100500", "_110100", "_110200", "_110300", "_110400", "_110500", "_110600", "_120100", "_120200", "_120300", "_120400", "_120500", "_120600", "_120700", "_120800", "_120900", "_130100", "_130200", "_130300", "_130400", "_130500", "_130600", "_130700", "_130800", "_140101", "_140102", "_140103", "_140200", "_140300", "_140400", "_140500", "_140600", "_140700" ] }, "HostSubZone" : { "type" : "object", "properties" : { "origin" : { "type" : "string", "description" : "Zone name" }, "virtualNameServer" : { "type" : "string", "description" : "The first nameserver managed by the system" } } }, "InetAddress" : { "type" : "object" }, "Invoice" : { "type" : "object", "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "owner" : { "description" : "The object owner.", "$ref" : "#/definitions/User" }, "updater" : { "description" : "User who performed the last update.", "$ref" : "#/definitions/User" }, "id" : { "type" : "integer", "format" : "int64", "description" : "internal id" }, "number" : { "type" : "string", "description" : "invoice number" }, "customer" : { "description" : "Customer", "$ref" : "#/definitions/GenericCustomer" }, "payment" : { "description" : "The method of payment: PRE, POST, etc.", "$ref" : "#/definitions/PaymentConstants" }, "paymentMode" : { "type" : "string", "description" : "Additional payment data, such as provider: ipayment" }, "paymentTransaction" : { "type" : "string", "description" : "The payment transaction number" }, "subType" : { "type" : "string", "description" : "The sub type of the invoice, e.g. domain invoice or server invoice" }, "sepaMandateReference" : { "type" : "string", "description" : "SEPA Mandate Reference" }, "sepaMandateCollection" : { "type" : "string", "format" : "date-time", "description" : "Date of SEPA collection" }, "amount" : { "type" : "number", "format" : "double", "description" : "Invoice amount" }, "vatAmount" : { "type" : "number", "format" : "double", "description" : "Vat amount" }, "status" : { "description" : "Invoice status", "$ref" : "#/definitions/InvoiceStatusConstants" }, "type" : { "description" : "Type of invoice", "$ref" : "#/definitions/AccountingDocumentTypeConstants" }, "failed" : { "type" : "boolean", "description" : "Indicator that shows that something is wrong with the process" }, "currency" : { "type" : "string", "example" : "EUR", "description" : "Used currency of the amount", "x-custom-type" : "currency" }, "paid" : { "type" : "string", "format" : "date-time", "description" : "Date of payment" }, "document" : { "description" : "The linked pdf", "$ref" : "#/definitions/Document" }, "comment" : { "type" : "string", "description" : "Comment to the invoice" }, "extension" : { "description" : "Additional information", "$ref" : "#/definitions/Configuration" }, "messages" : { "type" : "array", "items" : { "type" : "string" } } } }, "InvoiceStatusConstants" : { "type" : "string", "enum" : [ "CREATED", "SIGNED", "SENT", "RESEND", "FINISHED", "LIVECONFIRMED", "LIVEPENDING", "POSTPENDING", "POSTCONFIRMED" ] }, "IpRestriction" : { "type" : "object", "required" : [ "address", "type" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "type" : { "description" : "The restriction level", "$ref" : "#/definitions/IpRestrictionTypeConstants" }, "address" : { "type" : "string", "example" : "192.33.1.4/24", "description" : "A net address or ip address" } } }, "IpRestrictionTypeConstants" : { "type" : "string", "enum" : [ "CLONE", "USER", "CONTEXT" ] }, "IpRestrictions" : { "type" : "object", "properties" : { "acls" : { "type" : "array", "description" : "A list of ip restrictions", "items" : { "$ref" : "#/definitions/IpRestriction" }, "maxItems" : 30, "minItems" : 0 } } }, "ItEntityTypeConstants" : { "type" : "string", "enum" : [ "ITALIAN_AND_FOREIGN_NATURAL_PERSONS", "ITALIAN_COMPANIES_ONE_MAN_COMPANIES", "ITALIAN_FREELANCE_WORKERS_PROFESSIONALS", "ITALIAN_NON_PROFIT_ORGANIZATIONS", "ITALIAN_PUBLIC_ORGANIZATIONS", "ITALIAN_OTHER_SUBJECTS", "FOREIGN_NON_NATURAL_PERSONS" ] }, "Job" : { "type" : "object", "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "owner" : { "description" : "The object owner.", "$ref" : "#/definitions/User" }, "updater" : { "description" : "User who performed the last update.", "$ref" : "#/definitions/User" }, "status" : { "description" : "Defines the status of a job.", "$ref" : "#/definitions/JobStatusConstants" }, "subStatus" : { "type" : "string", "description" : "Substatus of the job. Substatuses exist depending on the job." }, "execution" : { "type" : "string", "format" : "date-time", "description" : "The date on which the job will be processed by the system." }, "events" : { "type" : "array", "description" : "The workflow events generated by the job.", "items" : { "$ref" : "#/definitions/WorkflowEvent" } }, "subType" : { "type" : "string", "example" : "GLOBALSIGN_PERSONALSIGN_2, COMODO_SSL, COMODO_SSL_PREMIUM, SECURESITEPRO", "description" : "The job subtype. " }, "action" : { "type" : "string", "example" : "drop, create, transfer, renew, ownerchange, delete", "description" : "The action, which the job is supposed to do." }, "id" : { "type" : "integer", "format" : "int64", "description" : "The job id." } } }, "JobStatusConstants" : { "type" : "string", "enum" : [ "RUNNING", "SUCCESS", "FAILED", "CANCELED", "SUPPORT", "DEFERRED", "NOT_SET", "WAIT" ] }, "JsonNoData" : { "type" : "object" }, "JsonResponseData" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "type" : "object" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataAccount" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/Account" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataAuthSession" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/AuthSession" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataAutoDeleteDomain" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/AutoDeleteDomain" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataBackupMx" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/BackupMx" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataBillingEvent" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/BillingEvent" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataBillingLimit" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/BillingLimit" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataBillingObjectTerms" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/BillingObjectTerms" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataCertificate" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/Certificate" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataCertificateData" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/CertificateData" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataCertificateInstallCheckResult" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/CertificateInstallCheckResult" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataContact" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/Contact" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataContactDocument" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/ContactDocument" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataContactVerification" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/ContactVerification" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataContextHost" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/ContextHost" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataCustomerPriceList" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/CustomerPriceList" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataDomain" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/Domain" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataDomainCancelation" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/DomainCancelation" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataDomainEnvelope" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/DomainEnvelope" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataDomainPremium" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/DomainPremium" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataDomainPrereg" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/DomainPrereg" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataDomainRestore" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/DomainRestore" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataDomainSafeAccount" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/DomainSafeAccount" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataDomainSafeObject" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/DomainSafeObject" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataDomainSafeUser" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/DomainSafeUser" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataExternalCustomer" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/ExternalCustomer" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataInvoice" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/Invoice" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataJob" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/Job" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataJsonNoData" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/JsonNoData" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataListJsonResponseDataBackupMx" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "type" : "array", "items" : { "$ref" : "#/definitions/JsonResponseDataBackupMx" } } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataListJsonResponseDataBillingEvent" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "type" : "array", "items" : { "$ref" : "#/definitions/JsonResponseDataBillingEvent" } } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataListJsonResponseDataCertificate" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "type" : "array", "items" : { "$ref" : "#/definitions/JsonResponseDataCertificate" } } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataListJsonResponseDataContact" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "type" : "array", "items" : { "$ref" : "#/definitions/JsonResponseDataContact" } } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataListJsonResponseDataCustomerPriceList" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "type" : "array", "items" : { "$ref" : "#/definitions/JsonResponseDataCustomerPriceList" } } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataListJsonResponseDataDomain" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "type" : "array", "items" : { "$ref" : "#/definitions/JsonResponseDataDomain" } } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataListJsonResponseDataDomainCancelation" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "type" : "array", "items" : { "$ref" : "#/definitions/JsonResponseDataDomainCancelation" } } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataListJsonResponseDataDomainPrereg" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "type" : "array", "items" : { "$ref" : "#/definitions/JsonResponseDataDomainPrereg" } } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataListJsonResponseDataExternalCustomer" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "type" : "array", "items" : { "$ref" : "#/definitions/JsonResponseDataExternalCustomer" } } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataListJsonResponseDataMailProxy" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "type" : "array", "items" : { "$ref" : "#/definitions/JsonResponseDataMailProxy" } } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataListJsonResponseDataObjectUserAssignment" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "type" : "array", "items" : { "$ref" : "#/definitions/JsonResponseDataObjectUserAssignment" } } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataListJsonResponseDataPrice" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "type" : "array", "items" : { "$ref" : "#/definitions/JsonResponseDataPrice" } } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataListJsonResponseDataRedirect" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "type" : "array", "items" : { "$ref" : "#/definitions/JsonResponseDataRedirect" } } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataListJsonResponseDataSslContact" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "type" : "array", "items" : { "$ref" : "#/definitions/JsonResponseDataSslContact" } } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataListJsonResponseDataZone" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "type" : "array", "items" : { "$ref" : "#/definitions/JsonResponseDataZone" } } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataMailProxy" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/MailProxy" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataMailServiceMessage" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/MailServiceMessage" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataOTPAuth" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/OTPAuth" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataObjectJob" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/ObjectJob" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataObjectUserAssignment" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/ObjectUserAssignment" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataPeriodicBilling" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/PeriodicBilling" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataPollMessage" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/PollMessage" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataPrice" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/Price" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataRedirect" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/Redirect" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataServiceUsersProfile" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/ServiceUsersProfile" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataSiteSealInformation" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/SiteSealInformation" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataSslContact" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/SslContact" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataString" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "type" : "string" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataSubjectProduct" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/SubjectProduct" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataTaskUserLimit" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/TaskUserLimit" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataTldProduct" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/TldProduct" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataTldStatistic" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/TldStatistic" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataTmchClaimsNotice" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/TmchClaimsNotice" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataTmchMark" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/TmchMark" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataTmchMarkDocument" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/TmchMarkDocument" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataTransfer" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/Transfer" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataTransferOut" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/TransferOut" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataUser" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/User" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataUserProfileViews" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/UserProfileViews" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataUserSalesReport" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/UserSalesReport" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataVmcCheckData" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/VmcCheckData" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataVoid" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/Void" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataZone" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/Zone" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "JsonResponseDataZoneQuery" : { "type" : "object", "properties" : { "stid" : { "type" : "string", "description" : "The server transaction ID for the response." }, "messages" : { "type" : "array", "description" : "The messages belonging to the response.", "items" : { "$ref" : "#/definitions/Message" } }, "status" : { "description" : "The status of the response.", "$ref" : "#/definitions/ResponseStatus" }, "object" : { "description" : "The response object.", "$ref" : "#/definitions/ResponseObject" }, "data" : { "type" : "array", "description" : "The data for the response. The type of the objects are depending on the request and are also specified in the ResponseObject value of the response.", "items" : { "$ref" : "#/definitions/ZoneQuery" } }, "ctid" : { "type" : "string", "description" : "The CTID (Client Transaction ID) of the response." } } }, "LoginData" : { "type" : "object", "required" : [ "context", "user" ], "properties" : { "context" : { "type" : "integer", "format" : "int32", "description" : "The context. A separated section." }, "password" : { "type" : "string", "description" : "The password." }, "passwordChanged" : { "type" : "string", "format" : "date-time", "description" : "The date on which the password has changed" }, "passwordExpired" : { "type" : "boolean", "description" : "The passwordExpired boolean" }, "token" : { "type" : "string", "description" : "The one time password in case of 2fa authentication." }, "user" : { "type" : "string", "description" : "The user name.", "pattern" : "^[^_].*" } } }, "MailList" : { "type" : "object", "properties" : { "emails" : { "type" : "array", "description" : "A list of email addresses", "items" : { "type" : "string" } } } }, "MailProxy" : { "type" : "object", "required" : [ "domain", "target" ], "properties" : { "domain" : { "type" : "string", "description" : "Domain name for which the BackupMX Record is to be created." }, "idn" : { "type" : "string", "description" : "IDN version of the domain name written in Punycode." }, "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "owner" : { "description" : "The object owner.", "$ref" : "#/definitions/User" }, "updater" : { "description" : "User who performed the last update.", "$ref" : "#/definitions/User" }, "target" : { "type" : "string", "description" : "Mail server to which the MailProxy should forward the emails.\nNote that the MX record of your mail server must be removed from the zone." }, "admin" : { "type" : "string", "description" : "Email address of the administrator to whom notifications are sent to." }, "protection" : { "description" : "Security settings for handling infected mails.", "$ref" : "#/definitions/ProtectionConstants" }, "greylisting" : { "type" : "string", "description" : "If greylisting is activated, the first email from an unknown sender is rejected at first. Mails from this sender will only be accepted after a further delayed delivery attempt.", "enum" : [ "ENABLED", "DISABLED" ] }, "virus" : { "type" : "string", "description" : "Defines whether to check for viruses and how to deal with detected viruses.", "enum" : [ "DISABLED", "QUARANTINE", "DISCARD", "ACCEPT" ] }, "bannedFiles" : { "type" : "string", "description" : "Defines whether files should be checked and how banned files should be avoided.", "enum" : [ "DISABLED", "QUARANTINE", "DISCARD", "ACCEPT" ] }, "header" : { "type" : "string", "description" : "Defines whether headers are to be checked and how banned headers are to be handled.", "enum" : [ "DISABLED", "QUARANTINE", "DISCARD", "ACCEPT" ] }, "spam" : { "description" : "The spam policy options.", "$ref" : "#/definitions/SpamPolicy" }, "whitelist" : { "description" : "Define email addresses whose mails should be trusted and never marked as spam.", "$ref" : "#/definitions/MailList" }, "blacklist" : { "description" : "Specification of email addresses whose mails are always to be marked as spam.", "$ref" : "#/definitions/MailList" }, "excludelist" : { "description" : "Definition of administrative addresses that should never be ignored by spam filters. An example of this is the \"Hostmaster\" addresses, e.g. hostmaster@example.com.", "$ref" : "#/definitions/MailList" } } }, "MailServiceMessage" : { "type" : "object", "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "id" : { "type" : "integer", "format" : "int64", "description" : "the id of the message entry" }, "reference" : { "type" : "string", "description" : "The message id of the email" }, "from" : { "type" : "string", "description" : "The mail from header", "x-custom-type" : "email" }, "subject" : { "type" : "string", "description" : "the subject of the email" }, "status" : { "description" : "the actual delivery status of the email", "$ref" : "#/definitions/DeliveryStatus" }, "recipients" : { "type" : "array", "description" : "the recipients of the email", "items" : { "$ref" : "#/definitions/Recipient" } }, "externalReference" : { "type" : "string", "description" : "The external reference of the email" } } }, "MainIp" : { "type" : "object", "properties" : { "address" : { "type" : "string", "example" : "127.0.0.1", "description" : "IP address used for the A-record of the zone's e-mail." }, "ttl" : { "type" : "integer", "format" : "int64", "example" : 86000, "description" : "Time to Live (TTL) Validity period for the IP address of the zone." } } }, "Message" : { "type" : "object", "properties" : { "text" : { "type" : "string", "description" : "Message text." }, "notice" : { "type" : "string", "description" : "Additional notice if available" }, "messages" : { "type" : "array", "description" : "Referred child messages.", "items" : { "$ref" : "#/definitions/Message" } }, "objects" : { "type" : "array", "description" : "The object to which the notification refers.\ntype - specifies the type of the object\nvalue - value of the object", "items" : { "$ref" : "#/definitions/GenericObject" } }, "code" : { "type" : "string", "description" : "The task code of the order to which the notification belongs to." }, "status" : { "example" : "ERROR", "description" : "The status type of the response.", "$ref" : "#/definitions/StatusType" } } }, "MessageTypeConstants" : { "type" : "string", "enum" : [ "INITIAL", "FIRST_REMINDER", "SECOND_REMINDER", "LAST_REMINDER" ] }, "Metric" : { "type" : "object", "properties" : { "length" : { "type" : "integer", "format" : "int32", "description" : "The lenght of the sld" } } }, "Modifier" : { "type" : "object", "required" : [ "type" ], "properties" : { "search" : { "type" : "string", "description" : "The search pattern" }, "replace" : { "type" : "string", "description" : "The replacement value" }, "type" : { "description" : "The modifiers type, e.g. NAME_SERVER", "$ref" : "#/definitions/ModifierConstants" } } }, "ModifierConstants" : { "type" : "string", "enum" : [ "TTL", "MX", "A", "AAAA", "SOA_EMAIL", "NSERVER", "CNAME", "TXT", "ALL", "MAIN_IP", "OWNERC", "ADMINC", "TECHC", "ZONEC", "BILLINGC", "ALIAS" ] }, "Name" : { "type" : "object" }, "NameServer" : { "type" : "object", "required" : [ "name" ], "properties" : { "name" : { "type" : "string", "description" : "Host name of the nameserver written as a Fully-Qualified-Domain-Name (FQDN)." }, "ttl" : { "type" : "integer", "format" : "int64", "description" : "Time-to-live value of the nameservers in seconds" }, "ipAddresses" : { "type" : "array", "description" : "IPv4 and IPv6 addresses of the name server. For GLUE records only; \noptional. The values for the IP addresses are only relevant for domain operations and are only used there in the case of glue name servers.", "items" : { "type" : "string" } } } }, "NameServerMode" : { "type" : "string", "enum" : [ "MASTER", "SLAVE", "MASTER_SLAVE", "COMPLETE", "ANYCAST" ] }, "NameserverActionConstants" : { "type" : "string", "enum" : [ "PRIMARY", "SECONDARY", "COMPLETE", "HIDDEN", "NONE", "AUTO" ] }, "NewPassword" : { "type" : "object", "properties" : { "user" : { "type" : "string", "example" : "hello@world.com", "description" : "The user" }, "context" : { "type" : "integer", "format" : "int32", "example" : 4, "description" : "The context of the user" }, "tan" : { "type" : "string", "example" : "123456", "description" : "The tan" }, "password" : { "type" : "string", "example" : "wd23os", "description" : "The password" }, "email" : { "type" : "string", "description" : "The disguised email to which the TAN is to be sent." }, "mobile" : { "type" : "string", "description" : "The disguised mobilephone number to which the TAN is to be sent." }, "tanMethods" : { "type" : "array", "example" : "METHOD_EMAIL, METHOD_MOBILE, METHOD_2FA", "description" : "The tan methods available for the user", "items" : { "type" : "string" } }, "token" : { "type" : "string", "description" : "The token" }, "method" : { "type" : "string", "description" : "The selected method" } } }, "NicMember" : { "type" : "object", "properties" : { "label" : { "type" : "string", "description" : "The label" }, "name" : { "type" : "string", "description" : "The name" } } }, "NiccomLog" : { "type" : "object", "required" : [ "created", "name", "source", "task", "text" ], "properties" : { "jobId" : { "type" : "integer", "format" : "int64", "description" : "The jobId of the niccom log." }, "vertexId" : { "type" : "integer", "format" : "int32", "description" : "The vertexId of the niccom log." }, "name" : { "type" : "string", "description" : "The name of the niccom log." }, "task" : { "type" : "string", "description" : "The task of the niccom log." }, "nicTransactionId" : { "type" : "string", "description" : "The nicTransactionId of the niccom log." }, "source" : { "description" : "The source of the niccom log.", "$ref" : "#/definitions/NiccomSourceConstants" }, "text" : { "type" : "string", "description" : "The text of the niccom log." }, "created" : { "type" : "string", "format" : "date-time", "description" : "The created date of the niccom log." } } }, "NiccomSourceConstants" : { "type" : "string", "enum" : [ "NIC_REQUEST", "NIC_RESPONSE", "NIC_NOTIFY", "A3_REQUEST", "A3_RESPONSE", "LOG_OBJECTS" ] }, "Notification" : { "type" : "object", "properties" : { "messages" : { "type" : "array", "description" : "Notification Message", "items" : { "$ref" : "#/definitions/Message" } } } }, "NotifyMessage" : { "type" : "object", "properties" : { "type" : { "type" : "string", "example" : "domain_away", "description" : "Type of connected operation." }, "object" : { "example" : "domain", "description" : "The ResponseObject object contains information about the object. The object is dependent on the order.", "$ref" : "#/definitions/ResponseObject" } } }, "OTPAuth" : { "type" : "object", "required" : [ "algorithm", "digits", "protocolType", "timeout" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "owner" : { "description" : "The object owner.", "$ref" : "#/definitions/User" }, "updater" : { "description" : "User who performed the last update.", "$ref" : "#/definitions/User" }, "protocolType" : { "description" : "The type of protocol", "$ref" : "#/definitions/ProtocolTypeConstants" }, "algorithm" : { "description" : "Crypto algorithm", "$ref" : "#/definitions/CryptoFormatConstants" }, "timeout" : { "type" : "integer", "format" : "int32", "description" : "Timeout in seconds", "minimum" : 5, "maximum" : 90 }, "digits" : { "type" : "integer", "format" : "int32", "description" : "The length of the token", "minimum" : 6, "maximum" : 8 }, "secret" : { "type" : "string", "description" : "Base32 encoded shared secret." }, "tokens" : { "type" : "array", "description" : "The generated support 'tokens'.", "uniqueItems" : true, "items" : { "type" : "string" } }, "qrCode" : { "description" : "The generated qr code png.", "$ref" : "#/definitions/BasicDocument" } } }, "ObjectAssignmentMode" : { "type" : "string", "enum" : [ "ASSIGN", "DELETE" ] }, "ObjectJob" : { "type" : "object", "properties" : { "job" : { "description" : "The related job.", "$ref" : "#/definitions/Job" }, "object" : { "description" : "The object of the job or notify.", "$ref" : "#/definitions/ResponseObject" }, "niccomLogs" : { "type" : "array", "description" : "The niccom logs.", "items" : { "$ref" : "#/definitions/NiccomLog" } }, "authentication" : { "type" : "array", "description" : "The overall authentication status for a certificate request.", "items" : { "$ref" : "#/definitions/CertAuthenticationStatus" } }, "dcvAuth" : { "type" : "array", "description" : "The domain controll validation status for each domain.", "items" : { "$ref" : "#/definitions/DomainControllValidationStatus" } }, "notices" : { "type" : "array", "description" : "Additional notices of the order", "items" : { "type" : "string" } } } }, "ObjectStatus" : { "type" : "string", "enum" : [ "SPOOL", "REQUEST", "PENDING_NOTIFY", "PENDING", "FAILED", "SUCCESS", "PENDING_DOMAIN", "CONNECT" ] }, "ObjectUserAssignment" : { "type" : "object", "required" : [ "name", "owner", "type" ], "properties" : { "type" : { "type" : "string", "description" : "Type of object, e.g. domain." }, "owner" : { "description" : "The object owner.", "$ref" : "#/definitions/User" }, "name" : { "type" : "string", "description" : "Name of the object to be reassigned.", "minLength" : 1, "maxLength" : 2147483647 }, "cancelation" : { "description" : "Mode when assigning domains with an active cancelation.", "$ref" : "#/definitions/ObjectAssignmentMode" }, "source" : { "description" : "The user that currently has the object", "$ref" : "#/definitions/User" }, "target" : { "description" : "The user that should receive the object", "$ref" : "#/definitions/User" } } }, "Operator" : { "type" : "string", "enum" : [ "EQUAL", "NOT_EQUAL", "NOT_LIKE", "LIKE", "ILIKE", "GREATER", "GREATER_EQUAL", "LESS", "LESS_EQUAL", "IS_NULL", "IS_NOT_NULL", "NOT_LESS", "NOT_GREATER", "NOT_LESS_EQUAL", "NOT_GREATER_EQUAL", "IN", "NOT_IN" ] }, "Order" : { "type" : "object", "properties" : { "key" : { "type" : "string", "description" : "Keyword to be sorted by." }, "ins" : { "type" : "array", "items" : { "type" : "string" } }, "type" : { "example" : "ASC (Ascending)\n DESC (Descending)", "description" : "Sort order. Default = ASC", "$ref" : "#/definitions/OrderType" } } }, "OrderType" : { "type" : "string", "enum" : [ "DESC", "ASC" ] }, "ParkingProviderConstants" : { "type" : "string", "enum" : [ "SEDO", "NAMEDRIVE", "PARKINGCREW" ] }, "PaymentConstants" : { "type" : "string", "enum" : [ "PRE", "POST", "LIVE" ] }, "PeriodicBilling" : { "type" : "object", "required" : [ "payable" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "id" : { "type" : "integer", "format" : "int32", "example" : 1, "description" : "The unique identifier of the periodic" }, "owner" : { "description" : "The object owner.", "$ref" : "#/definitions/User" }, "updater" : { "description" : "User who performed the last update.", "$ref" : "#/definitions/User" }, "status" : { "description" : "Billing status of the subscription.", "$ref" : "#/definitions/BillingStatus" }, "object" : { "type" : "string", "description" : "Name of the subscription or the contract number." }, "description" : { "type" : "string", "description" : "The human readable name of the subscription, e.g. the name of a package" }, "period" : { "description" : "The period used by the subscription, e.g. 1 month", "$ref" : "#/definitions/TimePeriod" }, "articleTypeLabel" : { "type" : "string", "description" : "The article type label of the subscription, e.g. domain" }, "payable" : { "type" : "string", "format" : "date-time", "description" : "The date then the event should be billed." }, "articleLabel" : { "type" : "string", "description" : "The article label of the subscription, e.g. backup_mx" }, "item" : { "type" : "array", "description" : "The items of the subscription", "items" : { "$ref" : "#/definitions/PeriodicBilling" } }, "expire" : { "type" : "string", "format" : "date-time", "description" : "The expiration date of the subscription." }, "cancelationTerm" : { "description" : "cancelationTerm of the subscription..", "$ref" : "#/definitions/TimePeriod" }, "cancelation" : { "type" : "string", "format" : "date-time", "description" : "The cancelation date of the subscription." }, "canceled" : { "type" : "string", "format" : "date-time", "description" : "The canceled date." }, "businessCase" : { "type" : "string", "description" : "The businessCase of the subscription, e.g. create" }, "extensions" : { "description" : "Additional information, such as rights and limits.", "$ref" : "#/definitions/BillingEventExtensions" } } }, "Phone" : { "type" : "object" }, "PhysicalNameServerGroup" : { "type" : "object", "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "name" : { "type" : "string", "description" : "Custom name of the name server group." }, "articleLabel" : { "type" : "string", "description" : "The article name that will be used when creating zones for this group." }, "supported" : { "description" : "If the group supported", "$ref" : "#/definitions/NameServerMode" }, "dnssec" : { "type" : "boolean", "description" : "Support for DNSSEC by the namserver group.\nPossible values:\nfalse = DNSSEC is not supported\ntrue = DNSSEC is supported\nDefault value = false" }, "statistic" : { "type" : "boolean", "description" : "Support of zone statistics by the namserver group.\nPossible values:\nfalse = Statistics are not supported\ntrue = Statistics are supported\nDefault value = false" } } }, "PolicyMode" : { "type" : "string", "enum" : [ "DISABLED", "QUARANTINE", "DISCARD", "ACCEPT" ] }, "PollMessage" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int64", "description" : "Message ID. Required for confirming with Poll Confirm." }, "owner" : { "description" : "The object owner.", "$ref" : "#/definitions/User" }, "job" : { "description" : "The job data. Available if the message is a job message", "$ref" : "#/definitions/Job" }, "notify" : { "description" : "The notification data. Available if the message is a notification message", "$ref" : "#/definitions/NotifyMessage" }, "stid" : { "type" : "string", "description" : "The server transaction ID." }, "ctid" : { "type" : "string", "description" : "The custom transaction ID." }, "messages" : { "type" : "array", "description" : "System messages.", "items" : { "$ref" : "#/definitions/Message" } }, "flags" : { "type" : "string", "description" : "Optional message flags." }, "notice" : { "type" : "string", "description" : "Optional notice." }, "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "object" : { "description" : "\"Response\" object like \"domain\". Object type depends on the request.", "$ref" : "#/definitions/ResponseObject" } } }, "PremiumStatusConstants" : { "type" : "string", "enum" : [ "ASSIGNED", "FREE", "INACTIVE", "EAP", "SYNC_ERROR", "OFFERED", "ON_HOLD" ] }, "PreregConfig" : { "type" : "object", "required" : [ "name" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "name" : { "type" : "string", "description" : "Name of the TLD and/or SubTLD." }, "phase" : { "type" : "string", "description" : "Name of the phase" }, "confirmationStart" : { "type" : "string", "format" : "date-time", "description" : "Date on which preregistrations for the specified TLD can be confirmed." }, "confirmationEnd" : { "type" : "string", "format" : "date-time", "description" : "Date on which preregistrations for the specified TLD can no longer be confirmed." }, "periodStart" : { "type" : "string", "format" : "date-time" }, "periodEnd" : { "type" : "string", "format" : "date-time", "description" : "Date on which the preregistration period begins" }, "nicMemberLabel" : { "type" : "string", "description" : "Registrar identifier at the registries." }, "niccomStart" : { "type" : "string", "format" : "date-time", "description" : "Date on which the preregistrations for the specified TLD are processed." }, "niccomEnd" : { "type" : "string", "format" : "date-time", "description" : "Date on which preregistrations for the specified TLD will no longer be processed." }, "autoupdateDns" : { "type" : "boolean", "description" : "Domain status update after registration.\nfalse = Domain will not be updated after registration\ntrue = Domain will be updated after registration\nDefault value = false" }, "category" : { "type" : "string", "description" : "TLD category\nexample:\n\nBusiness\nTravel\nGeneric" }, "uiFields" : { "type" : "string", "description" : "Comma-separated list for fields to be displayed in the frontend UI." }, "registrationType" : { "description" : "Which type of registration has been used, FCFS, APPLICATION or OTHER.", "$ref" : "#/definitions/RegistrationTypeConstants" }, "messageType" : { "description" : "Type of notification in the course of the preregistration process.", "$ref" : "#/definitions/MessageTypeConstants" }, "minPeriod" : { "description" : "Default minimum registration term for a domain.", "$ref" : "#/definitions/TimePeriod" } } }, "PreregInformation" : { "type" : "object", "properties" : { "phase" : { "type" : "string" }, "confirmationStart" : { "type" : "string", "format" : "date-time" }, "confirmationEnd" : { "type" : "string", "format" : "date-time" }, "periodStart" : { "type" : "string", "format" : "date-time" }, "periodEnd" : { "type" : "string", "format" : "date-time" }, "category" : { "type" : "string" }, "registrationType" : { "type" : "string" }, "minPeriod" : { "$ref" : "#/definitions/TimePeriod" } } }, "Price" : { "type" : "object", "required" : [ "amount", "currency", "product" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "id" : { "type" : "integer", "format" : "int32", "example" : 1, "description" : "The unique identifier of the price" }, "owner" : { "description" : "The object owner.", "$ref" : "#/definitions/User" }, "updater" : { "description" : "User who performed the last update.", "$ref" : "#/definitions/User" }, "amount" : { "type" : "number", "format" : "double", "description" : "Amount" }, "type" : { "description" : "The price type", "$ref" : "#/definitions/PriceTypeConstants" }, "currency" : { "type" : "string", "example" : "EUR", "description" : "Used currency ", "x-custom-type" : "currency" }, "priority" : { "description" : "Priority", "$ref" : "#/definitions/PriorityConstants" }, "customer" : { "description" : "Customer", "$ref" : "#/definitions/GenericCustomer" }, "period" : { "description" : "The activity period of a product", "$ref" : "#/definitions/TimePeriod" }, "discountable" : { "type" : "boolean", "description" : "Indicates if price discountable is possible" }, "logId" : { "type" : "integer", "format" : "int64", "description" : "Id of the created log" }, "refund" : { "type" : "integer", "format" : "int32", "description" : "Refund" }, "priceConditions" : { "type" : "array", "description" : "Price condition", "items" : { "$ref" : "#/definitions/PriceServiceEntity" } }, "comment" : { "type" : "string", "description" : "Comments" }, "taskComment" : { "type" : "string", "description" : "TaskComment" }, "priceList" : { "description" : "The related priceList label", "$ref" : "#/definitions/PriceList" }, "from" : { "type" : "string", "format" : "date-time", "description" : "from" }, "until" : { "type" : "string", "format" : "date-time", "description" : "until" }, "normalPrice" : { "description" : "Normal price", "$ref" : "#/definitions/ExchangedPrice" }, "newPrice" : { "description" : "new price", "$ref" : "#/definitions/ExchangedPrice" }, "valid" : { "type" : "string", "format" : "date-time", "description" : "Date until the price is valid" }, "priceChange" : { "description" : "The price change", "$ref" : "#/definitions/PriceChange" }, "product" : { "description" : "The product", "$ref" : "#/definitions/Product" } } }, "PriceChange" : { "type" : "object", "required" : [ "type" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "owner" : { "description" : "The object owner.", "$ref" : "#/definitions/User" }, "updater" : { "description" : "User who performed the last update.", "$ref" : "#/definitions/User" }, "id" : { "type" : "integer", "format" : "int32", "description" : "The id." }, "primary" : { "description" : "The optional primary price change", "$ref" : "#/definitions/PriceChange" }, "name" : { "type" : "string", "description" : "The name of the priceChange." }, "customer" : { "description" : "the customer or customer group used for the price change", "$ref" : "#/definitions/GenericCustomer" }, "customerData" : { "description" : "The new customer data", "$ref" : "#/definitions/BasicCustomer" }, "article" : { "description" : "Article", "$ref" : "#/definitions/Article" }, "comment" : { "type" : "string" }, "type" : { "$ref" : "#/definitions/PriceChangeTypeConstants" }, "status" : { "$ref" : "#/definitions/PriceChangeStatusConstants" }, "confirmed" : { "type" : "string", "format" : "date-time", "description" : "the confirmed date of the priceChange" }, "validFrom" : { "type" : "string", "format" : "date-time", "description" : "the validFrom date of the priceChange" }, "validUntil" : { "type" : "string", "format" : "date-time", "description" : "the validUntil date of the priceChange" }, "messageSend" : { "type" : "string", "format" : "date-time", "description" : "the messageSend date of the priceChange" }, "priceTemplates" : { "type" : "array", "items" : { "$ref" : "#/definitions/ProductPriceTemplate" } }, "priceClassTemplates" : { "type" : "array", "items" : { "$ref" : "#/definitions/PriceClassTemplate" } }, "priceChangeExcludes" : { "type" : "array", "items" : { "$ref" : "#/definitions/PriceChangeExclude" } }, "priceChangeExcludesAdd" : { "type" : "array", "description" : "Used by the patch route", "items" : { "$ref" : "#/definitions/PriceChangeExclude" } }, "priceChangeExcludesRem" : { "type" : "array", "description" : "Used by the patch route", "items" : { "$ref" : "#/definitions/PriceChangeExclude" } }, "worker" : { "type" : "string", "description" : "the worker of the priceChange" }, "ticketNumber" : { "type" : "string", "description" : "The ticketing number if available." }, "priceClassPrefix" : { "type" : "string", "description" : "prefix of the price class" }, "priceClassType" : { "type" : "string", "description" : "type of the priceClass article " } } }, "PriceChangeExclude" : { "type" : "object", "required" : [ "priceChange" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "id" : { "type" : "integer", "format" : "int32", "example" : 1, "description" : "The unique identifier of the price" }, "customer" : { "description" : "Customer", "$ref" : "#/definitions/GenericCustomer" }, "priceChange" : { "description" : "The priceChange", "$ref" : "#/definitions/PriceChange" } } }, "PriceChangeStatusConstants" : { "type" : "string", "enum" : [ "PENDING", "SUCCESS", "FAILED", "NOT_SET", "CONFIRMED", "FINISHED" ] }, "PriceChangeTypeConstants" : { "type" : "string", "enum" : [ "CUSTOMER", "GENERAL", "GENERAL_DISCOUNT", "GENERAL_NEW_ARTICLE", "PROMO", "PRIMARY" ] }, "PriceClassTemplate" : { "type" : "object", "required" : [ "amount", "businessCase", "currency", "name", "priceChange", "relative", "type" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "id" : { "type" : "integer", "format" : "int32", "example" : 1, "description" : "The unique identifier of the price" }, "name" : { "type" : "string", "description" : "Namee of the price class" }, "businessCase" : { "description" : "Lorem Ipum", "$ref" : "#/definitions/BusinessCase" }, "priceChange" : { "description" : "The priceChange", "$ref" : "#/definitions/PriceChange" }, "customer" : { "description" : "Customer", "$ref" : "#/definitions/GenericCustomer" }, "priority" : { "description" : "Priority", "$ref" : "#/definitions/PriorityConstants" }, "discountable" : { "type" : "boolean", "description" : "Indicates if price discountable is possible" }, "currency" : { "type" : "string", "example" : "EUR", "description" : "Used currency ", "x-custom-type" : "currency" }, "period" : { "description" : "The activity period of a product", "$ref" : "#/definitions/TimePeriod" }, "relative" : { "description" : "The rounding strategy", "$ref" : "#/definitions/RelativeConstants" }, "amount" : { "type" : "number", "format" : "double", "description" : "Amount" }, "actualAmount" : { "type" : "number", "format" : "double", "description" : "The actual amount, before the price change processing" }, "purchaseAmount" : { "type" : "number", "format" : "double", "description" : "The actual purchase amount" }, "margin" : { "type" : "number", "format" : "float", "description" : "The margin between amount and purchase amount" }, "priceConditions" : { "type" : "array", "description" : "ProductPriceTemplate Price condition", "items" : { "$ref" : "#/definitions/PriceServiceEntity" } }, "type" : { "type" : "string", "description" : "type of the article " } } }, "PriceData" : { "type" : "object", "properties" : { "prices" : { "type" : "array", "description" : "The subject products", "items" : { "$ref" : "#/definitions/SimplePrice" } } } }, "PriceList" : { "type" : "object", "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "owner" : { "description" : "The object owner.", "$ref" : "#/definitions/User" }, "updater" : { "description" : "User who performed the last update.", "$ref" : "#/definitions/User" }, "id" : { "type" : "integer", "format" : "int32", "description" : "The id." }, "label" : { "type" : "string", "description" : "The unique identifier, must be unique within the customer client" }, "client" : { "type" : "string", "description" : "The customer client" }, "group" : { "type" : "string", "description" : "The optional list group" }, "type" : { "description" : "The type of the price list", "$ref" : "#/definitions/Type" }, "from" : { "type" : "string", "format" : "date-time", "description" : "The from date" }, "to" : { "type" : "string", "format" : "date-time", "description" : "The to date" }, "inactive" : { "type" : "boolean", "description" : "Flag indication if the priceList is inactive" }, "comment" : { "type" : "string", "description" : "Comments" }, "customerPriceListsAdd" : { "type" : "array", "description" : "Used by the patch route", "items" : { "$ref" : "#/definitions/CustomerPriceList" } }, "customerPriceListsRem" : { "type" : "array", "description" : "Used by the patch route", "items" : { "$ref" : "#/definitions/CustomerPriceList" } }, "hasCustomerPriceList" : { "type" : "boolean", "description" : "Flag indication if the priceList is inactive" }, "excludeFromPricechange" : { "type" : "boolean" } } }, "PriceListEntity" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int32", "description" : "The id." }, "label" : { "type" : "string", "description" : "The unique identifier, must be unique within the customer client" }, "inactive" : { "type" : "boolean", "description" : "Flag indication if the priceList is inactive" } } }, "PriceMarkupType" : { "type" : "string", "enum" : [ "PERCENT", "ABSOLUTE" ] }, "PriceRoundingConstants" : { "type" : "string", "enum" : [ "NONE", "ROUND_X0", "ROUND_00", "ROUND_X9", "ROUND_99", "ROUND_COMMERCIAL" ] }, "PriceServiceData" : { "type" : "object", "properties" : { "debugTime" : { "type" : "integer", "format" : "int64", "description" : "The debug time" }, "status" : { "description" : "The status", "$ref" : "#/definitions/DomainStudioServiceStatus" }, "message" : { "type" : "string", "description" : "A message with more information, if the status is FAILED." }, "data" : { "description" : "The subject products", "$ref" : "#/definitions/PriceData" } } }, "PriceServiceEntity" : { "type" : "object", "properties" : { "configuration" : { "type" : "object", "description" : "Lorem Ipum", "additionalProperties" : { "type" : "object" } }, "condition" : { "description" : "service entity", "$ref" : "#/definitions/ServiceEntity" } } }, "PriceTypeConstants" : { "type" : "string", "enum" : [ "GROSS", "NET" ] }, "PriorityConstants" : { "type" : "string", "enum" : [ "DEFAULT", "OFFER", "PROTECTED", "PROMO" ] }, "Product" : { "type" : "object", "required" : [ "article", "businessCase" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "owner" : { "description" : "The object owner.", "$ref" : "#/definitions/User" }, "updater" : { "description" : "User who performed the last update.", "$ref" : "#/definitions/User" }, "article" : { "description" : "Article", "$ref" : "#/definitions/Article" }, "vatType" : { "type" : "string", "description" : "Vat type" }, "priceRequired" : { "type" : "boolean", "description" : "Shows if the product requires a price" }, "id" : { "type" : "integer", "format" : "int32", "description" : "The unique id of the product" }, "businessCase" : { "type" : "string", "description" : "Business case" } } }, "ProductPriceTemplate" : { "type" : "object", "required" : [ "amount", "currency", "priceChange", "product", "relative" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "id" : { "type" : "integer", "format" : "int32", "example" : 1, "description" : "The unique identifier of the price" }, "priceChange" : { "description" : "The priceChange", "$ref" : "#/definitions/PriceChange" }, "product" : { "description" : "The product", "$ref" : "#/definitions/Product" }, "amount" : { "type" : "number", "format" : "double", "description" : "Amount" }, "currency" : { "type" : "string", "example" : "EUR", "description" : "Used currency ", "x-custom-type" : "currency" }, "customer" : { "description" : "Customer", "$ref" : "#/definitions/GenericCustomer" }, "priority" : { "description" : "Priority", "$ref" : "#/definitions/PriorityConstants" }, "discountable" : { "type" : "boolean", "description" : "Indicates if price discountable is possible" }, "period" : { "description" : "The activity period of a product", "$ref" : "#/definitions/TimePeriod" }, "relative" : { "description" : "The rounding strategy", "$ref" : "#/definitions/RelativeConstants" }, "priceConditions" : { "type" : "array", "description" : "ProductPriceTemplate Price condition", "items" : { "$ref" : "#/definitions/PriceServiceEntity" } }, "actualAmount" : { "type" : "number", "format" : "double", "description" : "The actual amount, before the price change processing" }, "purchaseAmount" : { "type" : "number", "format" : "double", "description" : "The actual purchase amount" }, "margin" : { "type" : "number", "format" : "float", "description" : "The margin between amount and purchase amount" } } }, "ProtectionConstants" : { "type" : "string", "enum" : [ "HIGH", "MEDIUM", "LOW", "OFF", "CUSTOM" ] }, "ProtocolTypeConstants" : { "type" : "string", "enum" : [ "TOTP", "HOTP" ] }, "Provider" : { "type" : "string", "enum" : [ "IPAYMENT", "PAYPAL" ] }, "ProviderEntity" : { "type" : "object", "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "owner" : { "description" : "The object owner.", "$ref" : "#/definitions/User" }, "updater" : { "description" : "User who performed the last update.", "$ref" : "#/definitions/User" }, "name" : { "type" : "string", "description" : "The name of the provider" }, "types" : { "type" : "array", "description" : "The supported types", "uniqueItems" : true, "items" : { "type" : "string" } } } }, "PurgeTypes" : { "type" : "string", "enum" : [ "AUTO", "DISABLED", "SCHEDULED" ] }, "Query" : { "type" : "object", "properties" : { "filters" : { "type" : "array", "items" : { "$ref" : "#/definitions/QueryFilter" } }, "view" : { "$ref" : "#/definitions/QueryView" }, "orders" : { "type" : "array", "items" : { "$ref" : "#/definitions/Order" } } } }, "QueryFilter" : { "type" : "object", "properties" : { "key" : { "type" : "string", "description" : "Name of keyword." }, "value" : { "type" : "string", "description" : "Value after which filtering is to be performed." }, "values" : { "type" : "array", "items" : { "type" : "string" } }, "operator" : { "description" : "Comparison operator.", "$ref" : "#/definitions/Operator" }, "link" : { "$ref" : "#/definitions/ConditionType" }, "filters" : { "type" : "array", "items" : { "$ref" : "#/definitions/QueryFilter" } } } }, "QueryView" : { "type" : "object", "properties" : { "limit" : { "type" : "integer", "format" : "int32", "description" : "Maximum number of objects to be displayed." }, "offset" : { "type" : "integer", "format" : "int32", "description" : "Defines the starting position of the returned result." }, "children" : { "type" : "boolean", "example" : false, "description" : "Query subusers. Default value=false" }, "from" : { "type" : "string", "format" : "date-time", "example" : "2021-01-01 00:00:00", "description" : "End Date - Required for Historical Task" }, "to" : { "type" : "string", "format" : "date-time", "example" : "2022-01-01 00:00:00", "description" : "Start Date - Required for Historical Task." } } }, "RddsOptInConstants" : { "type" : "string", "enum" : [ "NOT_SET", "OWNERC", "ADMINC", "OWNERC_ADMINC", "TECHC", "OWNERC_TECHC", "ADMINC_TECHC", "ALL" ] }, "Recipient" : { "type" : "object", "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "email" : { "type" : "string", "description" : "the email address of the recipient", "x-custom-type" : "email" }, "role" : { "description" : "The recipients role", "$ref" : "#/definitions/RecipientRole" }, "status" : { "description" : "The actual delivery status of the email", "$ref" : "#/definitions/DeliveryStatus" }, "attempt" : { "type" : "string", "format" : "date-time", "description" : "The date of the next attempt" }, "attemptCount" : { "type" : "integer", "format" : "int32", "description" : "The number of attempts" }, "expire" : { "type" : "string", "format" : "date-time", "description" : "The date after the mail delivery will be expire." }, "logs" : { "type" : "array", "description" : "The trace logs of each attempt", "items" : { "$ref" : "#/definitions/RecipientLog" } } } }, "RecipientLog" : { "type" : "object", "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "host" : { "type" : "string", "description" : "the hostname of the mail exchange" }, "lastResponse" : { "type" : "string", "description" : "the last reponse of the server communication" }, "trace" : { "type" : "string", "description" : "the trace lof the commonication" } } }, "RecipientRole" : { "type" : "string", "enum" : [ "TO", "CC", "BCC" ] }, "Redirect" : { "type" : "object", "required" : [ "mode", "source", "target", "type" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "owner" : { "description" : "The object owner.", "$ref" : "#/definitions/User" }, "updater" : { "description" : "User who performed the last update.", "$ref" : "#/definitions/User" }, "source" : { "type" : "string", "description" : "Domain that is to be redirected, e.g. test.example.com." }, "target" : { "type" : "string", "description" : "The URL of the target domain. Enter the domain without \"https://\"." }, "type" : { "description" : "The type of redirect.", "$ref" : "#/definitions/RedirectTypeConstants" }, "mode" : { "description" : "The redirect mode of domain and email forwarding.", "$ref" : "#/definitions/RedirectModeConstants" }, "domain" : { "type" : "string", "description" : "Domain that is to be redirected, e.g. example.com." }, "title" : { "type" : "string", "description" : "Only for the 'frame' mode. Page title to be displayed in the browser title bar." }, "backups" : { "type" : "array", "description" : "Backup destinations for the redirects. If the first destination cannot be reached, the domain is automatically redirected to the substitute destination (domain redirection, frame redirect).", "items" : { "type" : "string" }, "maxItems" : 3, "minItems" : 0 }, "sourceIdn" : { "type" : "string", "description" : "The IDN version of the domain name. Domains can be entered with or without \"www\"." }, "targetIdn" : { "type" : "string", "description" : "The Punycode syntax (IDN) version of the target domain URL. Enter the domain without \"https://\"." }, "lastSeen" : { "type" : "string", "format" : "date-time", "description" : "The last DNS connection. Used for analytics, to keep track of when the DNS has been used." } } }, "RedirectModeConstants" : { "type" : "string", "enum" : [ "CATCHALL", "FRAME", "HTTP", "SINGLE", "HTTPS" ] }, "RedirectTypeConstants" : { "type" : "string", "enum" : [ "DOMAIN", "EMAIL" ] }, "Registrar" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "tag" : { "type" : "string" } } }, "RegistrationTypeConstants" : { "type" : "string", "enum" : [ "FCFS", "APPLICATION", "OTHER" ] }, "RegistryStatusConstants" : { "type" : "string", "enum" : [ "ACTIVE", "HOLD", "LOCK", "HOLD_LOCK", "AUTO", "LOCK_OWNER", "LOCK_UPDATE", "PENDING", "NONE" ] }, "RelativeConstants" : { "type" : "string", "enum" : [ "FIX", "RELATIVE_PERCENT", "RELATIVE_AMOUNT", "DELETE" ] }, "RenewStatusConstants" : { "type" : "string", "enum" : [ "AUTO", "CANCELED", "ONCE" ] }, "ResourceRecord" : { "type" : "object", "required" : [ "name" ], "properties" : { "name" : { "type" : "string", "description" : "The name of the resource record." }, "ttl" : { "type" : "integer", "format" : "int64", "description" : "Time-to-live value in seconds. Will be set to the default SOA value if not explicitly set." }, "type" : { "type" : "string", "example" : "A, MX, CNAME, TXT, SRV, PTR, AAAA, NS, CAA, PROCEED_MUC, TLSA, NAPTR, SSHFP, LOC, RP, HINFO, PROCEED, ALIAS, DNSKEY, NSEC, DS", "description" : "Resource record type\nFurther information about resource records:\nhttps://de.wikipedia.org/wiki/Resource_Record" }, "value" : { "type" : "string", "description" : "The value of the resource record." }, "pref" : { "type" : "integer", "format" : "int32", "description" : "The resource record priority which may be needed by certain record types such as MX.", "maximum" : 65535 }, "raw" : { "type" : "string", "description" : "The bind notation of the record. Only used by the zone stream task!" } } }, "ResponseObject" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The type of the object." }, "value" : { "type" : "string", "description" : "The primary key of the object." }, "summary" : { "type" : "integer", "format" : "int32", "description" : "The amound of objects found in list tasks." }, "data" : { "type" : "object", "description" : "The value of the object." } } }, "ResponseStatus" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "The result code of the response." }, "text" : { "type" : "string", "description" : "The text representation of the result code." }, "type" : { "description" : "Type of response according to the status of the order.", "$ref" : "#/definitions/StatusType" } } }, "RoPersonTypeConstants" : { "type" : "string", "enum" : [ "P", "AP", "NC", "C", "GI", "PI", "O" ] }, "SEPAMandate" : { "type" : "object", "required" : [ "confirmChecked", "confirmIp", "confirmSignature" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "document" : { "description" : "The linked pdf", "$ref" : "#/definitions/Document" }, "reference" : { "type" : "string", "description" : "The sepa mandate reference" }, "confirmSignature" : { "type" : "string", "format" : "date-time", "description" : "The date of the confirm signature" }, "confirmIp" : { "type" : "string", "description" : "The address of the confirm signature" }, "confirmUseragent" : { "type" : "string", "description" : "The user agent of the confirm signature" }, "confirmChecked" : { "type" : "boolean", "description" : "Flag for indicating if the confirm data has been checked" }, "expire" : { "type" : "string", "format" : "date-time", "description" : "Date after the mandate will be expired" }, "histories" : { "type" : "array", "description" : "A list of historized sepa mandates", "items" : { "$ref" : "#/definitions/SEPAMandate" } }, "status" : { "description" : "The status of the mandate", "$ref" : "#/definitions/SepaStatus" }, "accountHolder" : { "type" : "string", "description" : "The holder of the bank account" }, "iban" : { "type" : "string", "description" : "The bank iban" }, "bic" : { "type" : "string", "description" : "The bank bic" } } }, "SanType" : { "type" : "string", "enum" : [ "FQDN", "SUBDOMAIN", "WILDCARD" ] }, "SectigoHsmType" : { "type" : "string", "enum" : [ "YUBIKEY", "LUNA" ] }, "SellMode" : { "type" : "string", "enum" : [ "MANUAL", "AUTO" ] }, "SepaStatus" : { "type" : "string", "enum" : [ "ACTIVE", "UPDATE", "CANCELED", "EXPIRED", "LOCKED", "REMOVE" ] }, "ServerSoftwareTypeConstants" : { "type" : "string", "enum" : [ "IIS4", "IIS5", "APACHE2", "APACHESSL", "PLESK", "TOMCAT", "NOT_SET" ] }, "ServiceEntity" : { "type" : "object", "required" : [ "label" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "label" : { "type" : "string", "description" : "The unique identifier" } } }, "ServiceProfiles" : { "type" : "object", "properties" : { "serviceProfiles" : { "type" : "array", "description" : "The service profiles of the user.", "items" : { "$ref" : "#/definitions/ServiceUsersProfile" } } } }, "ServiceUsersProfile" : { "type" : "object", "required" : [ "key", "value" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "owner" : { "description" : "The object owner.", "$ref" : "#/definitions/User" }, "updater" : { "description" : "User who performed the last update.", "$ref" : "#/definitions/User" }, "key" : { "type" : "string", "example" : "techc", "description" : "The user profile key." }, "value" : { "type" : "string", "example" : "12345", "description" : "The value of the key." } } }, "SignatureHashAlgorithmConstants" : { "type" : "string", "enum" : [ "SHA1", "SHA2", "SHA2_FULL_CHAIN", "UNKNOWN", "SHA384", "SHA512", "SHA256", "SHA256_SHA1", "SHA384_SHA1", "SHA256_SHA256", "SHA256ECDSA_SHA1", "SHA384ECDSA_SHA1", "SHA256ECDSA_SHA384ECDSA", "SHA384ECDSA_SHA384ECDSA", "DEFAULT", "MD5_WITH_RSA_ENCRYPTION" ] }, "SimplePrice" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "format" : "double", "description" : "The gross amount of the calculation" }, "netAmount" : { "type" : "number", "format" : "double", "description" : "The net amount of the calculation" }, "vatAmount" : { "type" : "number", "format" : "double", "description" : "The calculated vat amount" }, "currency" : { "type" : "string", "example" : "EUR", "description" : "The billing currency", "x-custom-type" : "currency" }, "price" : { "description" : "The price. Note the currency can be differ from the billing currency", "$ref" : "#/definitions/ExchangedPrice" }, "businessCase" : { "type" : "string", "description" : "The business case" }, "period" : { "description" : "The period for the price calculation", "$ref" : "#/definitions/TimePeriod" }, "customs" : { "type" : "array", "description" : "Custom values,such as price class", "uniqueItems" : true, "items" : { "$ref" : "#/definitions/Custom" } }, "view" : { "description" : "The currency rate for the view currency", "$ref" : "#/definitions/CurrencyRate" } } }, "SiteSealInformation" : { "type" : "object", "properties" : { "hash" : { "type" : "string", "description" : "The hash value for the site seal." }, "size" : { "type" : "string", "description" : "The size of the site seal." }, "html" : { "type" : "string", "description" : "The plain html markup." }, "icon" : { "type" : "string", "description" : "The icon url." }, "preview" : { "type" : "string", "description" : "The preview url." } } }, "Soa" : { "type" : "object", "required" : [ "email" ], "properties" : { "refresh" : { "type" : "integer", "format" : "int64", "description" : "Number of seconds after which secondary name servers should query the master for the SOA record, to detect zone changes" }, "retry" : { "type" : "integer", "format" : "int64", "description" : "Number of seconds after which secondary name servers should retry to request the serial number from the master \r\nif the master does not respond. It must be less than Refresh." }, "expire" : { "type" : "integer", "format" : "int64", "description" : "Number of seconds after which secondary name servers \r\nshould stop answering request for this zone if the master does not respond. \r\nThis value must be bigger than the sum of Refresh and Retry." }, "ttl" : { "type" : "integer", "format" : "int64", "example" : "false = Check is performed\n false", "description" : "Time-to-live default value of the Resource Record of a zone" }, "email" : { "type" : "string", "description" : "The email address of the Zone Contact" } } }, "SocialMediaPlatform" : { "type" : "string", "enum" : [ "FACEBOOK", "TWITTER", "PINTEREST", "YOUTUBE", "TIKTOK", "GITHUB", "TWITCH", "VIMEO", "VK" ] }, "SpamPolicy" : { "type" : "object", "properties" : { "mode" : { "example" : "virus check", "description" : "Allows to enable checking by policy and choose how it should be handled if it does not comply with policy.", "$ref" : "#/definitions/PolicyMode" }, "modifySubject" : { "type" : "boolean", "description" : "Setting for the flag in the subject:\r\nfalse = The emails should not be marked in the subject\r\ntrue = The emails should receive the label in the subject.\r\nDefault= false\r\nFor XML, 0 (false) and 1 (true) can also be used." }, "tagHeader" : { "type" : "number", "format" : "double", "description" : "Enter a score. If an incoming email reaches this value, the email will \r\nbe marked as spam in the header. (Header X-Spam Status \r\nand X-Spam Level).\r\nRecommendation:\r\nValue between -999 and 1\r\nMinimum: -999.9\r\nMaximum: 999.9", "minimum" : -999.9, "maximum" : 999.9 }, "spam" : { "type" : "number", "format" : "double", "description" : "Enter a score from which an email should be classified as spam. \r\nThe header X-Spam-Flag will be added to emails that reach this score.\r\nMinimum: -999.9\r\nMaximum: 999.9", "minimum" : -999.9, "maximum" : 999.9 }, "kill" : { "type" : "number", "format" : "double", "description" : "At what value an email should be quarantined for the selected task\r\nMinimum: -999.9\r\nMaximum: 999.9", "minimum" : -999.9, "maximum" : 999.9 }, "quarantineDigestInterval" : { "type" : "integer", "format" : "int32", "description" : "\"Specify how long an email should be kept in quarantine.\r\nTime unit: minutes\r\nDefault: 1440 min\r\nMinimum: 1440 min\"", "minimum" : 1440 } } }, "SslContact" : { "type" : "object", "required" : [ "country", "email", "id", "organization", "phone", "title" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "extensions" : { "description" : "The contact extensions", "$ref" : "#/definitions/SslContactExtensions" }, "references" : { "type" : "array", "description" : "The contact references", "items" : { "$ref" : "#/definitions/SslContactReference" } }, "fname" : { "type" : "string", "example" : "John", "description" : "The first name of the contact" }, "lname" : { "type" : "string", "example" : "Doe", "description" : "The last name of the contact" }, "phone" : { "type" : "string", "example" : "+49-123-12345", "description" : "The phone number of the contact", "x-custom-type" : "phone" }, "fax" : { "type" : "string", "example" : "+49-123-12345", "description" : "The fax number of the contact", "x-custom-type" : "phone" }, "email" : { "type" : "string", "example" : "john.doe@domain.com", "description" : "The email address of the contact.", "x-custom-type" : "email" }, "title" : { "type" : "string", "example" : "Dr.", "description" : "The title of the contact" }, "organization" : { "type" : "string", "example" : "Company", "description" : "The name of organisation of the contact.", "minLength" : 0, "maxLength" : 64 }, "address" : { "type" : "array", "description" : "The address of the contact.", "items" : { "type" : "string" } }, "pcode" : { "type" : "string", "example" : "12345", "description" : "The postal code of the contact.", "x-custom-type" : "pcode" }, "city" : { "type" : "string", "example" : "Anytown", "description" : "The city of the contact" }, "country" : { "type" : "string", "example" : "DE", "description" : "The country of the contact", "x-custom-type" : "country" }, "state" : { "type" : "string", "example" : "BY", "description" : "The local country state of the contact", "x-custom-type" : "state" }, "owner" : { "description" : "The owner of the object", "$ref" : "#/definitions/User" }, "updater" : { "description" : "The updating using of the object", "$ref" : "#/definitions/User" }, "id" : { "type" : "integer", "format" : "int32", "description" : "Unique identifier of the object" } } }, "SslContactExtensions" : { "type" : "object", "properties" : { "general" : { "description" : "The general extensions", "$ref" : "#/definitions/SslContactGeneralExtensions" } } }, "SslContactGeneralExtensions" : { "type" : "object", "properties" : { "joiCountryName" : { "type" : "string", "example" : "DE", "description" : "Country of judicial formation", "x-custom-type" : "country" }, "joiLocality" : { "type" : "string", "description" : "Locality or city of judicial formation" }, "joiStateOrProvince" : { "type" : "string", "description" : "State or province of judicial formation" }, "companyNumber" : { "type" : "string", "description" : "The company number" }, "businessCategory" : { "description" : "Additional validation data required for certain Comodo products.", "$ref" : "#/definitions/BusinessCategory" }, "organisationalIdentifier" : { "type" : "string", "example" : "VAT = DE12345678, NTR = DE-BY-12345678, LEI= LEIXG353800KCIOO2YWF3VP62, GOV = GOVUS, INTXG=INTXG", "description" : "The Organisational Identifier is the company/organization's registration number. It can either be a VAT, NTR, LEI number. You can provide GOV-identifier ( GOV + Country Code ) if it is a governmental organisation. INTXG if none matches. " } } }, "SslContactReference" : { "type" : "object", "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." } } }, "StatusType" : { "type" : "string", "enum" : [ "SUCCESS", "ERROR", "NOTIFY", "NOTICE", "NICCOM_NOTIFY" ] }, "Subject" : { "type" : "object", "required" : [ "name" ], "properties" : { "name" : { "type" : "string", "description" : "The name of the booking item, e.g. domain.de" }, "object" : { "type" : "string", "description" : "The internal unique name of the object, e.g. xn--" }, "customs" : { "type" : "array", "description" : "List of metadata", "uniqueItems" : true, "items" : { "$ref" : "#/definitions/Custom" } } } }, "SubjectAlternativeName" : { "type" : "object", "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "type" : { "example" : "FQDN\nSUBDOMAIN\nWILDCARD", "description" : "Type of SAN certificate.", "$ref" : "#/definitions/SanType" }, "sslCertificateId" : { "type" : "integer", "format" : "int32", "description" : "Id of the certificate this SAN belongs to." }, "name" : { "type" : "string", "description" : "The name of the san." }, "approverEmail" : { "type" : "string", "description" : "The approver email of the san." }, "orderId" : { "type" : "string", "description" : "The order id of the san." }, "free" : { "type" : "boolean", "description" : "Defines whether the san was free or not" } } }, "SubjectProduct" : { "type" : "object", "required" : [ "product", "subject" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "owner" : { "description" : "The object owner.", "$ref" : "#/definitions/User" }, "updater" : { "description" : "User who performed the last update.", "$ref" : "#/definitions/User" }, "id" : { "type" : "integer", "format" : "int64", "description" : "Id of the product" }, "period" : { "description" : "Product run time", "$ref" : "#/definitions/TimePeriod" }, "customer" : { "description" : "Customer", "$ref" : "#/definitions/GenericCustomer" }, "billing" : { "description" : "Billing user", "$ref" : "#/definitions/User" }, "product" : { "description" : "Name of the product", "$ref" : "#/definitions/Product" }, "subject" : { "description" : "Booking item", "$ref" : "#/definitions/Subject" }, "count" : { "type" : "number", "format" : "float", "description" : "Count" }, "effectiveCount" : { "type" : "number", "format" : "float", "description" : "Number actually billed" }, "amount" : { "type" : "number", "format" : "double", "description" : "Calculated gross amount" }, "vatAmount" : { "type" : "number", "format" : "double", "description" : "Calculated vat amount" }, "currency" : { "type" : "string", "example" : "EUR", "description" : "Used currency of the amount", "x-custom-type" : "currency" }, "type" : { "description" : "Type of posting item. Charge, credit, etc.", "$ref" : "#/definitions/AccountingDocumentTypeConstants" }, "price" : { "description" : "Price of the product", "$ref" : "#/definitions/ExchangedPrice" }, "label" : { "type" : "string", "description" : "The complete text of the posting item" }, "number" : { "type" : "string", "description" : "The number of the product in the external booking system" }, "comment" : { "type" : "string", "description" : "Comment to the product" }, "payable" : { "type" : "string", "format" : "date-time", "description" : "Maturity of the position" }, "provisioning" : { "description" : "Internal status of provision", "$ref" : "#/definitions/GenericStatusConstants" }, "netAmount" : { "type" : "number", "format" : "double", "description" : "Net amount" }, "externalAccountingStatus" : { "type" : "string", "description" : "Reference in external booking system" }, "view" : { "description" : "Currency to be displayed", "$ref" : "#/definitions/CurrencyRate" } } }, "Subscription" : { "type" : "object", "required" : [ "payable" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "id" : { "type" : "integer", "format" : "int32", "example" : 1, "description" : "The unique identifier of the periodic" }, "owner" : { "description" : "The object owner.", "$ref" : "#/definitions/User" }, "updater" : { "description" : "User who performed the last update.", "$ref" : "#/definitions/User" }, "status" : { "description" : "Billing status of the subscription.", "$ref" : "#/definitions/BillingStatus" }, "object" : { "type" : "string", "description" : "Name of the subscription or the contract number." }, "description" : { "type" : "string", "description" : "The human readable name of the subscription, e.g. the name of a package" }, "period" : { "description" : "The period used by the subscription, e.g. 1 month", "$ref" : "#/definitions/TimePeriod" }, "articleTypeLabel" : { "type" : "string", "description" : "The article type label of the subscription, e.g. domain" }, "payable" : { "type" : "string", "format" : "date-time", "description" : "The date then the event should be billed." }, "articleLabel" : { "type" : "string", "description" : "The article label of the subscription, e.g. backup_mx" }, "item" : { "type" : "array", "description" : "The items of the subscription", "items" : { "$ref" : "#/definitions/PeriodicBilling" } }, "expire" : { "type" : "string", "format" : "date-time", "description" : "The expiration date of the subscription." }, "cancelationTerm" : { "description" : "cancelationTerm of the subscription..", "$ref" : "#/definitions/TimePeriod" }, "cancelation" : { "type" : "string", "format" : "date-time", "description" : "The cancelation date of the subscription." }, "canceled" : { "type" : "string", "format" : "date-time", "description" : "The canceled date." }, "limits" : { "type" : "array", "description" : "The limits of the package.", "items" : { "$ref" : "#/definitions/BillingObjectLimit" } }, "acls" : { "type" : "array", "description" : "The acls of the package", "items" : { "$ref" : "#/definitions/UserAcl" } }, "profiles" : { "type" : "array", "description" : "The user profiles of the package", "items" : { "$ref" : "#/definitions/UserProfile" } }, "cancelationEffective" : { "type" : "string", "format" : "date-time", "description" : "The cancelationEffective" }, "variant" : { "type" : "string", "description" : "The name variant, e.g nodesecure" }, "businessCase" : { "type" : "string", "description" : "The businessCase of the subscription, e.g. create" }, "extensions" : { "description" : "Additional information, such as rights and limits.", "$ref" : "#/definitions/BillingEventExtensions" } } }, "TaskGroup" : { "type" : "string", "enum" : [ "DOMAIN_CREATE", "DOMAIN_DELETE", "DOMAIN_STATUS_UPDATE", "DOMAIN_TRANSFER_IN", "DOMAIN_TRANSFER_OUT", "DOMAINSAFE", "AUTHINFO_CREATE", "AUTHINFO_SEND", "ZONE_CREATE", "WHOIS", "DOMAIN_UPDATE", "DOMAINSTUDIO", "ZONE_UPDATE", "ZONE_DELETE", "ZONE_AXFR", "DOMAINSTUDIO_DOMAINSBOT" ] }, "TaskLimit" : { "type" : "object", "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "taskGroup" : { "description" : "The selected task group", "$ref" : "#/definitions/TaskGroup" }, "limitSelf" : { "type" : "integer", "format" : "int32", "description" : "The self limit count" }, "inclusiveSelf" : { "type" : "integer", "format" : "int32", "description" : "The self included count" }, "timeUnitSelf" : { "description" : "The self time unit", "$ref" : "#/definitions/TimeUnitConstants" }, "limitChildren" : { "type" : "integer", "format" : "int32", "description" : "The limited count for each child" }, "inclusiveChildren" : { "type" : "integer", "format" : "int32", "description" : "The included count for each child" }, "timeUnitChildren" : { "description" : "The time unit for each child", "$ref" : "#/definitions/TimeUnitConstants" }, "count" : { "type" : "integer", "format" : "int32", "description" : "The current count if available" }, "user" : { "description" : "The affected user ", "$ref" : "#/definitions/User" } } }, "TaskUserLimit" : { "type" : "object", "required" : [ "user" ], "properties" : { "user" : { "$ref" : "#/definitions/User" }, "entries" : { "type" : "array", "items" : { "$ref" : "#/definitions/TaskLimit" } } } }, "TechnicalCustomer" : { "type" : "object", "required" : [ "client", "number" ], "properties" : { "number" : { "type" : "integer", "format" : "int64", "description" : "Customer number" }, "client" : { "type" : "string", "description" : "Account Label.", "minLength" : 1, "maxLength" : 2147483647 }, "group" : { "type" : "integer", "format" : "int64", "example" : 13516, "description" : "Customer group, first 5 numbers of the account number. e.g. " }, "adoptExpiration" : { "$ref" : "#/definitions/AdoptExpiration" }, "billingTerm" : { "$ref" : "#/definitions/BillingTerm" }, "autoDeleteTlds" : { "type" : "string" } } }, "TimePeriod" : { "type" : "object", "properties" : { "unit" : { "example" : "YEAR", "description" : "Time unit", "$ref" : "#/definitions/TimeUnitConstants" }, "period" : { "type" : "integer", "format" : "int64", "example" : 1, "description" : "Number of time units" } } }, "TimeUnitConstants" : { "type" : "string", "enum" : [ "MILLISECOND", "SECOND", "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR" ] }, "TldContinent" : { "type" : "string", "enum" : [ "ASIA", "AFRICA", "NORTH_AMERICA", "SOUTH_AMERICA", "ANTARCTICA", "EUROPE", "OCEANIA", "GLOBAL" ] }, "TldDataController" : { "type" : "object", "properties" : { "type" : { "type" : "string" }, "name" : { "type" : "string" }, "organisation" : { "type" : "string" }, "address" : { "type" : "array", "items" : { "type" : "string" } } } }, "TldDns" : { "type" : "object", "properties" : { "dnssecMin" : { "type" : "integer", "format" : "int32" }, "dnssecMax" : { "type" : "integer", "format" : "int32" }, "dnssecAlgorithms" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "nserverMin" : { "type" : "integer", "format" : "int32" }, "nserverMax" : { "type" : "integer", "format" : "int32" }, "ipv4Min" : { "type" : "integer", "format" : "int32" }, "ipv4Max" : { "type" : "integer", "format" : "int32" }, "ipv6Min" : { "type" : "integer", "format" : "int32" }, "ipv6Max" : { "type" : "integer", "format" : "int32" }, "nsentryMin" : { "type" : "integer", "format" : "int32" }, "nsentryMax" : { "type" : "integer", "format" : "int32" } } }, "TldPeriod" : { "type" : "object", "properties" : { "restoreArgpPeriod" : { "$ref" : "#/definitions/TimePeriod" }, "restoreRgpPeriod" : { "$ref" : "#/definitions/TimePeriod" }, "cancelationPeriod" : { "$ref" : "#/definitions/TimePeriod" }, "cutoffPeriod" : { "$ref" : "#/definitions/TimePeriod" } } }, "TldProduct" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int32" }, "label" : { "type" : "string" }, "charMin" : { "type" : "integer", "format" : "int32" }, "charMax" : { "type" : "integer", "format" : "int32" }, "dnssecMin" : { "type" : "integer", "format" : "int32" }, "dnssecMax" : { "type" : "integer", "format" : "int32" }, "dnssecAlgorithms" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "nserverMin" : { "type" : "integer", "format" : "int32" }, "nserverMax" : { "type" : "integer", "format" : "int32" }, "ipv4Min" : { "type" : "integer", "format" : "int32" }, "ipv4Max" : { "type" : "integer", "format" : "int32" }, "ipv6Min" : { "type" : "integer", "format" : "int32" }, "ipv6Max" : { "type" : "integer", "format" : "int32" }, "nsentryMin" : { "type" : "integer", "format" : "int32" }, "nsentryMax" : { "type" : "integer", "format" : "int32" }, "rootNserver" : { "type" : "array", "items" : { "type" : "string" } }, "dnssecRecord" : { "type" : "integer", "format" : "int32" }, "restoreArgpPeriod" : { "$ref" : "#/definitions/TimePeriod" }, "restoreRgpPeriod" : { "$ref" : "#/definitions/TimePeriod" }, "cancelationPeriod" : { "$ref" : "#/definitions/TimePeriod" }, "taskCreate" : { "type" : "boolean" }, "taskUpdate" : { "type" : "boolean" }, "taskDelete" : { "type" : "boolean" }, "taskRenew" : { "type" : "boolean" }, "taskTransfer" : { "type" : "boolean" }, "taskTransit" : { "type" : "boolean" }, "taskPreack" : { "type" : "boolean" }, "taskRestore" : { "type" : "boolean" }, "taskAuthinfoCreate" : { "type" : "boolean" }, "taskAuthinfoDelete" : { "type" : "boolean" }, "taskAuthinfo2" : { "type" : "boolean" }, "taskStatusUpdate" : { "type" : "boolean" }, "taskOwnerChange" : { "type" : "boolean" }, "cancelationExpireOnly" : { "type" : "boolean" }, "registrarStatus" : { "type" : "array", "items" : { "type" : "string" } }, "authinfo1Location" : { "type" : "array", "items" : { "$ref" : "#/definitions/AuthInfo1Location" } }, "numeralDomains" : { "type" : "boolean" }, "realtime" : { "type" : "boolean" }, "idn" : { "type" : "array", "items" : { "$ref" : "#/definitions/Charset" } }, "transferConfirmation" : { "type" : "boolean" }, "dnsCheck" : { "type" : "boolean" }, "premiumDomains" : { "type" : "boolean" }, "contactExtensions" : { "type" : "array", "items" : { "type" : "string" } }, "privacy" : { "type" : "boolean" }, "trustee" : { "type" : "boolean" }, "forcedTrustee" : { "type" : "boolean" }, "thirdLevel" : { "type" : "boolean" }, "transferAuthinfo" : { "type" : "boolean" }, "ownerchangeAuthinfo" : { "type" : "boolean" }, "errorCodes" : { "type" : "array", "items" : { "type" : "string" } }, "tldType" : { "$ref" : "#/definitions/TldType" }, "tldContinent" : { "$ref" : "#/definitions/TldContinent" }, "categories" : { "type" : "array", "items" : { "type" : "string" } }, "confluencePageDe" : { "type" : "string" }, "confluencePageEn" : { "type" : "string" }, "commentDe" : { "type" : "string" }, "commentEn" : { "type" : "string" }, "whois" : { "type" : "string" }, "countryIso" : { "type" : "string" }, "geoPol" : { "type" : "string" }, "officialLanguage" : { "type" : "string" }, "blockingServices" : { "type" : "array", "items" : { "type" : "string" } }, "restrictions" : { "type" : "array", "items" : { "$ref" : "#/definitions/Condition" } }, "country" : { "$ref" : "#/definitions/Country" }, "dataControllers" : { "type" : "array", "items" : { "$ref" : "#/definitions/TldDataController" } }, "preregInformation" : { "type" : "array", "items" : { "$ref" : "#/definitions/PreregInformation" } }, "rankingLevel" : { "type" : "integer", "format" : "int32" }, "tldTasks" : { "type" : "array", "items" : { "$ref" : "#/definitions/TldTask" } }, "tldDns" : { "$ref" : "#/definitions/TldDns" }, "tldPeriod" : { "$ref" : "#/definitions/TldPeriod" }, "isManual" : { "type" : "boolean" }, "requiredFields" : { "type" : "array", "items" : { "type" : "string" } }, "transferImportedContacts" : { "type" : "array", "items" : { "$ref" : "#/definitions/ContactReferenceType" } }, "allowedOcCases" : { "type" : "array", "items" : { "type" : "string" } }, "registrars" : { "type" : "array", "items" : { "$ref" : "#/definitions/Registrar" } }, "autoDelete" : { "type" : "boolean" }, "documents" : { "type" : "array", "items" : { "$ref" : "#/definitions/Document" } }, "registryLock" : { "type" : "boolean" }, "trusteeTypes" : { "type" : "array", "items" : { "$ref" : "#/definitions/ContactReferenceType" } }, "sldMin" : { "type" : "integer", "format" : "int32" }, "sldMax" : { "type" : "integer", "format" : "int32" }, "numeric" : { "type" : "boolean" } } }, "TldStatistic" : { "type" : "object" }, "TldTask" : { "type" : "object", "properties" : { "label" : { "type" : "string" }, "available" : { "type" : "boolean" }, "chargeable" : { "type" : "boolean" }, "min" : { "$ref" : "#/definitions/TimePeriod" }, "max" : { "$ref" : "#/definitions/TimePeriod" }, "processing" : { "$ref" : "#/definitions/TldTaskProcessing" }, "authinfo" : { "$ref" : "#/definitions/AuthInfo" }, "requiredAuthinfo" : { "type" : "boolean" } } }, "TldTaskProcessing" : { "type" : "string", "enum" : [ "AUTOMATED", "MANUAL", "SEMIAUTOMATED" ] }, "TldType" : { "type" : "string", "enum" : [ "CCTLD", "GTLD", "NEW_GTLD" ] }, "TlsData" : { "type" : "object", "properties" : { "version" : { "type" : "string", "description" : "The tls version" }, "supported" : { "type" : "boolean", "description" : "Whether the version is supported or not" } } }, "TmchClaimsNotice" : { "type" : "object", "required" : [ "confirmIP" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "owner" : { "description" : "The object owner.", "$ref" : "#/definitions/User" }, "updater" : { "description" : "User who performed the last update.", "$ref" : "#/definitions/User" }, "reference" : { "type" : "string" }, "name" : { "$ref" : "#/definitions/Domain" }, "idn" : { "type" : "string" }, "ownerc" : { "$ref" : "#/definitions/Contact" }, "messageSent" : { "type" : "string", "format" : "date-time" }, "email" : { "type" : "string" }, "confirmed" : { "type" : "string", "format" : "date-time" }, "confirmIP" : { "$ref" : "#/definitions/InetAddress" }, "status" : { "$ref" : "#/definitions/GenericStatusConstants" }, "data" : { "type" : "string" }, "comment" : { "type" : "string" }, "tmchClaimsNoticeMails" : { "type" : "array", "items" : { "$ref" : "#/definitions/TmchClaimsNoticeMessage" } }, "expire" : { "type" : "string", "format" : "date-time" } } }, "TmchClaimsNoticeMessage" : { "type" : "object", "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." } } }, "TmchContact" : { "type" : "object", "required" : [ "email", "entitlement" ], "properties" : { "entitlement" : { "$ref" : "#/definitions/TmchMarkHolderConstants" }, "name" : { "type" : "string" }, "organization" : { "type" : "string" }, "street" : { "type" : "string" }, "city" : { "type" : "string" }, "postalCode" : { "type" : "string" }, "state" : { "type" : "string" }, "country" : { "type" : "string" }, "email" : { "type" : "string" }, "phone" : { "type" : "string" }, "fax" : { "type" : "string" } } }, "TmchMark" : { "type" : "object", "required" : [ "claimsNotify", "description", "name", "payable", "period", "reference", "smdInclusion", "type" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "owner" : { "description" : "The object owner.", "$ref" : "#/definitions/User" }, "updater" : { "description" : "User who performed the last update.", "$ref" : "#/definitions/User" }, "id" : { "type" : "integer", "format" : "int32" }, "type" : { "$ref" : "#/definitions/TmchMarkTypeConstants" }, "name" : { "type" : "string" }, "reference" : { "type" : "string" }, "holder" : { "$ref" : "#/definitions/TmchContact" }, "description" : { "type" : "string" }, "period" : { "$ref" : "#/definitions/TimePeriod" }, "documents" : { "type" : "array", "items" : { "$ref" : "#/definitions/TmchMarkDocument" } }, "labels" : { "type" : "array", "items" : { "type" : "string" } }, "comments" : { "type" : "array", "items" : { "$ref" : "#/definitions/TmchMarkComment" } }, "renew" : { "$ref" : "#/definitions/RenewStatusConstants" }, "status" : { "$ref" : "#/definitions/TmchMarkStatusConstants" }, "payable" : { "type" : "string", "format" : "date-time" }, "sent" : { "type" : "boolean" }, "smdInclusion" : { "type" : "boolean" }, "claimsNotify" : { "type" : "boolean" }, "orderComplete" : { "type" : "boolean" }, "claimsNotifyExtended" : { "type" : "boolean" }, "extension" : { "$ref" : "#/definitions/TmchMarkAddon" }, "smdFile" : { "type" : "string" } } }, "TmchMarkAddon" : { "type" : "object", "properties" : { "courtName" : { "type" : "string" }, "protection" : { "type" : "string", "format" : "date-time" }, "courtProtectionCountry" : { "type" : "string" }, "courtReference" : { "type" : "string" }, "treatyTitle" : { "type" : "string" }, "treatyExecution" : { "type" : "string", "format" : "date-time" }, "trademarkRegistration" : { "type" : "string", "format" : "date-time" }, "trademarkClassification" : { "type" : "string" }, "trademarkExpire" : { "type" : "string", "format" : "date-time" }, "trademarkNumber" : { "type" : "string" }, "trademarkJurisdiction" : { "type" : "string" }, "parentReference" : { "type" : "string" } } }, "TmchMarkComment" : { "type" : "object", "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "status" : { "$ref" : "#/definitions/TmchMarkStatusConstants" }, "comment" : { "type" : "string" }, "user" : { "$ref" : "#/definitions/User" } } }, "TmchMarkDocument" : { "type" : "object", "required" : [ "document", "type" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "type" : { "$ref" : "#/definitions/DocumentTypeConstants" }, "document" : { "$ref" : "#/definitions/Document" } } }, "TmchMarkHolderConstants" : { "type" : "string", "enum" : [ "OWNER", "LICENSEE", "ASSIGNEE" ] }, "TmchMarkStatusConstants" : { "type" : "string", "enum" : [ "OPEN", "PAYMENT", "PENDING", "INCORRECT", "VERIFIED", "SENT", "ACTIVE", "DEACTIVATED", "CANCELED", "RENEW", "FAILED", "EXTERNAL", "PENDING_TRANSFER", "PENDING_RENEW", "PENDING_DELETE", "PENDING_PAYMENT", "PENDING_TRANSFER_PAYMENT", "PENDING_RENEW_PAYMENT" ] }, "TmchMarkTypeConstants" : { "type" : "string", "enum" : [ "TRADEMARK", "TREATY_OR_STATUTE", "COURT", "DNL_ABUSED" ] }, "Transfer" : { "type" : "object", "required" : [ "domain" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "owner" : { "description" : "The object owner.", "$ref" : "#/definitions/User" }, "updater" : { "description" : "User who performed the last update.", "$ref" : "#/definitions/User" }, "domain" : { "type" : "string", "description" : "The domain name." }, "gainingRegistrar" : { "type" : "string", "description" : "The gaining registrar." }, "loosingRegistrar" : { "type" : "string", "description" : "The loosing registrar." }, "start" : { "type" : "string", "format" : "date-time", "description" : "Date on which the transfer started." }, "reminder" : { "type" : "string", "format" : "date-time", "description" : "Date on which the transfer reminder mail is sent." }, "autoAck" : { "type" : "string", "format" : "date-time", "description" : "Date of the automatic ACK on which the transfer is confirmed." }, "autoNack" : { "type" : "string", "format" : "date-time", "description" : "Date of the automatic NACK on which the transfer is rejected." }, "end" : { "type" : "string", "format" : "date-time", "description" : "Date on which the transfer process ends." }, "autoAnswer" : { "type" : "boolean", "description" : "Automatic response to the transfer request.\r\nfalse = not active\r\ntrue = active\r\nDefault value = false\r\nFor XML, 0 (false) and 1 (true) can also be used." }, "recipient" : { "type" : "string", "description" : "Receiver of the reminder email." }, "status" : { "description" : "Status of a running transfer.", "$ref" : "#/definitions/TransferStatusConstants" } } }, "TransferAnswer" : { "type" : "string", "enum" : [ "TRANSFER_OUT_ACK", "TRANSFER_OUT_NACK" ] }, "TransferOut" : { "type" : "object", "required" : [ "domain", "type" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "owner" : { "description" : "The object owner.", "$ref" : "#/definitions/User" }, "updater" : { "description" : "User who performed the last update.", "$ref" : "#/definitions/User" }, "domain" : { "type" : "string", "description" : "The domain name." }, "gainingRegistrar" : { "type" : "string", "description" : "The gaining registrar." }, "loosingRegistrar" : { "type" : "string", "description" : "The loosing registrar." }, "start" : { "type" : "string", "format" : "date-time", "description" : "Date on which the transfer started." }, "reminder" : { "type" : "string", "format" : "date-time", "description" : "Date on which the transfer reminder mail is sent." }, "autoAck" : { "type" : "string", "format" : "date-time", "description" : "Date of the automatic ACK on which the transfer is confirmed." }, "autoNack" : { "type" : "string", "format" : "date-time", "description" : "Date of the automatic NACK on which the transfer is rejected." }, "end" : { "type" : "string", "format" : "date-time", "description" : "Date on which the transfer process ends." }, "autoAnswer" : { "type" : "boolean", "description" : "Automatic response to the transfer request.\r\nfalse = not active\r\ntrue = active\r\nDefault value = false\r\nFor XML, 0 (false) and 1 (true) can also be used." }, "recipient" : { "type" : "string", "description" : "Receiver of the reminder email." }, "transaction" : { "type" : "string", "description" : "The ctid." }, "type" : { "description" : "The type of the transfer.", "$ref" : "#/definitions/TransferAnswer" }, "nackReason" : { "type" : "integer", "format" : "int32", "description" : "Reason for rejection. Only for type \"nack\", mandatory here." } } }, "TransferStatusConstants" : { "type" : "string", "enum" : [ "NOT_SET", "START", "FAILED", "NACK", "ACK", "FOA1_SENT", "AUTOUPDATE_SUCCESS", "AUTOUPDATE_FAILED" ] }, "TrustedApplication" : { "type" : "object", "required" : [ "application", "uuid" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "owner" : { "description" : "The object owner.", "$ref" : "#/definitions/User" }, "updater" : { "description" : "User who performed the last update.", "$ref" : "#/definitions/User" }, "user" : { "description" : "The user the trusted application belongs to.", "$ref" : "#/definitions/User" }, "uuid" : { "type" : "string", "example" : "cb3e0fa4-2404-1ad", "description" : "The unique identifier for the trusted application." }, "password" : { "type" : "string", "description" : "The password for the trusted application." }, "application" : { "description" : "The kind of application.", "$ref" : "#/definitions/Application" }, "functions" : { "description" : "The wrapper of the allowed functions for the trusted application.", "$ref" : "#/definitions/TrustedApplicationFunctions" }, "restrictions" : { "description" : "The wrapper of the ip restrictions for the trusted application.", "$ref" : "#/definitions/IpRestrictions" }, "device" : { "type" : "string", "description" : "The device, which uses the trusted app." }, "comment" : { "type" : "string", "description" : "A comment for the trusted application." } } }, "TrustedApplicationFunctions" : { "type" : "object", "properties" : { "functionCodes" : { "type" : "array", "description" : "The allowed functions for the trusted application.", "uniqueItems" : true, "items" : { "type" : "string" } } } }, "TrusteeContact" : { "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "The nicName." }, "contact" : { "description" : "The contact.", "$ref" : "#/definitions/Contact" }, "type" : { "description" : "The type of the contact", "readOnly" : true, "$ref" : "#/definitions/ContactReferenceType" } } }, "Type" : { "type" : "string", "enum" : [ "INDIVIDUAL", "DISCOUNT" ] }, "UkTypeConstants" : { "type" : "string", "enum" : [ "LTD", "PLC", "PTNR", "STRA", "LLP", "IP", "IND", "SCH", "RCHAR", "GOV", "CRC", "STAT", "OTHER", "FIND", "FCORP", "FOTHER" ] }, "User" : { "type" : "object", "required" : [ "context", "user" ], "properties" : { "context" : { "type" : "integer", "format" : "int32", "description" : "The context. A separated section." }, "passwordChanged" : { "type" : "string", "format" : "date-time", "description" : "The date on which the password has changed" }, "passwordExpired" : { "type" : "boolean", "description" : "The passwordExpired boolean" }, "user" : { "type" : "string", "description" : "The user name.", "pattern" : "^[^_].*" } } }, "UserAcl" : { "type" : "object", "properties" : { "functionCode" : { "type" : "string", "description" : "The function code to be restricted" }, "children" : { "type" : "array", "description" : "The none locked children", "uniqueItems" : true, "items" : { "$ref" : "#/definitions/User" } }, "childrenLocked" : { "type" : "boolean", "description" : "Should all the subordinate users be locked.\nfalse = Locked for all sub users\ntrue = Release for all sub users\nDefault value = true\nFor XML, 0 (false) and 1 (true) can also be used." }, "userLocked" : { "type" : "boolean", "description" : "Should the ACL be locked or unlocked for this user. Valid values are: false, true \nFor XML, 0 (false) and 1 (true) may also be used.\nDefault value is true" }, "effective" : { "type" : "boolean", "description" : "The current effective rights." }, "childrenRem" : { "type" : "array", "description" : "Children to remove from the exception list", "items" : { "$ref" : "#/definitions/User" } }, "childrenAdd" : { "type" : "array", "description" : "Children to add to the exception list", "items" : { "$ref" : "#/definitions/User" } }, "restriction" : { "description" : "Describes the restriction as a result of the authorisation check. The object defines the different types of restrictions.", "$ref" : "#/definitions/ACLRestriction" } } }, "UserAcls" : { "type" : "object", "required" : [ "user" ], "properties" : { "user" : { "description" : "The user which has been effected", "$ref" : "#/definitions/User" }, "acls" : { "type" : "array", "description" : "The acls of the user.", "items" : { "$ref" : "#/definitions/UserAcl" }, "maxItems" : 2147483647, "minItems" : 1 } } }, "UserDetails" : { "type" : "object", "properties" : { "organization" : { "type" : "string", "description" : "The company name of the user." }, "passwordResetMobile" : { "type" : "string", "example" : "+49-123-12345", "description" : "Mobile phone number to which the TAN is sent.", "x-custom-type" : "phone" }, "passwordResetVerifyEmail" : { "type" : "string", "description" : "Email address used for verification when resetting the password." }, "passwordResetEmail" : { "type" : "string", "description" : "Email address to which the TAN is sent." }, "fname" : { "type" : "string", "description" : "The first name of the user." }, "lname" : { "type" : "string", "description" : "The last name of the user." }, "phone" : { "type" : "string", "example" : "+49-123-12345", "description" : "The phone number of the user.", "x-custom-type" : "phone" } } }, "UserLock" : { "type" : "string", "enum" : [ "NONE", "CUSTOMER", "EXPIRED", "USER", "INVITE" ] }, "UserProfile" : { "type" : "object", "required" : [ "flag", "key", "value" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "owner" : { "description" : "The object owner.", "$ref" : "#/definitions/User" }, "updater" : { "description" : "User who performed the last update.", "$ref" : "#/definitions/User" }, "key" : { "type" : "string", "example" : "techc", "description" : "The user profile key." }, "value" : { "type" : "string", "example" : "12345", "description" : "The value of the key." }, "flag" : { "example" : "FIX", "description" : "Defines to what extent the settings of a user are adopted by its subusers.", "$ref" : "#/definitions/UserProfileFlag" } } }, "UserProfileFlag" : { "type" : "string", "enum" : [ "OPTIONAL", "FIX", "RECURSE", "HIDDEN", "PARENT_FIX" ] }, "UserProfileView" : { "type" : "object", "required" : [ "flag", "key", "value" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "owner" : { "description" : "The object owner.", "$ref" : "#/definitions/User" }, "updater" : { "description" : "User who performed the last update.", "$ref" : "#/definitions/User" }, "key" : { "type" : "string", "example" : "techc", "description" : "The user profile key." }, "value" : { "type" : "string", "example" : "12345", "description" : "The value of the key." }, "flag" : { "example" : "FIX", "description" : "Defines to what extent the settings of a user are adopted by its subusers.", "$ref" : "#/definitions/UserProfileFlag" }, "inherited" : { "type" : "boolean", "description" : "Indicates whether the value is inherited.\n\nfalse = value is not inherited\ntrue = value is inherited\nDefault value = false" }, "readonly" : { "type" : "boolean", "description" : "Flag whether the value is changeable by the current user.\n\nPossible values:\n\nfalse = Not changeable\ntrue = Changeable\nDefault value = false" } } }, "UserProfileViews" : { "type" : "object", "properties" : { "profiles" : { "type" : "array", "items" : { "$ref" : "#/definitions/UserProfileView" } } } }, "UserSalesReport" : { "type" : "object", "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "owner" : { "description" : "The object owner.", "$ref" : "#/definitions/User" }, "updater" : { "description" : "User who performed the last update.", "$ref" : "#/definitions/User" }, "date" : { "type" : "string", "format" : "date-time", "description" : "The report date." }, "domainSales" : { "type" : "number", "format" : "double", "description" : "The domain sales." }, "domainAddonSales" : { "type" : "number", "format" : "double", "description" : "The domain addon sales" }, "certificateSales" : { "type" : "number", "format" : "double", "description" : "The certificate sales." }, "serverSales" : { "type" : "number", "format" : "double", "description" : "The server sales." }, "packageSales" : { "type" : "number", "format" : "double", "description" : "The package sales" } } }, "VirtualNameServer" : { "type" : "object", "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "owner" : { "description" : "The object owner.", "$ref" : "#/definitions/User" }, "updater" : { "description" : "User who performed the last update.", "$ref" : "#/definitions/User" }, "active" : { "type" : "boolean", "example" : false, "description" : "Indicates whether the name server is in active use" }, "name" : { "description" : "Host name of the nameserver.", "$ref" : "#/definitions/Name" }, "mainAddress" : { "description" : "Primary IP address of the name server.", "$ref" : "#/definitions/InetAddress" }, "ipAddresses" : { "type" : "array", "description" : "IP addresses of the secondary name servers. Does not contain the primary IP address.", "items" : { "type" : "string" } } } }, "VirtualNameServerGroup" : { "type" : "object", "required" : [ "systemNameServerGroup" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "owner" : { "description" : "The object owner.", "$ref" : "#/definitions/User" }, "updater" : { "description" : "User who performed the last update.", "$ref" : "#/definitions/User" }, "name" : { "type" : "string", "description" : "Custom name of the name server group.", "pattern" : "\\b(?!default\\b)\\w+" }, "useDefaultIps" : { "type" : "boolean", "example" : false, "description" : "Use default ip addresses. Default value = false" }, "nameServers" : { "type" : "array", "description" : "The nameservers that belong to the group.", "items" : { "$ref" : "#/definitions/VirtualNameServer" } }, "id" : { "type" : "integer", "format" : "int32", "description" : "The unique id of the nsVirtualGroup" }, "systemNameServerGroup" : { "description" : "The group of physical name servers responsible for this virtual name server group.", "$ref" : "#/definitions/PhysicalNameServerGroup" } } }, "VmcCheckData" : { "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "The common name." }, "subjectAlternativeNames" : { "type" : "array", "description" : "The subject alternative names, listed in the csr.", "items" : { "$ref" : "#/definitions/SubjectAlternativeName" } }, "vmcLogo" : { "type" : "string", "description" : "The base64 encoded SVG logo" }, "product" : { "type" : "string", "description" : "The ssl product." } } }, "VmcTrademarkCountryOrRegion" : { "type" : "string", "enum" : [ "AU", "BR", "BX", "CA", "CH", "DE", "DK", "EM", "ES", "FR", "GB", "IN", "JP", "KR", "NZ", "SE", "US" ] }, "Void" : { "type" : "object" }, "WhoisServiceData" : { "type" : "object", "properties" : { "debugTime" : { "type" : "integer", "format" : "int64", "description" : "The debug time" }, "status" : { "description" : "The status", "$ref" : "#/definitions/DomainStudioServiceStatus" }, "message" : { "type" : "string", "description" : "A message with more information, if the status is FAILED." }, "data" : { "description" : "The service data", "$ref" : "#/definitions/WhoisStatus" } } }, "WhoisStatus" : { "type" : "object", "properties" : { "status" : { "description" : "The whois status", "readOnly" : true, "$ref" : "#/definitions/DomainStudioDomainStatus" }, "priceClass" : { "type" : "string", "description" : "The price class for premium domains" } } }, "WorkflowEvent" : { "type" : "object", "properties" : { "jobId" : { "type" : "integer", "format" : "int64", "description" : "Job id" }, "vertex" : { "type" : "integer", "format" : "int32", "description" : "Vertex" }, "ctid" : { "type" : "string", "description" : "Client Transaction ID" }, "object" : { "type" : "string", "description" : "Object for which the job was created. (e.g. domain)" }, "type" : { "type" : "string", "description" : "Type of Event" }, "subtype" : { "type" : "string", "description" : "Subtype of the event to specify the event type (e.g . DONUTS-PSIUSA_toys)" } } }, "X509CertificateData" : { "type" : "object", "properties" : { "cn" : { "type" : "string", "description" : "The common name" }, "serialNumber" : { "type" : "string", "description" : "The serial number of the certificate" }, "issuer" : { "description" : "The issuer information of the certificate", "$ref" : "#/definitions/X509CertificateIssuer" }, "subject" : { "description" : "The subject information of the certificate", "$ref" : "#/definitions/X509CertificateSubject" }, "validity" : { "description" : "The validity of the certificate", "$ref" : "#/definitions/X509CertificateValidity" }, "subjectAlternativNames" : { "type" : "array", "description" : "The subject alternativ names covered by this certificate", "items" : { "type" : "string" } }, "plain" : { "type" : "string", "description" : "The plain certificate pem string, that was used to decode." }, "signatureAlgorithm" : { "type" : "string", "description" : "The signatureAlgorithm of the certificate." }, "sha1Thumbprint" : { "type" : "string", "description" : "The SHA-1 thumbprint for the certificate." }, "sha256Thumbprint" : { "type" : "string", "description" : "The SHA-256 thumbprint for the certificate." }, "md5Thumbprint" : { "type" : "string", "description" : "The MD5 thumbprint for the certificate." }, "publicKeyData" : { "description" : "The public key data from the certificate.", "$ref" : "#/definitions/X509CertificatePublicKeyData" } } }, "X509CertificateIssuer" : { "type" : "object", "properties" : { "commonName" : { "type" : "string", "description" : "The CN attribute of the issuer" }, "organization" : { "type" : "string", "description" : "The O attribute of the issuer" }, "country" : { "type" : "string", "description" : "The C attribute of the issuer" }, "organizationUnit" : { "type" : "string", "description" : "The OU attribute of the issuer" }, "locality" : { "type" : "string", "description" : "The L attribute of the issuer" }, "state" : { "type" : "string", "description" : "The ST attribute of the issuer" } } }, "X509CertificatePublicKeyData" : { "type" : "object", "properties" : { "algorithm" : { "type" : "string", "description" : "The algorithm of the public key" }, "length" : { "type" : "integer", "format" : "int32", "description" : "The key length of the public key" }, "sha1Thumbprint" : { "type" : "string", "description" : "The SHA-1 thumbprint of the public key" }, "sha256Thumbprint" : { "type" : "string", "description" : "The SHA-256 thumbprint of the public key" }, "bytes" : { "type" : "string", "description" : "The bytes representing the public key as Stringe" } } }, "X509CertificateSubject" : { "type" : "object", "properties" : { "commonName" : { "type" : "string", "description" : "The CN attribute of the subject" }, "organization" : { "type" : "string", "description" : "The O attribute of the subject" }, "country" : { "type" : "string", "description" : "The C attribute of the subject" }, "organizationUnit" : { "type" : "string", "description" : "The OU attribute of the subject" }, "locality" : { "type" : "string", "description" : "The L attribute of the subject" }, "state" : { "type" : "string", "description" : "The ST attribute of the subject" } } }, "X509CertificateValidity" : { "type" : "object", "properties" : { "notAfter" : { "type" : "string", "format" : "date-time", "description" : "The notAfter date of the certificate" }, "notBefore" : { "type" : "string", "format" : "date-time", "description" : "The notBefore date of the certificate" } } }, "Zone" : { "type" : "object", "required" : [ "origin" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "origin" : { "type" : "string", "description" : "Zone name" }, "idn" : { "type" : "string", "description" : "Punycode version of the origin." }, "soa" : { "description" : "Only for ns_action: \"primary\" and \"complete\"", "$ref" : "#/definitions/Soa" }, "dnssec" : { "type" : "boolean", "description" : "If true dnssec signing for the zone is active." }, "nameServerGroup" : { "type" : "string", "description" : "Name of the nameserver group." }, "allowTransfer" : { "type" : "boolean", "description" : "Allow zone transfer for the defined zone grants" }, "owner" : { "description" : "Owner of the zone object", "$ref" : "#/definitions/User" }, "updater" : { "description" : "User who last updated the zone.", "$ref" : "#/definitions/User" }, "logId" : { "type" : "integer", "format" : "int64", "description" : "The id of the related log-entry." }, "comment" : { "type" : "string", "description" : "A custom field. Can only be updated via PUT /zone/{name}/{nameserver}/_comment. Requires appropriate ACLs." }, "domainsafe" : { "type" : "boolean", "description" : "Denotes of the zone is present in the DomainSafe service." }, "source" : { "type" : "string", "description" : "Name server from which a zone is copied via AXFR (with zone_import)." }, "sourceVirtualHostname" : { "type" : "string", "description" : "System name server to look up the zone to copy" }, "purgeDate" : { "type" : "string", "format" : "date-time", "description" : "Date on which the zone is purged (removed) from the system." }, "purgeType" : { "description" : "Setting for automatic zone deletion.", "$ref" : "#/definitions/PurgeTypes" }, "nameServers" : { "type" : "array", "description" : "List of hostnames to be used as name severs.", "items" : { "$ref" : "#/definitions/NameServer" } }, "main" : { "description" : "Main IP address of the zone. Required for ns_action \"primary\" and \"complete\".", "$ref" : "#/definitions/MainIp" }, "wwwInclude" : { "type" : "boolean", "description" : "Create a www A-record automatically?\n\nfalse = no\ntrue = yes\n\n\nDefault = true\n\n\nFor XML, 0 (false) and 1 (true) can also be used." }, "virtualNameServer" : { "type" : "string", "description" : "The first nameserver managed by the system" }, "freeText" : { "type" : "array", "description" : "Freely definable resource records to be entered in BIND Syntax.", "items" : { "type" : "string" } }, "action" : { "description" : "Additional nameserver check is proceeded.", "$ref" : "#/definitions/NameserverActionConstants" }, "grants" : { "type" : "array", "description" : "A list of IP addresses from which a zone transfer (AXFR) by be started from for this zone.", "items" : { "type" : "string" } }, "resourceRecords" : { "type" : "array", "description" : "The resource records.", "items" : { "$ref" : "#/definitions/ResourceRecord" }, "maxItems" : 10000, "minItems" : 0 }, "roid" : { "type" : "integer", "format" : "int32", "example" : 1, "description" : "The resource object identifier of the zone." } } }, "ZoneBasePatchRequest" : { "type" : "object", "required" : [ "origin" ], "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "origin" : { "type" : "string", "description" : "Zone name" }, "idn" : { "type" : "string", "description" : "Punycode version of the origin." }, "soa" : { "description" : "Only for ns_action: \"primary\" and \"complete\"", "$ref" : "#/definitions/Soa" }, "dnssec" : { "type" : "boolean", "description" : "If true dnssec signing for the zone is active." }, "nameServerGroup" : { "type" : "string", "description" : "Name of the nameserver group." }, "allowTransfer" : { "type" : "boolean", "description" : "Allow zone transfer for the defined zone grants" }, "owner" : { "description" : "Owner of the zone object", "$ref" : "#/definitions/User" }, "updater" : { "description" : "User who last updated the zone.", "$ref" : "#/definitions/User" }, "logId" : { "type" : "integer", "format" : "int64", "description" : "The id of the related log-entry." }, "comment" : { "type" : "string", "description" : "A custom field. Can only be updated via PUT /zone/{name}/{nameserver}/_comment. Requires appropriate ACLs." }, "domainsafe" : { "type" : "boolean", "description" : "Denotes of the zone is present in the DomainSafe service." }, "source" : { "type" : "string", "description" : "Name server from which a zone is copied via AXFR (with zone_import)." }, "sourceVirtualHostname" : { "type" : "string", "description" : "System name server to look up the zone to copy" }, "purgeDate" : { "type" : "string", "format" : "date-time", "description" : "Date on which the zone is purged (removed) from the system." }, "purgeType" : { "description" : "Setting for automatic zone deletion.", "$ref" : "#/definitions/PurgeTypes" }, "zoneGrantsAdd" : { "type" : "array", "description" : "Adds new zone garnts to the zone", "items" : { "type" : "string" } }, "zoneGrantsRem" : { "type" : "array", "description" : "Removes the zone garnts if exists.", "items" : { "type" : "string" } }, "modifiers" : { "type" : "array", "description" : "The modifer to apply on the objects", "items" : { "$ref" : "#/definitions/Modifier" } }, "nameServers" : { "type" : "array", "description" : "List of hostnames to be used as name severs.", "items" : { "$ref" : "#/definitions/NameServer" } }, "main" : { "description" : "Main IP address of the zone. Required for ns_action \"primary\" and \"complete\".", "$ref" : "#/definitions/MainIp" }, "wwwInclude" : { "type" : "boolean", "description" : "Create a www A-record automatically?\n\nfalse = no\ntrue = yes\n\n\nDefault = true\n\n\nFor XML, 0 (false) and 1 (true) can also be used." }, "virtualNameServer" : { "type" : "string", "description" : "The first nameserver managed by the system" }, "freeText" : { "type" : "array", "description" : "Freely definable resource records to be entered in BIND Syntax.", "items" : { "type" : "string" } }, "action" : { "description" : "Additional nameserver check is proceeded.", "$ref" : "#/definitions/NameserverActionConstants" }, "grants" : { "type" : "array", "description" : "A list of IP addresses from which a zone transfer (AXFR) by be started from for this zone.", "items" : { "type" : "string" } }, "resourceRecords" : { "type" : "array", "description" : "The resource records.", "items" : { "$ref" : "#/definitions/ResourceRecord" }, "maxItems" : 10000, "minItems" : 0 }, "roid" : { "type" : "integer", "format" : "int32", "example" : 1, "description" : "The resource object identifier of the zone." }, "resourceRecordsAdd" : { "type" : "array", "description" : "Adds new zone records to the extistings", "items" : { "$ref" : "#/definitions/ResourceRecord" } }, "resourceRecordsRem" : { "type" : "array", "description" : "Removes the zone records if exists.", "items" : { "$ref" : "#/definitions/ResourceRecord" } } } }, "ZoneQuery" : { "type" : "object", "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "date" : { "type" : "string", "format" : "date-time", "description" : "the date" }, "count" : { "type" : "integer", "format" : "int32", "description" : "the count" }, "unit" : { "description" : "the Unit", "$ref" : "#/definitions/TimeUnitConstants" }, "zone" : { "description" : "the zone", "$ref" : "#/definitions/Zone" }, "physicalHostname" : { "type" : "string", "description" : "The physicalHostname by the system" }, "virtualNameServer" : { "type" : "string", "description" : "The first nameserver managed by the system" } } }, "ZoneStream" : { "type" : "object", "properties" : { "adds" : { "type" : "array", "description" : "the records to add.", "items" : { "$ref" : "#/definitions/ResourceRecord" } }, "rems" : { "type" : "array", "description" : "the records to remove.", "items" : { "$ref" : "#/definitions/ResourceRecord" } } } }, "accountManager" : { "type" : "object", "properties" : { "created" : { "type" : "string", "format" : "date-time", "description" : "Date of creation." }, "updated" : { "type" : "string", "format" : "date-time", "description" : "Date of the last update." }, "owner" : { "description" : "The object owner.", "$ref" : "#/definitions/User" }, "updater" : { "description" : "User who performed the last update.", "$ref" : "#/definitions/User" }, "id" : { "type" : "integer", "format" : "int32" }, "name" : { "type" : "string" }, "phone" : { "$ref" : "#/definitions/Phone" }, "email" : { "type" : "string" } } } } }