v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB
Logs Archives

Update an archive

Update a given archive configuration.

Note: Using this method updates your archive configuration by replacing your current configuration with the new one sent to your Datadog organization.

put/api/v2/logs/config/archives/{archive_id}

Path parameters

archive_idstring required

The ID of the archive.

Request body

Example request

{
  "data": {
    "attributes": {
      "compression_method": "GZIP",
      "destination": {
        "container": "container-name",
        "integration": {
          "client_id": "aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa",
          "tenant_id": "aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa"
        },
        "storage_account": "account-name",
        "type": "azure"
      },
      "lookup_attributes": [
        "trace_id",
        "user_id"
      ],
      "name": "Nginx Archive",
      "partitioning_attributes": [
        "service",
        "status"
      ],
      "query": "source:nginx",
      "rehydration_max_scan_size_in_gb": 100,
      "rehydration_tags": [
        "team:intake",
        "team:app"
      ]
    },
    "type": "archives"
  }
}

Response

OK

Example response

{
  "data": {
    "attributes": {
      "compression_method": "GZIP",
      "destination": {
        "container": "container-name",
        "integration": {
          "client_id": "aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa",
          "tenant_id": "aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa"
        },
        "storage_account": "account-name",
        "type": "azure"
      },
      "lookup_attributes": [
        "trace_id",
        "user_id"
      ],
      "name": "Nginx Archive",
      "partitioning_attributes": [
        "service",
        "status"
      ],
      "query": "source:nginx",
      "rehydration_max_scan_size_in_gb": 100,
      "rehydration_tags": [
        "team:intake",
        "team:app"
      ],
      "state": "WORKING"
    },
    "id": "a2zcMylnM4OCHpYusxIi3g",
    "type": "archives"
  }
}