documenter.getpostman.com Open in urlscan Pro
2606:4700:4400::6812:2196  Public Scan

Submitted URL: https://domainsapi.us.reclaim.cloud/
Effective URL: https://documenter.getpostman.com/view/6614072/UVXoktFA
Submission: On July 09 via automatic, source certstream-suspicious — Scanned from US

Form analysis 0 forms found in the DOM

Text Content

 * Body
 * Headers (0)

 * Body
 * Headers (0)




Public


Documentation Settings

ENVIRONMENT
No Environment

LAYOUT
Double Column

LANGUAGE
cURL - cURL



Domains API
Introduction
User
Application
Product


DOMAINS API

The Domains API is a collection of API requests to perform functions within a
Domains system. Work on this API is ongoing and should be considered unfinished
and prone to error.


AUTHENTICATION

The Domains API is currently restricted by IP address. If you feel you should
have access please reach out to Reclaim Hosting.


USER

Users of the Domains system. Must have a unique email address.




POSTADD USER

https://api.reclaimhosting.com/v1/user/add/

Create a new user account in the Domains system. Returns a unique client ID
number.

Bodyformdata
email

janedoe@gmail.com

Required: A unique email address

firstname

Jane

Required: First name

lastname

Doe

Required: Last name

address1

555 Reclaim Road

Required: Street Address

city

Fredericksburg

Required: City

state

VA

Required: State (2 letter format)

postcode

22401

Required: Zip Code

country

US

Required: Country Code (2 letter format)

phonenumber

5551061234

Required: Phone Number (10 digits only)

password

hunter2

Required: Set a password for the user

Example Request
Add User

curl


curl --location 'https://api.reclaimhosting.com/v1/user/add/' \
--form 'email="janedoe@gmail.com"' \
--form 'firstname="Jane"' \
--form 'lastname="Doe"' \
--form 'address1="555 Reclaim Road"' \
--form 'city="Fredericksburg"' \
--form 'state="VA"' \
--form 'postcode="22401"' \
--form 'country="US"' \
--form 'phonenumber="5551061234"' \
--form 'password="hunter2"'

Example Response
 * Body
 * Headers (0)

No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers
APPLICATION




POSTINSTALL APPLICATION

https://api.reclaimhosting.com/v1/application/install/

Install an application into a user's environment. Supports both cPanel via
Installatron as well as Reclaim Cloud.

Bodyformdata
app

wordpress

Required: Unique application identifier.

productid

123

Required: Product ID number for account where the application will be installed.

environment

installatron

Required: Environment type where the application will be installed. Accepts
installatron and cloud.

domain

reclaimhosting.com

Required: Apex domain or subdomain where the application will be installed.

folder

blog

Optional: If installing to a subdirectory specify folder name. Not supported on
cloud.

options

[theme=hemingway,reservedcloudlets=4]

Optional: Array of install options specific to each environment and application
to further customize the install.

Example Request
Install Application

curl


curl --location 'https://api.reclaimhosting.com/v1/application/install/' \
--form 'app="wordpress"' \
--form 'productid="123"' \
--form 'environment="installatron"' \
--form 'domain="reclaimhosting.com"' \
--form 'folder="blog"' \
--form 'options="[theme=hemingway,reservedcloudlets=4]"'

Example Response
 * Body
 * Headers (0)

No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers
PRODUCT