Activating an Instance

Once an instance is created from the CloudBasic AMI, it needs to be activated.

Attention: This API call uses non-standard authentication and does not require an Authorization header. At this point of a CloudBasic instance’s lifecycle there are no valid users and credentials created yet.

Request Syntax – using XML parameter encoding:

POST /api/ ActivateInstance HTTP/1.1
Host: use.your.host.name:82
X-Amz-Content-Sha256: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
Content-Type: application/xml
X-Amz-Date: 20171115T202130Z

<?xml version="1.0" encoding="utf-8"?>
<ActivateInstanceRequest>
 <Email> your-user@yourdomain.com </Email> 
 <InstanceId>ec2_instance_id</InstanceId
 <Password>admin-password</Password> 
 <IsProduction>true</IsProduction>
 <Company>MyCompany</Company>
 <ContactPerson>John Doe</ContactPerson>
 <ActivationKey>3FF56259-F057-4A2F-BEB3-643F1BE25HB6E</ActivationKey> 
</ActivateInstanceRequest>

 

Request Parameters

Parameter	Description	Required
Email	A character string that represents a valid email address. This email address will be associated with the first CloudBasic user with Administrator rights and must be used when the user is logging into the CloudBasic console. Type: String Default: None	Yes
InstanceId	The EC2 Instance ID of the CloudBasic instance you are trying to activate. Type: String Default: None	Yes
Password	The default password that will be used when trying to login to the CloudBasic console. Type: String Default: None	Yes
IsProduction	Indicates whether this instance is intended for production or testing use. Production instances need to be configured with defaults for fast, consistent performance and enabled for high-availability. Go to http://hacluster.cloudbasic.net to learn more. To cluster this instance with another CloudBasic instance d in a different zone, see CreateCluster API method. To test clustering in the UI, go to \Advanced\Multi-AZ HA Cluster. Type: String Default: None Valid value: true/ false	Yes
Company	The name of your organization. Type: String Default: None	Yes
ContactPerson	The name of the person who can be contacted regarding issues with this instance. Type: String Default: None	No
ActivationKey	A one-time instance specific activation key provided by CloudBasic. This attribute is applicable only to instances activated outside of the AWS, Google Cloud, Oracle Cloud, IBM CLoud and Alibaba Cloud Marketplaces. Type: String Default: None	No

Response Syntax – using XML parameter encoding:

HTTP/1.1 200
status: 200

<?xml version="1.0" encoding="utf-8"?>
<ActivateInstanceResponse>
 <AdminUsername>admin</AdminUsername>
 <PublicKey>GUFBSWGOFWLPBDNKFSXE</PublicKey>
 <PrivateKey>hKwIrkxKgFPgNtXYNZj/9X2kPWPtISIHoOwAh0hv</PrivateKey>
</ActivateInstanceResponse>

Response Parameters

Parameter	Description
AdminUsername	The User Name of the user that was just created as part of the Instance Activation process. This is user has Administrative privileges.
PublicKey	This is the Public Key required to authenticate requests to the CloudBasic API. For more information please see the section API Security Attention: This is the only time this value will be returned by the API. There are no other ways to retrieve this value.
PrivateKey	This is the Private Key required to authenticate requests to the CloudBasic API. For more information please see the section API Security Attention: This is the only time this value will be returned by the API. There are no other ways to retrieve this value.

Error Response Syntax – using XML parameter encoding

HTTP/1.1 400
status: 400

<?xml version="1.0" encoding="utf-8"?>

<ErrorResponse> 
 <RequestId>request-id</RequestId>
   <Errors>
     <Error>
       <Message>Error message 1</Message>
     <Error>
     <Error>
       <Message>Error message 2</Message>
     <Error>
 </Errors>
</ErrorResponse>