🚧

Limited Availability

The Correlation Pattern Run Order feature is available in a limited release. Please note that if this feature is not enabled in your organization, this API function will not work. If you’re interested in enabling this feature for your organization, contact your BigPanda account team. All accounts created after March 14th 2024 will have this feature available by default.

📘

Authentication

All BigPanda APIs require Bearer Token Authorization in the call headers.
This API uses the User API Key type of Authorization token.

🚧

Partial Ordering

When you use the API to update the run order of a few correlation patterns instead of all of them, the correlation patterns you update will be moved to the top of the run order. For example, if you have a list of seven correlation patterns and you only update the run order for three of them, those three will become the first three patterns to run.

🚧

Run order will be set to manual mode

Using this API call will set the run order for all correlation patterns to manual mode, regardless of how many patterns are updated. Any new patterns created while in manual mode will be added to the bottom of the run order.

Sample Calls

curl --request PUT \
     --url https://api.bigpanda.io/resources/v2.1/correlation-patterns-order \
     --header 'Authorization: Bearer <USER API KEY>' \
     --header 'Content-Type: application/json' \
     ---data '{
    "execution_order":
    [
    "6646dd33-bce3-4af0-861b-5271897e5ac4",
    "c1e8a9cc-8bbb-4fd3-8dec-c55eafd3d447",
    "393968c0-43ee-431b-9234-6cefe812ebd9"
        ]
    }'

curl --request PUT \
     --url https://eu-api.bigpanda.io/resources/v2.1/correlation-patterns-order \
     --header 'Authorization: Bearer <USER API KEY>' \
     --header 'Content-Type: application/json' \
     ---data '{
    "execution_order":
    [
    "6646dd33-bce3-4af0-861b-5271897e5ac4",
    "c1e8a9cc-8bbb-4fd3-8dec-c55eafd3d447",
    "393968c0-43ee-431b-9234-6cefe812ebd9"
        ]
    }'