Get Status Detail
Description
Get list cloud account detailed information and status.
URL
/api/v1/service/status/detail
Method: GET
Request Headers
Key |
Value |
Type |
Description |
---|---|---|---|
companyId | <12345> | String | Company ID - Company ID can be obtained through Get Resource Map |
Authorization | Bearer <Authorization Token> | String | Authorization credential generated by FortiCWP |
service |
String |
Cloud service such as AWS, Google Cloud, etc. |
|
serviceId |
<7234> |
String |
Service ID to distinguish different account of the cloud service in FortiCWP |
Content-Type | application/json | String |
Sample Request
Request URL |
GET https://www.forticwp.com/api/v1/service/status/detail |
Request Header |
Authorization: Bearer <Authorization_Token> companyId: 1 Content-Type: application/json serviceId: 143288111682 service: AWS |
Response Variables
Name |
Type |
Description |
---|---|---|
companyId | String | Company id |
BuId | integer | Business ID, one service ID per Business ID |
service | Application | Cloud service |
applicationInfo | JsonObject | Detail information of the cloud service |
authMethod | String | Service authentication type |
enable | boolean | Check whether the service is enabled or note |
status | String | License status of the cloud service |
statusInfoList | Array | The cloud service health check result |
applicationInfo.applicationId | String | ID to distinguish different account of the cloud service in FortiCWP |
applicationInfo.accNum | String | AWS account number, valid only if service is AWS |
applicationInfo.clName | String | AWS cloud trail name, valid only if service is AWS |
applicationInfo.cls3 | String | AWS cloud trail s3 bucket name, valid only service is AWS |
applicationInfo.sessionName | String | AWS session name for Forticwp monitoring, valid only if service is AWS |
applicationInfo.name | String | Cloud service name such as AWS, Google Cloud, etc. |
applicationInfo.externalId | String | AWS role external ID, valid only if service is AWS |
applicationInfo.arn | String | AWS Role ARN, valid only if service is AWS |
applicationInfo.email | String | Cloud srvice connection user email address |
applicationInfo.tid | String | AZURE tenant id, valid only if service is AZURE |
applicationInfo.sid | String | AZURE subscription id, valid only if service is AZURE |
applicationInfo.serviceAccount | String | GoogleCloud service account id, valid only if service is GoogleCloud |
applicationInfo.od | String | GoogleCloud organization id, valid only if service is GoogleCloud |
Sample Response
{
"companyId":2,
"BuId":25064,
"service":"AWS",
"applicationInfo":{
"clName":"forticwp-cloud-trail",
"accNum":"143288111685",
"sessionName":"FortiCWP",
"cls3":"forticwp-forticwpbucket-1lfyt0yhoucsw",
"name":"143288111685",
"externalId":"FortiCWP",
"applicationId":"143288111685",
"arn":"arn:aws:iam::143288111685:role/role_for_forticwp_subaccount_cloudtrail_v20.1"
},
"authMethod":"AWS_AUTO",
"enable":true,
"status":"LICENSE"
}