Page tree
Skip to end of metadata
Go to start of metadata

Overview

This topic only applies to Armor Anywhere users.

The Post Cloud Connections (Save Cloud Connection) API allows you to create and update a cloud connection. 

You can use the POST Cloud Connections API to find the connectionsId (id).


Sample request

POST https://api.armor.com/cloud-connections/savecloudconnection
{
  "id": 1,
  "name": "AWS(Development)",
  "externalId": "70251890-4279-481b-b9e7-614293696c59",
  "provider": "AWS",
  "providerAccountId": "345186984524",
  "total": 1,
  "isEnabled_Ec2": false,
  "isEnabled_Log": false,
  "setupStatus": "Completed"
}

Input

Error rendering macro 'excerpt-include'

No link could be created for 'API table parts (snippet)'.

API Call / URLMethod / Type
/cloud-connections/savecloudconnectionPOST


Error rendering macro 'excerpt-include'

No link could be created for 'Parameters to include (snippet)'.

ParameterDescriptionFormatRequired or optionalExample
connectionNameA descriptive name for the cloud connectionString

Required to create a cloud connection

Optional to update a cloud connection

AWS(Development)
descriptionA description for the cloud connection, such as My development environment in AWS.


providerAccountId

 Provider account id




armorAwsAccountId

The AWS account number for Armor. The account number is 679703615338.

String
679703615338
externalId

Armor generates an external ID for each cloud connection account you create. You can copy and paste an external ID from the Cloud Connection Detail page.

To learn more about this screen, see Cloud Connections.



providerAccessResource





providerTypeName:





accountConnectionId





serviceTypeName

The type of data that Armor will retrieve, such as CloudTrail logs.


accountId

The Role ARN information from your AWS account.String
















externalId

Required to create a cloud connection

Optional to update a cloud connection

c8bbf361-a6bd-410b-b004-2dea79839d1e
providerThe public cloud account provider

Required to create a cloud connection

Optional to update a cloud connection

AWS
providerAccountId

Required to create a cloud connection

Optional to update a cloud connection

345186984524
total

Required to create a cloud connection

Optional to update a cloud connection

1
isEnabled_Ec2

Required to create a cloud connection

Optional to update a cloud connection

false
isEnabled_Log

Required to create a cloud connection

Optional to update a cloud connection

false
setupStatus

Required to create a cloud connection

Optional to update a cloud connection

Completed

Sample return

StatusResponse
200
{
  "id": 1,
  "name": "AWS(Development)",
  "externalId": "c8bbf361-a6bd-410b-b004-2dea79839d1e",
  "provider": "AWS",
  "providerAccountId": "345186984524",
  "total": 1,
  "isEnabled_Ec2": false,
  "isEnabled_Log": false,
  "setupStatus": "Completed"
}

  • No labels
Write a comment…