SecuritySpace

About | API Guide | API Key | JavaScript Example | PHP CLI Example

REST API Guide

Table of Contents

HTTP Service calls
JSON (JavaScript Object Notation) Data Format
API Error Indicators

Authentication (auth.php)
Security Audits: Get Audit List (saGetAuditList.php)
Security Audits: Get Audit Report (saGetAuditReport.php)
Security Audits: Run Audit (saRunAudit.php)
DNS: Get Domain List (dnsGetDomainList.php)
DNS: Get Domain (dnsGetDomainRecords.php)
DNS: Add Domain (dnsAddDomain.php)
DNS: Delete Domain (dnsDeleteDomain.php)
DNS: Delete Record (dnsDeleteRecord.php)
DNS: Add A Record (dnsAddA.php)
DNS: Add AAAA Record (dnsAddAAAA.php)
DNS: Add CNAME Record (dnsAddCNAME.php)
DNS: Add MX Record (dnsAddMX.php)
DNS: Add NS Record (dnsAddNS.php)
DNS: Add CAA Record (dnsAddCAA.php)
DNS: Add TXT Record (dnsAddTXT.php)
DNS: Add SRV Record (dnsAddSRV.php)
DNS: Set SOA Record values (dnsSetSOA.php)
DNS: Set Options (dnsSetOptions.php)
DNS: Validate and Publish Zone (dnsPublish.php)
DNS: Build Zone File (dnsBuildZone.php)

Introduction

Technology

HTTP Service calls

Access to security space API services is done exclusively over HTTP POST requests, running over an SSL protocol. Responses are received in JSON. A sample transaction is shown below.

HTTP Request

POST /api/auth.php HTTP/1.0
Host: secure1.securityspace.com
Content-Length: 78
Content-type: application/x-www-form-urlencoded

apikey=WjN5ZkVoWm9KS2FvaHVGbE5VQ2loeHdP&userid=youruseridpassword=yourpassword

HTTP Response

HTTP/1.1 200 OK
Date: Mon, 17 Nov 2014 22:07:24 GMT
Server: Apache
X-Powered-By: PHP/5.4.4-14+deb7u14
Cache-Control: no-cache, must-revalidate
Expires: Mon, 17 Nov 2014 17:07:24 EST
Content-Length: 814
Connection: close
Content-Type: application/json

{ "status": "0", "sessionToken": "VhvF93vCXKScVlxdh2332343j4oFdXC8R7lkF3FX ...<snipped for brevity>"}

JSON (JavaScript Object Notation) Data Format

APIs return information in JSON. JSON's advantages are:

Low overhead (efficient data transfer)
Human readable
Support in a large number of languages (check here)

An example of a JSON data response would be
{ "status": "0", "sessionToken": "VhvF93vCXKScVlxdh2332343j4oFdXC8R7lkF3FX ...<snipped for brevity>" }

API Error Indicators

All responses to SecuritySpace APIs will contain a "status" field, which will have a value of "0" if the request was successful, or a non-zero value on error. When there is an error, a static error response will be returned consisting of the status field and an "error" field, with the error field containing an error message indicating the reason for the failure.

An example of a successful JSON data response would be
{ "status": "0", "sessionToken": "VhvF93vCXKScVlxdh2332343j4oFdXC8R7lkF3FX ...<snipped for brevity>" }

An example of an error response is:
{ "status": "-1", "error": "invalidLogin" }

APIs

Authentication (auth.php)

Description	Authenticate to your SecuritySpace account and get back a session token that can be used in all APIs accessing/manipulating your account information. Returned tokens are valid for 24 hours, after which they expire and a new token must be requested.
URL	https://secure1.securityspace.com/api/auth.php
Prerequisites	Valid API key, active account
Input	apikey	Your SecuritySpace api key
	userid	Your SecuritySpace account userid
	password	Your SecuritySpace account password
Success Response Schema	{ "required": true, "type": "object" , "properties": { "status" : { "required": true, "type": "number" }, "sessionToken" : { "required": true, "type": "string" } } }
Errors	notSSL	API must be invoked via an SSL connection
	invalid apikey format	Not a valid API key
	invalid apikey - not in db	API key not in DB
	missing credentials	Input parameters missing userid and/or password
	invalidLogin	Login incorrect - wronger userid/password combination
	sysErrEntitlementLoad	System Error - unable to load account entitlements
	tokenCreation	System Error - unable to create token
	sysErrdoLogin	System Error - unspecified error returned from authentication request

Security Audit - Get Audit List (saGetAuditList.php)

Description	Retrieve the list of audit reports in your account, along with some basic audit information
URL	https://secure1.securityspace.com/api/saGetAuditList.php
Prerequisites	Valid API key, valid session token
Input	apikey	Your SecuritySpace api key
Input	sessionToken	A valid session token returned from auth.php
Success Response Schema	{ "required": true, "type": "object", "properties": { "status" : { "required": true, "type": "number" }, "scancount" : { "required": true, "type": "number" }, "scans" : { "required": false, "type": "array" , "items": { "required": true, "type": "object" , "properties": { "scanuid" : { "required": true, "type": "string" }, "folder" : { "required": true, "type": "string" }, "hostip" : { "required": true, "type": "string" }, "time_end" : { "required": true, "type": "string" }, "time_queued" : { "required": true, "type": "string" }, "time_start" : { "required": true, "type": "string" }, "type" : { "required": true, "type": "string" } } } } } }
Errors	notSSL	API must be invoked via an SSL connection
	invalid apikey format	Not a valid API key
	invalid apikey - not in db	API key not in DB
	sessionTimeout	the session token has expired
	sessionAuthenticationFailure	the session token is not valid

