v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB
Storage Management

Enable Storage Management for a bucket

Enable Storage Management for an S3 bucket, GCS bucket, or Azure container by registering the destination that holds its inventory reports. Set data.id to the cloud provider (aws, gcp, or azure) and provide the matching settings under data.attributes. Calling this endpoint with the same provider replaces the existing configuration.

put/api/v2/cloudinventoryservice/syncconfigs

Request body

Example request

{
  "data": {
    "attributes": {
      "aws": {
        "aws_account_id": "123456789012",
        "destination_bucket_name": "my-inventory-bucket",
        "destination_bucket_region": "us-east-1",
        "destination_prefix": "logs/"
      },
      "azure": {
        "client_id": "11111111-1111-1111-1111-111111111111",
        "container": "inventory-container",
        "resource_group": "my-resource-group",
        "storage_account": "mystorageaccount",
        "subscription_id": "33333333-3333-3333-3333-333333333333",
        "tenant_id": "22222222-2222-2222-2222-222222222222"
      },
      "gcp": {
        "destination_bucket_name": "my-inventory-reports",
        "project_id": "my-gcp-project",
        "service_account_email": "reader@my-gcp-project.iam.gserviceaccount.com",
        "source_bucket_name": "my-monitored-bucket"
      }
    },
    "id": "aws",
    "type": "cloud_provider"
  }
}

Response

OK

Example response

{
  "data": {
    "attributes": {
      "aws_account_id": "123456789012",
      "aws_bucket_name": "my-inventory-bucket",
      "aws_region": "us-east-1",
      "azure_client_id": "11111111-1111-1111-1111-111111111111",
      "azure_container_name": "inventory-container",
      "azure_storage_account_name": "mystorageaccount",
      "azure_tenant_id": "22222222-2222-2222-2222-222222222222",
      "cloud_provider": "aws",
      "gcp_bucket_name": "my-inventory-reports",
      "gcp_project_id": "my-gcp-project",
      "gcp_service_account_email": "reader@my-gcp-project.iam.gserviceaccount.com",
      "prefix": "logs/"
    },
    "id": "abc123",
    "type": "sync_configs"
  }
}