Account Profile Setup

Body

application/json

account_name

string

required

Cloudx account name.

aws_account_number

string

required

AWS 12 digit account number.

awsgov_access_key

string

required

AWS GovCloud account access key id.

awsgov_account_number

string

required

AWS GovCloud 12 digit account number.

awsgov_secret_key

string

required

AWS GovCloud account secret access key.

azure_cert_path

string

required

Azure certification path.

azure_china_cert_path

string

required

Azure China certification path.

azure_china_subscription_id

string

required

Azure China Subscription ID.

azure_subscription_id

string

required

Azure Subscription ID.

cloud_type

enum<integer>

required

Cloud Provider.

Available options:

1,

4,

8,

16,

32,

256,

1024,

2048,

4096,

8192,

131072,

262144,

524288,

1048576

CID

string

The opaque session ID token. Required for 7.2 controllers only.

account_email

string

Email address of the account name.

account_password

string

Password on the account_name for GUI login.

action

string

The API action to perform. Required for 7.2 controllers only.

aliyun_access_key

string

Aliyun access key id.

aliyun_account_id

string

Aliyun account number.

aliyun_secret_key

string

Aliyun access key.

arm_application_client_id

string

ARM AD client ID.

arm_application_client_secret

string

ARM AD client secret.

arm_application_endpoint

string

ARM AD tenant ID.

arm_china_application_client_id

string

ARM AD client ID.

arm_china_application_client_secret

string

ARM AD client secret.

arm_china_application_endpoint

string

ARM AD tenant ID.

arm_china_subscription_id

string

Azure ARM subscription ID.

arm_subscription_id

string

Azure ARM subscription ID.

aws_access_key

string

AWS account access key id.

aws_china_access_key

string

AWS China access key id.

aws_china_account_number

string

AWS China account number.

aws_china_role_arn

string

AWS China Role ARN ID.

aws_china_role_ec2

string

AWS China Role EC2 ID.

aws_china_secret_key

string

AWS China access key.

aws_gateway_role_app

string

AWS Gateway App Role ARN.

aws_gateway_role_ec2

string

AWS Gateway EC2 Role ARN.

aws_role_arn

string

AWS Role ARN ID.

aws_role_ec2

string

AWS Role EC2 ID.

aws_secret_key

string

AWS account secret access key.

awsgov_role_arn

string

AWS Gov Role ARN ID.

awsgov_role_ec2

string

AWS Gov Role EC2 ID.

azure_gov_application_client_id

string

ARM AD client ID.

azure_gov_application_client_secret

string

ARM AD client secret.

azure_gov_application_endpoint

string

ARM AD tenant ID.

azure_gov_subscription_id

string

Azure ARM subscription ID.

china_cloud_trail_bucket

string

To enable CloudTrail for this Gov China account, enter a S3 bucket name to store the logs.

cloud_trail_bucket

string

To enable CloudTrail for this account, enter a S3 bucket name to store the logs.

edge_csp_api_endpoint

string

Edge CSP Endpoint.

edge_csp_password

string

Edge CSP password.

edge_csp_username

string

Edge CSP username.

equinix_password

string

Equinix password.

equinix_username

string

Equinix username.

gcloud_project_credentials

string

GCP account credentials file. This field must be base64 encoded.

gcloud_project_name

string

Gcloud project id.

gov_cloud_trail_bucket

string

To enable CloudTrail for this GovCloud account, enter a S3 bucket name to store the logs.

groups

string

RBAC groups.

megaport_password

string

Megaport password.

megaport_username

string

Megaport username.

oci_api_key

string

OCI account credentials file. This field must be base64 encoded.

oci_compartment_id

string

OCI compartment id.

oci_tenancy_id

string

OCI tenancy id.

oci_user_id

string

OCI user id.

skip_sg_config

boolean

Skip auto-enable Access Security.

Response

General v2 API response schema.

A generic API response container for v2 style APIs.

errortype

string

Error type if the API failed.

reason

string

Failure reason if the API failed.

results

API response data

return

boolean

Whether the API returned successfully

Concepts & Architecture

Guides

Reference

Setup Account Profile

Body

Response