Skip to main content
Atomic Overwrite Span Policies
curl --request PUT \
  --url https://api.coralogix.com/mgmt/openapi/5/dataplans/span-policies/v1 \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "policies": [
    {
      "policy": {
        "description": "My Policy Description",
        "name": "My Policy",
        "applicationRule": {
          "name": "<string>"
        },
        "archiveRetention": {
          "id": "<string>"
        },
        "disabled": true,
        "priorityOverride": {
          "quotaBased": {
            "usageTiers": [
              {
                "dailyQuotaPercentage": 80
              }
            ]
          }
        },
        "subsystemRule": {
          "name": "<string>"
        },
        "targets": [
          {
            "archiveRetention": {
              "id": "<string>"
            },
            "dataset": "dataset1",
            "dataspace": "dataspace1",
            "priorityOverride": {
              "quotaBased": {
                "usageTiers": [
                  {
                    "dailyQuotaPercentage": 80
                  }
                ]
              }
            }
          }
        ]
      },
      "spanRules": {
        "actionRule": {
          "name": "<string>"
        },
        "serviceRule": {
          "name": "<string>"
        },
        "tagRules": [
          {
            "tagName": "tag_name",
            "tagValue": "tag_value"
          }
        ]
      }
    }
  ]
}
'
{
  "createResponses": [
    {
      "policy": {
        "companyId": 1234,
        "deleted": false,
        "enabled": true,
        "id": "policy_id",
        "logRules": {
          "severities": [],
          "dpxlExpression": "<string>"
        },
        "name": "My Policy",
        "order": 1,
        "applicationRule": {
          "name": "<string>"
        },
        "archiveRetention": {
          "id": "<string>"
        },
        "createdAt": "2021-01-01T00:00:00.000Z",
        "description": "My Policy Description",
        "priorityOverride": {
          "quotaBased": {
            "usageTiers": [
              {
                "dailyQuotaPercentage": 80
              }
            ]
          }
        },
        "priorityOverrideStatus": {
          "quotaBased": {
            "currentUsage": 123,
            "dailyLimit": 123
          }
        },
        "subsystemRule": {
          "name": "<string>"
        },
        "targets": [
          {
            "archiveRetention": {
              "id": "<string>"
            },
            "dataset": "dataset1",
            "dataspace": "dataspace1",
            "priorityOverride": {
              "quotaBased": {
                "usageTiers": [
                  {
                    "dailyQuotaPercentage": 80
                  }
                ]
              }
            }
          }
        ],
        "updatedAt": "2021-01-01T00:00:00.000Z"
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.coralogix.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API key authentication

Body

application/json

In an atomic operation delete all existing span policies and create the provided list by order.

​
policies
Create Span Policy Request · object[]
required

List of span policies to create as part of the atomic overwrite.

Response

This data structue is obtained when overwriting span policies atomically.

​
createResponses
Create Policy Response · object[]

The create responses.