About the Domains API

API Version: 1.9

The Domains API allows you to build, manage, and monitor your domains.

This is the API for Domains.

Endpoints

https://networkcalc.com/api/domains/

Add a domain to your account.

This endpoint requires authorization. Read about API authorization or see NetworkCalc Pro pricing.

Request Headers

Content-Type

(Required) application/json

Request Body

{

"domain": "[string] The domain name, for example: networkcalc.com."

}

content_copy

Response Format

DomainCreateResponse

Response Codes

200

OK - Success.

401

MISSING_CREDENTIALS - The request body is missing client_id, client_secret, or both.

401

CREDENTIALS_NOT_FOUND - The credentials supplied are not valid.

401

NOT_AUTHORIZED - You do not have permission to perform this action.

400

NOT_SAVED - There was an error saving the resource. Either the resource did not pass validation or there was a server error preventing it from being saved. Check the request and try again.

400

NOT_UPDATED - There was an error saving the resource. Either the resource did not pass validation or there was a server error preventing it from being saved. Check the request and try again.

400

NOT_DELETED - There was an error deleting the resource. Check the request and try again.

Examples

Example 1

Run this in the API

cURL Example

curl -X POST https://networkcalc.com/api/domains \

--header "Authorization: Bearer 2jdS83kfDdDfllHk" \

--header "Content-Type: application/json" \

--data '{ "domain": "networkcalc.com" }'

content_copy

PowerShell Example

$headers = @{"Authorization"="Bearer 2jdS83kfDdDfllHk"; "Content-Type"="application/json"}

$body = @{"domain"="networkcalc.com"} | ConvertTo-Json

Invoke-RestMethod https://networkcalc.com/api/domains -Method POST -Body $body -Headers $headers | ConvertTo-Json

content_copy

Python Example

import requests

headers = {"Authorization": "Bearer 2jdS83kfDdDfllHk", "Content-Type": "application/json"}

data = { "domain": "networkcalc.com" }

requests.post("https://networkcalc.com/api/domains", json = data, headers = headers).json()

content_copy

Response

