{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"ff682a20-6ffd-4fe0-a77b-65dae43ae2a6","name":"Domain Panel API","description":"This API provides external access to the Micron21 Domain Panel application, giving admins, resellers, users, and the Micron21.com website API access to Domain Panels functionality to do things like verify domain availability, register new domains, query the registration status, transfer accounts and several other things.\n\nThe Domain Panel host is [https://domains.micron21.com/](https://domains.micron21.com/).\n\nThe OTE host is internally addressable at [https://client-area-staging.micron21.com/](https://client-area-staging.micron21.com/).\n\nThere is a customer accessible OTE host at [https://domains-ote1.micron21.com/](https://domains-ote1.micron21.com/). To get access to this, you will need a static IP address; please e-mail Joel McLean [mailto:joel.mclean@micron21.com](https://mailto:joel.mclean@micron21.com) to be granted access.\n\nThe API URL is be [https://domains.micron21.com/api/v1/{call}/{parameter}/{argument}](https://domains.micron21.com/api/v1/%7Bcall%7D/%7Bparameter%7D/%7Bargument%7D)\n\nSupported calls are:\n\n- GET\n    \n- POST\n    \n- PUT/PATCH\n    \n- DELETE\n    \n\n# Overview\n\nThis API documentation is version 1.0 as of 04/06/2021. Any issues or inconsistencies, please e-mail Joel McLean [mailto:joel.mclean@micron21.com](https://mailto:joel.mclean@micron21.com)\n\n# Example CURL including Auth\n\n`curl -X GET -H 'Accept: application/json' -H 'Authorization: Token token=\"dqzJsVcTkU4AxsbHJ9j8\", email=\"admin@example.com\"' \"https://client-area-staging.micron21.com/api/v1/customers/search?search_term=email&value=admin@example.com\"`\n\n# Authentication\n\nAuthentication is provided by an authentication token which is stored in the Domain Panel application and provided to users.\n\nThere will be a specific authentication token for the Micron21 website.\n\nThe format for authentication is in the header:  \n`'Authorization: Token token=\"dqzJsVcTkU4AxsbHJ9j8\", email=\"admin@example.com\"'`\n\nIn POSTMAN this is achieved with variables (so you can set your own user + token when testing) and all Authorization is set to inherit from the parent API item.\n\nFinally, the account needs to be explicitly enabled for API access; only an admin can enable a user for API access. The default setting is disabled for all users.\n\n# Error Handling\n\nThe API Responses contain error messages that should generally be self-explaining. Some common errors that might not have a complete explanation are:\n\n- 500 Internal Server Error - indicates bad request; something was malformed in such a way that the API wasn't able to respond with a coherent response. Check your inputs, target URL, authentication, and formatting.\n    \n- 401 Unauthorised (\"You are not permitted to perform that action\") - indicates that the endpoint is valid, and the authentication has been successful, but the thing you are trying to do is something you just are not allowed to do. This might be because you're trying to interact with a domain which belongs to a different user account.\n    \n- 401 Unauthorised (\"Unauthorized\") - indicates a problem with your username and authentication token. Check that you have these correct, contact support to have them reset and double check your account has API enabled.\n    \n- Error: read ECONNRESET - indicates that your API client was not able to connect to the remote server. For the OTE, this is likely because you are not accessing from an allowed IP address. For the production URL, it's possible you have a firewall rule in the way, or you have been blocked by our system for some ephemeral reason.\n    \n\n# Formatting\n\nSpecial care needs to be taken when formatting specific fields in the request body:\n\n## dob\n\nMust be formatted `YYYY-MM-DD` with hyphens.  \ne.g. `1990-08-23`\n\n## voice\n\nContacts use a \"voice\" field which must be formatted either:\n\n- `NNNNNNNNNN` e.g. 0400123123 or;\n    \n- `+CC.A.PPPPPPPP` e.g. +61.3.97517690\n    \n\n## name\n\nMust be two separate words. If a name would have multiple first names, they must be hyphenated.  \ne.g.\n\n- `Steve Jobs` for Steve Jobs\n    \n- `Mary-Anne Smith` for Mary Anne Smith\n    \n\nAnything longer than one space is not supported.\n\n## Country Codes\n\nWhere a country is required, it should be noted that ISO standard of 2 character country codes is required. \"Australia\" is not acceptable - `AU` in all capitals must be used.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"6636557","team":270879,"collectionId":"ff682a20-6ffd-4fe0-a77b-65dae43ae2a6","publishedId":"T17JA7hP","public":true,"publicUrl":"https://apidocs.micron21.com","privateUrl":"https://go.postman.co/documentation/6636557-ff682a20-6ffd-4fe0-a77b-65dae43ae2a6","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"}}]}},"version":"8.11.6","publishDate":"2026-02-02T02:57:43.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/6f7a89a51d38d5721068f0464c4fb931f293ca32fb41bf16ed746cb784613078","favicon":"https://res.cloudinary.com/postman/image/upload/v1549955812/team/aypwcaz0w9obbo7c3rck.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://apidocs.micron21.com/view/metadata/T17JA7hP"}