Security Audit - Get Audit Report (saGetAuditReport.php)

Description	Retrieve the specified audit report
URL	https://secure1.securityspace.com/api/saGetAuditReport.php
Prerequisites	Valid API key, valid session token
Input	apikey	Your SecuritySpace api key
	sessionToken	A valid session token returned from auth.php
	scanuid	A valid scan identifier
Success Response Schema	{ "required": true, "type": "object" , "properties": { "status" : { "required": true, "type": "number" }, "scaninfo" : { "required": true, "type": "object" , "properties": { "basic" : { "required": true, "type": "object" , "properties": { "detail_supplement" : { "required": true, "type": "number" }, "ejtime" : { "required": true, "type": "string" }, "hostip" : { "required": true, "type": "string" }, "merge" : { "required": true, "type": "number" }, "mergelist" : { "required": true, "type": "string" }, "promocode" : { "required": true, "type": "string" }, "qjtime" : { "required": true, "type": "number" }, "reporttype" : { "required": true, "type": "string" }, "scanattr" : { "required": true, "type": "string" }, "scanportstcp" : { "required": true, "type": "string" }, "scantype" : { "required": true, "type": "string" }, "scanuid" : { "required": true, "type": "number" }, "sjtime" : { "required": true, "type": "number" }, "title" : { "required": true, "type": "string" }, "totalnaslentries" : { "required": true, "type": "number" } } }, "entries" : { "required": false, "type": "object" , "properties": { "<high\|medium\|low\|other>" : { //test results organized by risk groups "required": false, "type": "object" , "properties": { "<scanuid_sequence#>" : {// E.g. Property name of 1100005104_58 "required": true, "type": "object" , "properties": { // Which report this came from (required for merged view) "repid" : { "required": true, "type": "string" }, // The test ID (full ID) "id" : { "required": true, "type": "string" }, // The short form test ID "shortid" : { "required": true, "type": "string" }, // IP address of the host "ip" : { "required": true, "type": "string" }, // Port# on which this is applicable "port" : { "required": true, "type": "string" }, // Category of this test "cat" : { "required": true, "type": "string" }, // Any CVE identifiers (CSV) "cve" : { "required": true, "type": "string" }, // The unique entry key (e.g. 1100005104_58) "entrykey" : { "required": true, "type": "string" }, // The risk level (one of high,medium,low,other) "risk" : { "required": true, "type": "string" }, // The short entry key (sequence # - e.g. 58) "shortkey" : { "required": true, "type": "number" }, // The static test description "static_description" : { "required": true, "type": "string" }, // The full test description, including dynamically // generated elements "description" : { "required": true, "type": "string" }, "title" : { "required": true, "type": "string" }, // Type of test entry report (LOG,NOTE,HOLE) "type" : { "required": true, "type": "string" } // Baseline assessment results "baseline" : { "required": true, "type": "string" }, } } } } } }, "ports" : { // Report the open ports that were found. "required": true, "type": "array" , "items": { "required": true, "type": "object" , "properties": { // Which report this item belonged to (useful only for merged views) "repid" : { "required": true, "type": "string" } "hostip" : { "required": true, "type": "string" }, // first port in range "portend" : { "required": true, "type": "number" }, // last port in range, -1 if not a range "portnum" : { "required": true, "type": "string" }, // Protocol (TCP/UDP) "portprot" : { "required": true, "type": "string" }, // Name of service typically residing on this port "portservice" : { "required": true, "type": "string" }, } } }, "risk" : { // The number of vulnerabilities at each risk level "required": true, "type": "object" , "properties": { "high" : { "required": false, "type": "number" }, "low" : { "required": false, "type": "number" }, "medium" : { "required": false, "type": "number" }, "other" : { "required": false, "type": "number" } } }, "riskcatgrid" : { "required": true, "type": "object" , "properties": { // Multiple entries, with property name consisting of the // the test category:risk level. E.g. "RPC:other" "<category:risk>" : { "required": false, "type": "number" }, } } } } } }
Errors	notSSL	API must be invoked via an SSL connection
	invalid apikey format	Not a valid API key
	invalid apikey - not in db	API key not in DB
	sessionTimeout	the session token has expired
	sessionAuthenticationFailure	the session token is not valid
	reportLoadFailure[<code>]	report failed to load

Security Audit - Run Audit (saRunAudit.php)

Description	Run a security audit against an IP address or a range of addresses.
URL	https://secure1.securityspace.com/api/saRunAudit.php
Prerequisites	Valid API key, active account
Input	apikey	Your SecuritySpace api key
	sessionToken	A valid session token returned from auth.php
	ipaddr	Optional:IP address(es) of the host(s) to be audited. Wild cards () and hyphens for ranges may be employed on any portion of an IP address, and multiple comma separated values may be specified. E.g. "192.168.1.,10.1.1-2.32-63" would request an audit of all 256 addreesses in the 192.168.1.0/24 range, as well as another 2 /27 ranges of 10.1.1.32/27 and 10.1.2.32/27. If not specified, will default to the detected IP address of the client making the request.
	audittype	Must be specified as one of { advanced, standard, norisk, desktop, basic }
	excludedos	Optional:If set (to any value), the audit will exclude tests in the denial of service category. Otherwise, all tests will be run.
	notification	Optional:Set to OCMP to receive an on completion notification email that the audit has finished running. Defaults to not sending any notification.
Success Response Schema	{ "required": true, "type": "object" , "properties": { "status" : { "required": true, "type": "number" }, } }
Errors	notSSL	API must be invoked via an SSL connection
	invalid apikey format	Not a valid API key
	invalid apikey - not in db	API key not in DB
	sessionTimeout	the session token has expired
	sessionAuthenticationFailure	the session token is not valid
	missingAuditType	The audit type was not specified.
	invalidAuditType	An invalid audit type was specified
	IPPermissionsProblem	User doesn't have permissions on this account to audit one or more addresses in the audit request. Full request has been rejected.
	missingScanClientsRec	An internal system error.
	notEntitled	A request was made to run an audit for which the user has not subscribed.
	noriskAlreadyRun	A limit of one no risk audit per IP address per month is enforced. This is a second request, and has been rejected.

DNS: Get Domain List (dnsGetDomainList.php)

Description	Retrieve the list of domains managed in your account
URL	https://secure1.securityspace.com/api/dnsGetDomainList.php
Prerequisites	Valid API key, valid session token, valid DNS subscription
Input	apikey	Your SecuritySpace api key
Input	sessionToken	A valid session token returned from auth.php
Success Response Schema	{ "required": true, "type": "object", "properties": { "status" : { "required": true, "type": "number" }, // Number of domains in this account "domaincount" : { "required": true, "type": "number" }, // Total "credit" weight of all domains "domainweight" : { "required": true, "type": "number" }, // subscription expiry julian timestamp (seconds since 1970) "expiryjtime" : { "required": true, "type": "number" }, // subscription expiry human readable "expiryreadable" : { "required": true, "type": "string" }, "domains" : { "required": false, "type": "object" , "properties": { // A unique sequence number for this domain. : { "required": true, "type": "object" , "properties": { // The domain name. "domain" : { "required": true, "type": "string" }, // The unique sequence number of this domain (same as above sequence number) "seq" : { "required": true, "type": "number" }, // The credit weight of the domain (1 without any web forwarding, 2 with web forwarding) "weight" : { "required": true, "type": "number" }, // The state of the domain. // state 0: "Unvalidated" // state 1: "Configuration Errors" // state 2: "Waiting for distribution to name servers" // state 3: "Active" "state" : { "required": true, "type": "number" }, "stateText" : { "required": true, "type": "string" }, } } } } } }
Errors	notSSL	API must be invoked via an SSL connection
	dbConnectionFailure	Failed to connect to the database
	invalid apikey format	Not a valid API key
	invalid apikey - not in db	API key not in DB
	sessionTimeout	the session token has expired
	sessionAuthenticationFailure	the session token is not valid
	dnsEntitlementsOrCreditsMissing	Your subscription has expired, or your credits have all been used up
	dnsDomainRetrievalFailure	A system error occurred retrieving your domain information. Try again later

DNS: Get Domain Records (dnsGetDomainRecords.php)

Description	Retrieve all records associated with a domain
URL	https://secure1.securityspace.com/api/dnsGetDomainRecords.php
Prerequisites	Valid API key, valid session token, valid DNS subscription
Input	apikey	Your SecuritySpace api key
	sessionToken	A valid session token returned from auth.php
	domain	The domain name
Success Response Schema	{ "required": true, "type": "object", "properties": { "status" : { "required": true, "type": "number" }, "domain" : { "required": true, "type": "string" }, // The state of the domain. // state 0: "Unvalidated" // state 1: "Configuration Errors" // state 2: "Waiting for distribution to name servers" // state 3: "Active" "state" : { "required": true, "type": "number" }, "stateText" : { "required": true, "type": "string" }, "records" : { "required": true, "type": "object" , "properties": { // A unique sequence number for this record. Deletion requests must provide this seq # <seq>: { "required": true, "type": "object" , "properties": { // The record type. Possible values: SOA, NS, MX A, AAAA, CNAME, TXT, SRV, Options, WebForwarding "seq" : { "required": true, "type": "string" }, // unique record identifier "type" : { "required": true, "type": "string" }, // The unique sequence number of this domain (same as above sequence number) "data" : { "required": true, "type": "object" , "properties": { // Values returned are dependent on the type as follows: // NS/A/AAAA/CNAME/TXT values: "name" : { "required": true, "type": "string" }, "data" : { "required": true, "type": "string" } // MX values "pri" : { "required": true, "type": "number" }, //priority "host" : { "required": true, "type": "string" }, // aka subdomain, usually blank "data" : { "required": true, "type": "string" } // the mail server name // CAA values "name" : { "required": true, "type": "string" }, // aka subdomain, usually blank "flag" : { "required": true, "type": "number" }, // CAA flag value "tag" : { "required": true, "type": "string" } // CAA tag (one of issue, issuewild, iodef) "caaval" : { "required": true, "type": "string" } // the issuer value // SOA values "priNS" : { "required": true, "type": "string" }, "mail" : { "required": true, "type": "string" }, //admin contact "refresh" : { "required": true, "type": "number" }, "retry" : { "required": true, "type": "number" }, "exp" : { "required": true, "type": "number" }, "min" : { "required": true, "type": "number" } // minTTL // SRV values "srvc" : { "required": true, "type": "string" }, "prot" : { "required": true, "type": "string" }, "host" : { "required": true, "type": "string" }, "pri" : { "required": true, "type": "number" }, "weight" : { "required": true, "type": "number" }, "port" : { "required": true, "type": "number" }, "target" : { "required": true, "type": "string" } // Option values // See https://secure1.securityspace.com/dns/help-allowtransfer.html "allowtransferacl" : { "required": true, "type": "string" }, // See https://secure1.securityspace.com/dns/help-notify.html "notify" : { "required": true, "type": "string" } // See https://secure1.securityspace.com/dns/help-alsonotify.html "alsonotify" : { "required": true, "type": "string" } // WebForwarding values "host" : { "required": true, "type": "string" }, "target" : { "required": true, "type": "string" }, "cloak" : { "required": true, "type": "number" } } } } } } } } }
Errors	notSSL	API must be invoked via an SSL connection
	dbConnectionFailure	Failed to connect to the database
	invalid apikey format	Not a valid API key
	invalid apikey - not in db	API key not in DB
	sessionTimeout	the session token has expired
	sessionAuthenticationFailure	the session token is not valid
	dnsEntitlementsOrCreditsMissing	Your subscription has expired, or your credits have all been used up
	dnsDomainRetrievalFailure	A system error occurred retrieving your domain information. Try again later
	noSuchDomain	The requested domain does not exist in your account.

DNS: Add Domain (dnsAddDomain.php)

Description	Add a domain to your account. When a domain is added, a default set of NS records are added, along with a default SOA record. The NS records point to ns1 through ns4 (.securityspace.net), and the SOA record notably has a minTTL value of 1 day (86400 seconds). The domain is left in the "Unvalidated" state - it does not get moved to name servers until you publish the domain.
URL	https://secure1.securityspace.com/api/dnsAddDomain.php
Prerequisites	Valid API key, valid session token, valid DNS subscription
Input	apikey	Your SecuritySpace api key
	sessionToken	A valid session token returned from auth.php
	domain	The domain name to add
	domaintype	The type of domain (must be either 'master' or 'slave')
	aup	The Acceptable Use Policy (AUP) is accepted (must pass a value of 'YES'; see the DNS AUP)
Success Response Schema	{ "required": true, "type": "object", "properties": { "status" : { "required": true, "type": "number" }, } }
Errors	notSSL	API must be invoked via an SSL connection
	dbConnectionFailure	Failed to connect to the database
	invalid apikey format	Not a valid API key
	invalid apikey - not in db	API key not in DB
	sessionTimeout	the session token has expired
	sessionAuthenticationFailure	the session token is not valid
	dnsEntitlementsOrCreditsMissing	Your subscription has expired, or your credits have all been used up
	mustAcceptAUP	The AUP was not accepted. Accept the AUP by passing an 'aup' value of "YES" via the request
	syntaxInvalidDomain	The domain provided is not a valid domain name
	syntaxInvalidDomainType	The domain provided is not valid. Must be 'master' or 'slave'
	unableToAddSystem	A system error occurred trying to add the domain.
	unspecifiedError	An unspecified system error occurred trying to add the domain.
	unableToAddDuplicate	The domain could not be added - it appears to already be in this account.

DNS: Delete Domain (dnsDeleteDomain.php)

Description	Delete a domain from your account. Once a domain deletion request is successfully submitted, it cannot be undone. The deletion from name servers is queued up, and will be processed within 5 minutes. Until that time, name servers will continue to service DNS requests for the domain.
URL	https://secure1.securityspace.com/api/dnsDeleteDomain.php
Prerequisites	Valid API key, valid session token, valid DNS subscription
Input	apikey	Your SecuritySpace api key
	sessionToken	A valid session token returned from auth.php
	domain	The domain name to delete
Success Response Schema	{ "required": true, "type": "object", "properties": { "status" : { "required": true, "type": "number" }, // Number of domains left in this account "domaincount" : { "required": true, "type": "number" }, // Total "credit" weight of all domains "domainweight" : { "required": true, "type": "number" }, // subscription expiry julian timestamp (seconds since 1970) "expiryjtime" : { "required": true, "type": "number" }, // subscription expiry human readable "expiryreadable" : { "required": true, "type": "string" }, } }
Errors	notSSL	API must be invoked via an SSL connection
	dbConnectionFailure	Failed to connect to the database
	invalid apikey format	Not a valid API key
	invalid apikey - not in db	API key not in DB
	sessionTimeout	the session token has expired
	sessionAuthenticationFailure	the session token is not valid
	dnsEntitlementsOrCreditsMissing	Your subscription has expired, or your credits have all been used up
	syntaxInvalidDomain	The domain provided is not a valid domain name
	domainNotDeleted	The domain was not deleted. Probably because the domain is not under this account.
	unspecifiedError	A system error occurred trying to delete the domain.

DNS: Delete Record (dnsDeleteRecord.php)

Description	Delete a DNS record from your a domain. Doing so will place the domain in an unvalidated state. It will stay in that state, until you issue a Publish request.
URL	https://secure1.securityspace.com/api/dnsDeleteRecord.php
Prerequisites	Valid API key, valid session token, valid DNS subscription
Input	apikey	Your SecuritySpace api key
	sessionToken	A valid session token returned from auth.php
	seq	The record sequence identifier
Success Response Schema	{ "required": true, "type": "object", "properties": { "status" : { "required": true, "type": "number" }, } }
Errors	notSSL	API must be invoked via an SSL connection
	dbConnectionFailure	Failed to connect to the database
	invalid apikey format	Not a valid API key
	invalid apikey - not in db	API key not in DB
	sessionTimeout	the session token has expired
	sessionAuthenticationFailure	the session token is not valid
	dnsEntitlementsOrCreditsMissing	Your subscription has expired, or your credits have all been used up
	syntaxInvalidSeq	The sequence number provided is not valid
	recordNotDeleted	The record was not deleted. Probable cause is an invalid sequence number.

DNS: Add A Record (dnsAddA.php)

Description	Add an A record to a domain. Doing so will place the domain in an unvalidated state. It will stay in that state, until you issue a Publish request.
URL	https://secure1.securityspace.com/api/dnsAddA.php
Prerequisites	Valid API key, valid session token, valid DNS subscription
Input	apikey	Your SecuritySpace api key
	sessionToken	A valid session token returned from auth.php
	domain	The domain to which a record is added
	name	The hostname. It may be blank (the base domain will resolve to an IP), a hostname, or an asterisk (wildcard - anything resolves to this IP unless otherwise explicitly specified).
	ip	The IP address the hostname should resolve to.
Success Response Schema	{ "required": true, "type": "object", "properties": { "status" : { "required": true, "type": "number" }, } }
Errors	notSSL	API must be invoked via an SSL connection
	dbConnectionFailure	Failed to connect to the database
	invalid apikey format	Not a valid API key
	invalid apikey - not in db	API key not in DB
	sessionTimeout	the session token has expired
	sessionAuthenticationFailure	the session token is not valid
	dnsEntitlementsOrCreditsMissing	Your subscription has expired, or your credits have all been used up
	syntaxInvalidDomain	The domain provided is not valid.
	syntaxInvalidHostname	The hostname is not valid.
	syntaxInvalidIP	The IP address is not valid.
	noSuchDomain	The requested domain does not exist in your account.
	unspecifiedError	The record was not added.

DNS: Add AAAA Record (dnsAddAAAA.php)

Description	Add an AAAA record to a domain. Doing so will place the domain in an unvalidated state. It will stay in that state, until you issue a Publish request.
URL	https://secure1.securityspace.com/api/dnsAddAAAA.php
Prerequisites	Valid API key, valid session token, valid DNS subscription
Input	apikey	Your SecuritySpace api key
	sessionToken	A valid session token returned from auth.php
	domain	The domain to which a record is added
	name	The hostname. It may be blank (the base domain will resolve to an IP), a hostname, or an asterisk (wildcard - anything resolves to this IP unless otherwise explicitly specified).
	ip	The IPv6 address the hostname should resolve to.
Success Response Schema	{ "required": true, "type": "object", "properties": { "status" : { "required": true, "type": "number" }, } }
Errors	notSSL	API must be invoked via an SSL connection
	dbConnectionFailure	Failed to connect to the database
	invalid apikey format	Not a valid API key
	invalid apikey - not in db	API key not in DB
	sessionTimeout	the session token has expired
	sessionAuthenticationFailure	the session token is not valid
	dnsEntitlementsOrCreditsMissing	Your subscription has expired, or your credits have all been used up
	syntaxInvalidDomain	The domain provided is not valid.
	syntaxInvalidHostname	The hostname is not valid.
	syntaxInvalidIP	The IP address is not valid.
	noSuchDomain	The requested domain does not exist in your account.
	unspecifiedError	The record was not added.

DNS: Add CNAME Record (dnsAddCNAME.php)

Description	Add an CNAME record to a domain. Doing so will place the domain in an unvalidated state. It will stay in that state, until you issue a Publish request.
URL	https://secure1.securityspace.com/api/dnsAddCNAME.php
Prerequisites	Valid API key, valid session token, valid DNS subscription
Input	apikey	Your SecuritySpace api key
	sessionToken	A valid session token returned from auth.php
	domain	The domain to which a record is added
	alias	The CNAME to be added
	name	The hostname that the CNAME resolves to.
Success Response Schema	{ "required": true, "type": "object", "properties": { "status" : { "required": true, "type": "number" }, } }
Errors	notSSL	API must be invoked via an SSL connection
	dbConnectionFailure	Failed to connect to the database
	invalid apikey format	Not a valid API key
	invalid apikey - not in db	API key not in DB
	sessionTimeout	the session token has expired
	sessionAuthenticationFailure	the session token is not valid
	dnsEntitlementsOrCreditsMissing	Your subscription has expired, or your credits have all been used up
	syntaxInvalidDomain	The domain provided is not valid.
	syntaxInvalidCNAME	The CNAME is not valid.
	syntaxInvalidHostname	The hostname is not valid.
	noSuchDomain	The requested domain does not exist in your account.
	unspecifiedError	The record was not added.

DNS: Add MX Record (dnsAddMX.php)

Description	Add an MX record to a domain. Doing so will place the domain in an unvalidated state. It will stay in that state, until you issue a Publish request.
URL	https://secure1.securityspace.com/api/dnsAddMX.php
Prerequisites	Valid API key, valid session token, valid DNS subscription
Input	apikey	Your SecuritySpace api key
	sessionToken	A valid session token returned from auth.php
	domain	The domain to which a record is added
	name	The name to be added (typically blank, unless you wish to have the MX server handle a subdomain)
	mxname	The name of the mailserver (if in a different domain, it must be a fully qualified domain name ending with a ".".
	priority	The priority of this mailserver (numeric value from 0 to 99).
Success Response Schema	{ "required": true, "type": "object", "properties": { "status" : { "required": true, "type": "number" }, } }
Errors	notSSL	API must be invoked via an SSL connection
	dbConnectionFailure	Failed to connect to the database
	invalid apikey format	Not a valid API key
	invalid apikey - not in db	API key not in DB
	sessionTimeout	the session token has expired
	sessionAuthenticationFailure	the session token is not valid
	dnsEntitlementsOrCreditsMissing	Your subscription has expired, or your credits have all been used up
	syntaxInvalidDomain	The domain provided is not valid.
	syntaxInvalidMX	The name/subdomain is not valid.
	syntaxInvalidHostname	The hostname is not valid.
	noSuchDomain	The requested domain does not exist in your account.
	syntaxInvalidPriority	An invalid priority was passed in.
unspecifiedError	The record was not added.

DNS: Add CAA Record (dnsAddCAA.php)

Description	Add a CAA record to a domain. Doing so will place the domain in an unvalidated state. It will stay in that state, until you issue a Publish request.
URL	https://secure1.securityspace.com/api/dnsAddNS.php
Prerequisites	Valid API key, valid session token, valid DNS subscription
Input	apikey	Your SecuritySpace api key
	sessionToken	A valid session token returned from auth.php
	domain	The domain to which a record is added
	subdomain	The subdomain for this CAA record (typically left blank)
	flag	The flag value of the record.
	tag	The tag value of the record (one of issue, issuewild, or iodef).
	value	The value field.
Success Response Schema	{ "required": true, "type": "object", "properties": { "status" : { "required": true, "type": "number" }, } }
Errors	notSSL	API must be invoked via an SSL connection
	dbConnectionFailure	Failed to connect to the database
	invalid apikey format	Not a valid API key
	invalid apikey - not in db	API key not in DB
	sessionTimeout	the session token has expired
	sessionAuthenticationFailure	the session token is not valid
	dnsEntitlementsOrCreditsMissing	Your subscription has expired, or your credits have all been used up
	syntaxInvalidDomain	The domain provided is not valid.
	syntaxInvalidSubdomain	The subdomain given is not valid.
	syntaxInvalidFlag	The flag given is not valid (must be numeric 0-255).
	syntaxInvalidTag	The tag given is not valid (must be numeric one if "issue", "issuewild" or "iodef").
	noSuchDomain	The requested domain does not exist in your account.
	unspecifiedError	The record was not added.

DNS: Add NS Record (dnsAddNS.php)

Description	Add an NS record to a domain. Doing so will place the domain in an unvalidated state. It will stay in that state, until you issue a Publish request. It should be noted that when you add a domain to SecuritySpace, the name servers are automatically populated for you. You should not need to add any, unless you want to have nameservers listed for subdomains of your domain.
URL	https://secure1.securityspace.com/api/dnsAddNS.php
Prerequisites	Valid API key, valid session token, valid DNS subscription
Input	apikey	Your SecuritySpace api key
	sessionToken	A valid session token returned from auth.php
	domain	The domain to which a record is added
	subdomain	The subdomain for this nameserver (normally left blank)
	nameserver	The actual nameserver's fully qualified hostname.
Success Response Schema	{ "required": true, "type": "object", "properties": { "status" : { "required": true, "type": "number" }, } }
Errors	notSSL	API must be invoked via an SSL connection
	dbConnectionFailure	Failed to connect to the database
	invalid apikey format	Not a valid API key
	invalid apikey - not in db	API key not in DB
	sessionTimeout	the session token has expired
	sessionAuthenticationFailure	the session token is not valid
	dnsEntitlementsOrCreditsMissing	Your subscription has expired, or your credits have all been used up
	syntaxInvalidDomain	The domain provided is not valid.
	syntaxInvalidSubdomain	The subdomain given is not valid.
	syntaxInvalidHostname	The nameserver hostname is not valid.
	noSuchDomain	The requested domain does not exist in your account.
	unspecifiedError	The record was not added.

DNS: Add TXT Record (dnsAddTXT.php)

Description	Add a TXT record to a domain. Doing so will place the domain in an unvalidated state. It will stay in that state, until you issue a Publish request.
URL	https://secure1.securityspace.com/api/dnsAddTXT.php
Prerequisites	Valid API key, valid session token, valid DNS subscription
Input	apikey	Your SecuritySpace api key
	sessionToken	A valid session token returned from auth.php
	domain	The domain to which a record is added
	name	The txt data record name. If you are adding SPF records for your domain, this field would normally be left blank
	txtdata	The actual nameserver's fully qualified hostname.
Success Response Schema	{ "required": true, "type": "object", "properties": { "status" : { "required": true, "type": "number" }, } }
Errors	notSSL	API must be invoked via an SSL connection
	dbConnectionFailure	Failed to connect to the database
	invalid apikey format	Not a valid API key
	invalid apikey - not in db	API key not in DB
	sessionTimeout	the session token has expired
	sessionAuthenticationFailure	the session token is not valid
	dnsEntitlementsOrCreditsMissing	Your subscription has expired, or your credits have all been used up
	syntaxInvalidDomain	The domain provided is not valid.
	syntaxInvalidTxtname	The subdomain given is not valid.
	syntaxInvalidTxtdata	The nameserver hostname is not valid.
	noSuchDomain	The requested domain does not exist in your account.
	unspecifiedError	The record was not added.

DNS: Add SRV Record (dnsAddSRV.php)

Description	Add a SRV record to a domain. Doing so will place the domain in an unvalidated state. It will stay in that state, until you issue a Publish request.
URL	https://secure1.securityspace.com/api/dnsAddSRV.php
Prerequisites	Valid API key, valid session token, valid DNS subscription
Input	apikey	Your SecuritySpace api key
	sessionToken	A valid session token returned from auth.php
	srvc	The srvc value
	prot	The protocol value
	host	The host value
	pri	The priority value
	weight	The weight value
	port	The port value
	port	The port value
	target	The target
Success Response Schema	{ "required": true, "type": "object", "properties": { "status" : { "required": true, "type": "number" }, } }
Errors	notSSL	API must be invoked via an SSL connection
	dbConnectionFailure	Failed to connect to the database
	invalid apikey format	Not a valid API key
	invalid apikey - not in db	API key not in DB
	sessionTimeout	the session token has expired
	sessionAuthenticationFailure	the session token is not valid
	dnsEntitlementsOrCreditsMissing	Your subscription has expired, or your credits have all been used up
	syntaxInvalidDomain	The domain provided is not valid.
	syntaxInvalidSrvc	The srvc value given is not valid.
	syntaxInvalidProt	The protocol value given is not valid.
	syntaxInvalidHostname	The protocol value given is not valid.
	syntaxInvalidTarget	The target value given is not valid.
	syntaxInvalidPriority	The priority value given is not valid.
	syntaxInvalidWeight	The weight value given is not valid.
	syntaxInvalidPort	The port value given is not valid.
	noSuchDomain	The requested domain does not exist in your account.
	unspecifiedError	The record was not added.

DNS: Set SOA Record values (dnsSetSOA.php)

Description	Add the admin contact (aka email) and TTL values for a domaina TXT record to a domain. Doing so will place the domain in an unvalidated state. It will stay in that state, until you issue a Publish request. When invoking this API, you can make change to either or both of the admin/ttl values. You must be passing at least one of those parameters in.
URL	https://secure1.securityspace.com/api/dnsAddTXT.php
Prerequisites	Valid API key, valid session token, valid DNS subscription
Input	apikey	Your SecuritySpace api key
	sessionToken	A valid session token returned from auth.php
	domain	The domain to which a record is added
	admin	Optional: The admin contact information. Note that it must be passed in as an email address (aaa@bbb.ccc) and gets translated to . notation (aaa.bbb.ccc).
	ttl	Optional: The minimum TTL value for your domain's records. Default value is 86400 (1 day), and should generally not be changed. One exception to this is when you know you are going to make IP address changes on your network (like moving a web server or mail server), then by setting the TTL value to something low in advance of the change, you can ensure that when you make the change, everyone picks up the new DNS records quickly. Once the change has been completed, you should set this value back up to the 1-2 day range.
Success Response Schema	{ "required": true, "type": "object", "properties": { "status" : { "required": true, "type": "number" }, } }
Errors	notSSL	API must be invoked via an SSL connection
	dbConnectionFailure	Failed to connect to the database
	invalid apikey format	Not a valid API key
	invalid apikey - not in db	API key not in DB
	sessionTimeout	the session token has expired
	sessionAuthenticationFailure	the session token is not valid
	dnsEntitlementsOrCreditsMissing	Your subscription has expired, or your credits have all been used up
	syntaxInvalidDomain	The domain provided is not valid.
	missingInput	No input values detected (ttl/admin).
	syntaxInvalidTTL	The TTL value provide is not valid.
	syntaxInvalidAdmin	The admin contact given is not valid.
	noSuchDomain	The requested domain does not exist in your account.
	unspecifiedError	The record was not added.

DNS: Set Options (dnsSetOptions.php)

Description	Allows for setting of various option values.
URL	https://secure1.securityspace.com/api/dnsAddTXT.php
Prerequisites	Valid API key, valid session token, valid DNS subscription
Input	apikey	Your SecuritySpace api key
	sessionToken	A valid session token returned from auth.php
	domain	The domain for which the options are being modified
	masters	For slave domains, one or more IP addresses that are masters. See masters
	allowtransferacl	Optional:Control of zone transfers. See allowtransfer
	notify	Optional:Notify slave servers of changes. See notify
	alsonotify	Optional:Which slave servers receive notify messages. See alsonotify
Success Response Schema	{ "required": true, "type": "object", "properties": { "status" : { "required": true, "type": "number" }, } }
Errors	notSSL	API must be invoked via an SSL connection
	dbConnectionFailure	Failed to connect to the database
	invalid apikey format	Not a valid API key
	invalid apikey - not in db	API key not in DB
	sessionTimeout	the session token has expired
	sessionAuthenticationFailure	the session token is not valid
	dnsEntitlementsOrCreditsMissing	Your subscription has expired, or your credits have all been used up
	syntaxInvalidDomain	The domain provided is not valid.
	syntaxInvalidMasters	The masters value provided is not valid.
	syntaxInvalidAllowtransferacl	The allowtransferacl value provided is not valid.
	syntaxInvalidNotify	The notify value provided is not valid.
	syntaxInvalidAlsoNotify	The alsonotify value provided is not valid.
	logicAlsoNotifyRequiresNotify	Alsonotify requires a notify parameter.
	noSuchDomain	The requested domain does not exist in your account.
	unspecifiedError	The record was not added.

DNS: Publish a domain (dnsPublish.php)

Description	Anytime changes are made to a domain, the changes remain in the securityspace databases until all edits you want to make are complete. Once everything is done, you need to issue a "Publish" request in order to push the changes out to the nameservers. The action of publishing actually consists of two steps: A validation procedure that loads the domain into a test name server, and if that succeeds, a queue for distribution request. Note that new domains that are added to the system will be on hold, and the validation will fail until the hold is removed. Changes are distributed to name servers once every 5 minutes. Note that the response schema is a bit different. The system may return a success status, but still return a series of warnings for the domain. Errors, if they are returned, indicate that the domain could not be published as is, and corrective action needs to be taken.
URL	https://secure1.securityspace.com/api/dnsAddTXT.php
Prerequisites	Valid API key, valid session token, valid DNS subscription
Input	apikey	Your SecuritySpace api key
	sessionToken	A valid session token returned from auth.php
	domain	The domain being validated and published
Success/Fail Response Schema	{ "required": true, "type": "object", "properties": { "status" : { "required": true, "type": "number" }, "warnings" : { "required": false, "type": "array" , "items": { "required": true, "type": "string" , } } "errors" : { "required": false, "type": "array" , "items": { "required": true, "type": "string" , } } } }
Errors	notSSL	API must be invoked via an SSL connection
	dbConnectionFailure	Failed to connect to the database
	invalid apikey format	Not a valid API key
	invalid apikey - not in db	API key not in DB
	sessionTimeout	the session token has expired
	sessionAuthenticationFailure	the session token is not valid
	dnsEntitlementsOrCreditsMissing	Your subscription has expired, or your credits have all been used up
	syntaxInvalidDomain	The domain provided is not valid.
	noSuchDomain	The requested domain does not exist in your account.
	unspecifiedError	The record was not added.

DNS: Build Zone file (dnsBuildZone.php)

Description	This returns what a new zone file would look like if you issue a "Publish" request. It is current with any changes made in the database, including those that have not yet been published.
URL	https://secure1.securityspace.com/api/dnsBuildZone.php
Prerequisites	Valid API key, valid session token, valid DNS subscription
Input	apikey	Your SecuritySpace api key
	sessionToken	A valid session token returned from auth.php
	domain	The domain for which the zone file is being built
Success Response Schema	{ "required": true, "type": "object", "properties": { "status" : { "required": true, "type": "number" }, "zone" : { "required": true, "type": "string" }, } }
Errors	notSSL	API must be invoked via an SSL connection
	dbConnectionFailure	Failed to connect to the database
	invalid apikey format	Not a valid API key
	invalid apikey - not in db	API key not in DB
	sessionTimeout	the session token has expired
	sessionAuthenticationFailure	the session token is not valid
	dnsEntitlementsOrCreditsMissing	Your subscription has expired, or your credits have all been used up
	syntaxInvalidDomain	The domain provided is not valid.
	noSuchDomain	The requested domain does not exist in your account.
	unspecifiedError	The record was not added.