{

"status": "OK",

"domain": {

"id": 123,

"domain": "networkcalc.com",

"created_at": "2021-12-26T15:23:08.639Z",

"updated_at": "2021-12-26T15:23:08.639Z"

}

content_copy

https://networkcalc.com/api/domains/{domain_id}/subdomains/{subdomain_prefix}

Add a subdomain to an existing domain.

This endpoint requires authorization. Read about API authorization or see NetworkCalc Pro pricing.

Parameters

{domain_id}

(Optional) The unique ID of the domain.

Example: https://networkcalc.com/api/domains/123/subdomains

{subdomain_prefix}

(Required) The prefix for the domain. For example, if the domain is networkcalc.com, the subdomain prefix for my.demo.networkcalc.com would be my.demo.

Example: https://networkcalc.com/api/domains/123/subdomains/my.demo

Response Format

SubdomainCreateResponse

Response Codes

200

OK - Success.

401

MISSING_CREDENTIALS - The request body is missing client_id, client_secret, or both.

401

CREDENTIALS_NOT_FOUND - The credentials supplied are not valid.

401

NOT_AUTHORIZED - You do not have permission to perform this action.

400

NOT_SAVED - There was an error saving the resource. Either the resource did not pass validation or there was a server error preventing it from being saved. Check the request and try again.

400

NOT_UPDATED - There was an error saving the resource. Either the resource did not pass validation or there was a server error preventing it from being saved. Check the request and try again.

400

NOT_DELETED - There was an error deleting the resource. Check the request and try again.

Examples

Example 1

Run this in the API

cURL Example

curl -X POST https://networkcalc.com/api/domains/123/subdomains/test \

--header "Authorization: Bearer 2jdS83kfDdDfllHk"

content_copy

PowerShell Example

$headers = @{"Authorization"="Bearer 2jdS83kfDdDfllHk"}

Invoke-RestMethod https://networkcalc.com/api/domains/123/subdomains/test -Method POST -Headers $headers | ConvertTo-Json

content_copy

Python Example

import requests

headers = {"Authorization": "Bearer 2jdS83kfDdDfllHk"}

requests.post("https://networkcalc.com/api/domains/123/subdomains/test", headers = headers).json()

content_copy

Response

{

"status": "OK",

"subdomain": {

"domain_report": false,

"id": 456,

"prefix": "test",

"domain_id": "123"

}

content_copy

https://networkcalc.com/api/domains/{domain_id}

List one more more of the domains saved to your account.

This endpoint requires authorization. Read about API authorization or see NetworkCalc Pro pricing.

Parameters

{domain_id}

(Optional) The unique ID of the domain.

Example: https://networkcalc.com/api/domains/123/subdomains

Response Format

DomainListResponse

Response Codes

200

OK - Success.

401

MISSING_CREDENTIALS - The request body is missing client_id, client_secret, or both.

401

CREDENTIALS_NOT_FOUND - The credentials supplied are not valid.

401

NOT_AUTHORIZED - You do not have permission to perform this action.

400

NOT_SAVED - There was an error saving the resource. Either the resource did not pass validation or there was a server error preventing it from being saved. Check the request and try again.

400

NOT_UPDATED - There was an error saving the resource. Either the resource did not pass validation or there was a server error preventing it from being saved. Check the request and try again.

400

NOT_DELETED - There was an error deleting the resource. Check the request and try again.

Examples

Example 1

Run this in the API

cURL Example

curl -X GET https://networkcalc.com/api/domains \

--header "Authorization: Bearer 2jdS83kfDdDfllHk"

content_copy

PowerShell Example

$headers = @{"Authorization"="Bearer 2jdS83kfDdDfllHk"}

Invoke-RestMethod https://networkcalc.com/api/domains -Method GET -Headers $headers | ConvertTo-Json

content_copy

Python Example

import requests

headers = {"Authorization": "Bearer 2jdS83kfDdDfllHk"}

requests.get("https://networkcalc.com/api/domains", headers = headers).json()

content_copy

Response

{

"status": "OK",

"domains": [

{

"id": 123,

"domain": "networkcalc.com",

"created_at": "2021-12-26T15:23:08.639Z",

"updated_at": "2021-12-26T15:23:08.639Z"

}

]

}

content_copy

Example 2

Run this in the API

cURL Example

curl -X GET https://networkcalc.com/api/domains/123 \

--header "Authorization: Bearer 2jdS83kfDdDfllHk"

content_copy

PowerShell Example

$headers = @{"Authorization"="Bearer 2jdS83kfDdDfllHk"}

Invoke-RestMethod https://networkcalc.com/api/domains/123 -Method GET -Headers $headers | ConvertTo-Json

content_copy

Python Example

import requests

headers = {"Authorization": "Bearer 2jdS83kfDdDfllHk"}

requests.get("https://networkcalc.com/api/domains/123", headers = headers).json()

content_copy

Response

{

"status": "OK",

"domain": {

"id": 123,

"domain": "networkcalc.com",

"created_at": "2021-12-26T15:23:08.639Z",

"updated_at": "2021-12-26T15:23:08.639Z"

}

content_copy

https://networkcalc.com/api/domains/{domain_id}/subdomains/{subdomain_id}

List one more more of the subdomains for a domain.

This endpoint requires authorization. Read about API authorization or see NetworkCalc Pro pricing.

Parameters

{domain_id}

(Optional) The unique ID of the domain.

Example: https://networkcalc.com/api/domains/123/subdomains

{subdomain_id}

(Optional) The unique ID of the subddomain.

Example: https://networkcalc.com/api/domains/subdomains/456

Response Format

SubdomainListResponse

Response Codes

200

OK - Success.

401

MISSING_CREDENTIALS - The request body is missing client_id, client_secret, or both.

401

CREDENTIALS_NOT_FOUND - The credentials supplied are not valid.

401

NOT_AUTHORIZED - You do not have permission to perform this action.

400

NOT_SAVED - There was an error saving the resource. Either the resource did not pass validation or there was a server error preventing it from being saved. Check the request and try again.

400

NOT_UPDATED - There was an error saving the resource. Either the resource did not pass validation or there was a server error preventing it from being saved. Check the request and try again.

400

NOT_DELETED - There was an error deleting the resource. Check the request and try again.

Examples

Example 1

Run this in the API

cURL Example

curl -X GET https://networkcalc.com/api/domains/123/subdomains \

--header "Authorization: Bearer 2jdS83kfDdDfllHk"

content_copy

PowerShell Example

$headers = @{"Authorization"="Bearer 2jdS83kfDdDfllHk"}

Invoke-RestMethod https://networkcalc.com/api/domains/123/subdomains -Method GET -Headers $headers | ConvertTo-Json

content_copy

Python Example

import requests

headers = {"Authorization": "Bearer 2jdS83kfDdDfllHk"}

requests.get("https://networkcalc.com/api/domains/123/subdomains", headers = headers).json()

content_copy

Response

{

"status": "OK",

"subdomains": [

{

"id": 456,

"prefix": "demo",

"domain_id": 123,

"domain_report": false,

"alerts": []

}

]

}

content_copy

Example 2

Run this in the API

cURL Example

curl -X GET https://networkcalc.com/api/domains/123/subdomains/456 \

--header "Authorization: Bearer 2jdS83kfDdDfllHk"

content_copy

PowerShell Example

$headers = @{"Authorization"="Bearer 2jdS83kfDdDfllHk"}

Invoke-RestMethod https://networkcalc.com/api/domains/123/subdomains/456 -Method GET -Headers $headers | ConvertTo-Json

content_copy

Python Example

import requests

headers = {"Authorization": "Bearer 2jdS83kfDdDfllHk"}

requests.get("https://networkcalc.com/api/domains/123/subdomains/456", headers = headers).json()

content_copy

Response

{

"status": "OK",

"subdomain": {

"id": 456,

"prefix": "demo",

"domain_id": 123,

"domain_report": false,

"alerts": []

}

content_copy

https://networkcalc.com/api/domains/{domain_id}/subdomains/{subdomain_id}

Update a subdomain in your account.

This endpoint requires authorization. Read about API authorization or see NetworkCalc Pro pricing.

Parameters

{domain_id}

(Optional) The unique ID of the domain.

Example: https://networkcalc.com/api/domains/123/subdomains

{subdomain_id}

(Optional) The unique ID of the subddomain.

Example: https://networkcalc.com/api/domains/subdomains/456

Request Headers

Content-Type

(Required) application/json

Request Body

{

"prefix": "[string] The prefix for the domain. For example, `my.demo` for `my.demo.networkcalc.com`.",

"domain_id": "[number] The unique ID of the domain.",

"domain_report": "[boolean] `true` if this subdomain should be included in any scheduled reports for the domain. Default is `false`."

}

content_copy

Response Format

SubdomainUpdateResponse

Response Codes

200

OK - Success.

401

MISSING_CREDENTIALS - The request body is missing client_id, client_secret, or both.

401

CREDENTIALS_NOT_FOUND - The credentials supplied are not valid.

401

NOT_AUTHORIZED - You do not have permission to perform this action.

400

NOT_SAVED - There was an error saving the resource. Either the resource did not pass validation or there was a server error preventing it from being saved. Check the request and try again.

400

NOT_UPDATED - There was an error saving the resource. Either the resource did not pass validation or there was a server error preventing it from being saved. Check the request and try again.

400

NOT_DELETED - There was an error deleting the resource. Check the request and try again.

Examples

Example 1

Run this in the API

cURL Example

curl -X PATCH https://networkcalc.com/api/domains \

--header "Authorization: Bearer 2jdS83kfDdDfllHk" \

--header "Content-Type: application/json" \

--data '{ "domain_report": true }'

content_copy

PowerShell Example

$headers = @{"Authorization"="Bearer 2jdS83kfDdDfllHk"; "Content-Type"="application/json"}

$body = @{"domain_report"=true} | ConvertTo-Json

Invoke-RestMethod https://networkcalc.com/api/domains -Method PATCH -Body $body -Headers $headers | ConvertTo-Json

content_copy

Python Example

import requests

headers = {"Authorization": "Bearer 2jdS83kfDdDfllHk", "Content-Type": "application/json"}

data = { "domain_report": true }

requests.patch("https://networkcalc.com/api/domains", json = data, headers = headers).json()

content_copy

Response

{

"status": "OK",

"message": "1 subdomain(s) updated."

}

content_copy

https://networkcalc.com/api/domains/{domain_id}

Deletes a domain from your account.

This endpoint requires authorization. Read about API authorization or see NetworkCalc Pro pricing.

Parameters

{domain_id}

(Optional) The unique ID of the domain.

Example: https://networkcalc.com/api/domains/123/subdomains

Response Format

DomainDeleteResponse

Response Codes

200

OK - Success.

401

MISSING_CREDENTIALS - The request body is missing client_id, client_secret, or both.

401

CREDENTIALS_NOT_FOUND - The credentials supplied are not valid.

401

NOT_AUTHORIZED - You do not have permission to perform this action.

400

NOT_SAVED - There was an error saving the resource. Either the resource did not pass validation or there was a server error preventing it from being saved. Check the request and try again.

400

NOT_UPDATED - There was an error saving the resource. Either the resource did not pass validation or there was a server error preventing it from being saved. Check the request and try again.

400

NOT_DELETED - There was an error deleting the resource. Check the request and try again.

Examples

Example 1

Run this in the API

cURL Example

curl -X DELETE https://networkcalc.com/api/domains/123 \

--header "Authorization: Bearer 2jdS83kfDdDfllHk"

content_copy

PowerShell Example

$headers = @{"Authorization"="Bearer 2jdS83kfDdDfllHk"}

Invoke-RestMethod https://networkcalc.com/api/domains/123 -Method DELETE -Headers $headers | ConvertTo-Json

content_copy

Python Example

import requests

headers = {"Authorization": "Bearer 2jdS83kfDdDfllHk"}

requests.delete("https://networkcalc.com/api/domains/123", headers = headers).json()

content_copy

Response

{

"status": "OK"

}

content_copy

https://networkcalc.com/api/domains/{domain_id}/subdomains/{subdomain_id}

Deletes a subdomain from your account.

This endpoint requires authorization. Read about API authorization or see NetworkCalc Pro pricing.

Parameters

{domain_id}

(Optional) The unique ID of the domain.

Example: https://networkcalc.com/api/domains/123/subdomains

{subdomain_id}

(Optional) The unique ID of the subddomain.

Example: https://networkcalc.com/api/domains/subdomains/456

Response Format

SubdomainDeleteResponse

Response Codes

200

OK - Success.

401

MISSING_CREDENTIALS - The request body is missing client_id, client_secret, or both.

401

CREDENTIALS_NOT_FOUND - The credentials supplied are not valid.

401

NOT_AUTHORIZED - You do not have permission to perform this action.

400

NOT_SAVED - There was an error saving the resource. Either the resource did not pass validation or there was a server error preventing it from being saved. Check the request and try again.

400

NOT_UPDATED - There was an error saving the resource. Either the resource did not pass validation or there was a server error preventing it from being saved. Check the request and try again.

400

NOT_DELETED - There was an error deleting the resource. Check the request and try again.

Examples

Example 1

Run this in the API

cURL Example

curl -X DELETE https://networkcalc.com/api/domains/123/subdomains/456 \

--header "Authorization: Bearer 2jdS83kfDdDfllHk"

content_copy

PowerShell Example

$headers = @{"Authorization"="Bearer 2jdS83kfDdDfllHk"}

Invoke-RestMethod https://networkcalc.com/api/domains/123/subdomains/456 -Method DELETE -Headers $headers | ConvertTo-Json

content_copy

Python Example

import requests

headers = {"Authorization": "Bearer 2jdS83kfDdDfllHk"}

requests.delete("https://networkcalc.com/api/domains/123/subdomains/456", headers = headers).json()

content_copy

Response

{

"status": "OK"

}

content_copy

Response Formats

{

"status": "[string] The status of the request.",

"domain": "[Domain] See DomainResponse."

}

content_copy

{

"status": "[string] The status of the request.",

"domains": "[array] An array of all domains saved to your account. See DomainResponse."

}

content_copy

{

"status": "[string] The status of the request.",

"message": "[string] A message describing the update, if it was successful."

}

content_copy

{

"status": "[string] The status of the request."

}

content_copy

{

"status": "[string] The status of the request.",

"domain": {

"id": "[number] The unique identifier for the domain.",

"domain": "[string] The domain name.",

"report_schedule": "[string] The schedule for domain reports or null. Must be one of: [null, 'daily', 'weekly', 'monthly'].",

"users": "[array] An array of all users with access to the domain."

}

content_copy

{

"status": "[string] The status of the request.",

"subdomain": "[Subdomain] See SubdomainResponse."

}

content_copy

{

"status": "[string] The status of the request.",

"subdomains": "[array] An array of all subdomains saved to your account. See SubdomainResponse."

}

content_copy

{

"status": "[string] The status of the request.",

"message": "[string] A message describing the update, if it was successful."

}

content_copy

{

"status": "[string] The status of the request."

}

content_copy

{

"status": "[string] The status of the request.",

"domain": {

"id": "[number] The unique identifier for the subdomain.",

"prefix": "[string] The subdomain's prefix. For example, my.demo for my.demo.networkcalc.com.",

"domain_id": "[string] The unique ID of the domain this subdomain is associated with.",

"domain_report": "[boolean] true if this subdomain is included in scheduled reports for the domain, false otherwise.",

"alerts": "[array] An array of all alerts associated with the subdomain."

}

content_copy