This API allows you to provision and query your cloud accounts within nOps. It is a useful tool to provision and credential many accounts or to manage their configuration. The available actions are: GET and POST.

The parameters are also listed on the Swagger pages and contain information about the structure (String, Integer or Boolean).

Any items marked with an asterisk * are Mandatory.

Retrieve a collection of Cloud Accounts

API Endpoint: /c/admin/projectaws/

Method: GET

GET Response Parameters

Title

Description

id

ID

Unique Integer value identifying this AWS Project.

name*

Name

Displays the name.

client

Client

The Client number

access_key

Access key

The AWS access key.

access_type

Access Type

Type of AWS access (IAM, Role, etc.)

account_number

Account number

The account number associated with the query.

role_name

Role name

The role name. Maximum length of 255 chars.

external_id

External ID

The ID provided by AWS.
Maximum length of 255 chars.

arn

ARN

The AWS ARN.

bucket

Bucket

String.

is_one_click_setup

Is one click setup

Boolean. Is set to true if one click setup was used.

report_name

Report name

The name assigned to the report.

report_path_prefix

Report path prefix

The report path prefix appended to your Cost and Usage Report (CUR)

status

Status

The status code

cloud_type

Cloud Type

The cloud type (such as AWS or Azure)

created

Created

The created date expressed as yyyy-mm-ddThh:mm:ssZ

modified

Modified

The modified date expressed as yyyy-mm-ddThh:mm:ssZ

azure_cpv

Azure cpv

Value = false for an AWS query.

azure_csp_nce

Azure csp name

Value = false for an AWS query.

tenant_name

Tenant name

Max length: 255 chars. Specifies the tenant.

Provision a Cloud Account in nOps

This API is used to provision a cloud account within nOps. It is a useful tool to provision and credential many accounts or to manage their configuration.

Any items marked with an asterisk * are Mandatory.

API Endpoint: /c/admin/projectaws/

Method: POST

POST Response body

Title

Description

name*

Name

Minimum/Maximum character length 1/255. Enter a name

access_key

Access key

The access key.

secret

Secret

The client secret.

access_type

Access Type

The access type

account_number

Account number

The account number

role_name

Role name

The role name.

external_id

External ID

The external ID.

status

Status

maximum: 2147483647

minimum: -2147483648

cloud_type

Cloud type

The cloud type such as AWS or Azure

azure_cpv

Azure cpv

Value = true if this is Azure

azure_csp_nce

Azure csp name

Value = true if this is Azure

tenant_name

Tenant name

Specifies the tenant name

Retrieve information about a specific Cloud Account

API endpoint: /c/admin/projectaws/{id}/

Method: GET

Use to retrieve information about the specified project IDs:

GET Response Parameters for {id}

Title

Description

id

ID

Unique Integer value identifying a Project

name

Name

The project name

client

Client

The client name

access_key

Access key

The AWS access key.

secret

Secret

The client secret.

access_type

Access Type

Displays the access type.

account_number

Account number

The account number for the specified project/s

role_name

Role name

The AWS role.

external_id

External ID

The associated external ID.

arn

ARN

The Amazon Resource name.

bucket

Bucket

Name of the S3 bucket.

is_one_click_setup

Is one click setup

Boolean: Value = true if one-click setup was used.

report_name

Report name

The report name

report_path_prefix

Report path prefix

The report path prefix for the Cost and Usage Report (CUR)

status

Status

Integer. maximum: 2147483647

minimum: -2147483648

cloud_type

Cloud type

The cloud type such as AWS or Azure

created

Created

The created date expressed as yyyy-mm-ddThh:mm:ssZ

modified

Modified

The modified date expressed as yyyy-mm-ddThh:mm:ssZ

azure_cpv

Azure cpv

Value = false for an AWS query.

azure_csp_nce

Azure csp name

Value = false for an AWS query.

tenant_name

Tenant name

The tenant name.

Update information about a specific Cloud Account

API endpoint: /c/admin/projectaws/{id}/

Method: POST

Use to provision a cloud account with the specified project ID:

POST Response body

Title

Description

name*

Name

Minimum/Maximum character length 1/255. Enter a name

access_key

Access key

The access key.

secret

Secret

The client secret.

access_type

Access Type

The access type

account_number

Account number

The account number

role_name

Role name

The role name.

external_id

External ID

The external ID.

status

Status

maximum: 2147483647

minimum: -2147483648

cloud_type

Cloud type

The cloud type such as AWS or Azure

azure_cpv

Azure cpv

Value = true if this is Azure

azure_csp_nce

Azure csp name

Value = true if this is Azure

tenant_name

Tenant name

Specifies the tenant name

Did this answer your question?