Domains API

About

API Version: 1.8

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

Endpoints

POST
https://networkcalc.com/api/domains/
Save a domain. Save a domain to your account.

Request Headers

Content-Type
(Required) application/json

Request Body

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
INVALID_CREDENTIALS - The credentials supplied are not valid.
401
REVOKED_CREDENTIALS - The credentials supplied have been reboked and can no longer be used.
401
INVALID_GRANT_TYPE - The grant_type supplied is invalid. Should be client_credentials.
400
NOT_SAVED - There was an error saving the domain. Either the domain did not pass validation or there was a server error preventing the domain from being saved. Check the request and try again.
400
NOT_DELETED - There was an error deleting the domain. Check the request and try again.
GET
https://networkcalc.com/api/domains/{domain_id}
List domains. List one more more of the domains saved to your account.

Parameters

{domain_id}

(Optional) The unique ID of the domain.

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

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
INVALID_CREDENTIALS - The credentials supplied are not valid.
401
REVOKED_CREDENTIALS - The credentials supplied have been reboked and can no longer be used.
401
INVALID_GRANT_TYPE - The grant_type supplied is invalid. Should be client_credentials.
400
NOT_SAVED - There was an error saving the domain. Either the domain did not pass validation or there was a server error preventing the domain from being saved. Check the request and try again.
400
NOT_DELETED - There was an error deleting the domain. Check the request and try again.
DELETE
https://networkcalc.com/api/domains/{domain_id}
Delete a domain. Deletes a domain from your account.

Parameters

{domain_id}

(Optional) The unique ID of the domain.

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

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
INVALID_CREDENTIALS - The credentials supplied are not valid.
401
REVOKED_CREDENTIALS - The credentials supplied have been reboked and can no longer be used.
401
INVALID_GRANT_TYPE - The grant_type supplied is invalid. Should be client_credentials.
400
NOT_SAVED - There was an error saving the domain. Either the domain did not pass validation or there was a server error preventing the domain from being saved. Check the request and try again.
400
NOT_DELETED - There was an error deleting the domain. Check the request and try again.

Response Formats

DomainCreateResponse

DomainListResponse

DomainResponse