ProcessingPolicy

ProcessingPolicy - Create

Adds a new Processing Policy.

POST

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/ProcessingPolicy

Parameter

Field

Label in UI

Type

Description

enrich_policy

Enrichment Policy

String

Existing Enrichment Policy id or None(exact). Use the value of the id parameter from EnrichmentPolicy - List API to obtain Enrichment Policy id . Mandatory Field

norm_policy

Normalization Policy

String

Existing Normalization Policy name or None(exact). Use the value of the name parameter from NormalizationPolicy - List API to obtain the value of Normalization Policy name . Mandatory Field

policy_name

Policy Name

String

Processing Policy name . Mandatory Field

routing_policy

Routing Policy

String

Existing Routing Policy id or None (exact). Use the value of the id parameter from RoutingPolicy - List API to obtain Routing Policy id . Mandatory Field

Request Example

{
    "data": {
        "enrich_policy": "57591a2cd8aaa41bfef54888",
        "norm_policy": "_logpoint",
        "policy_name": "policyName",
        "routing_policy": "586cc3edd8aaa406f6fdc8e3"
    }
}

Success Response

{
    "status": "Success",
    "message": "/monitorapi/{pool_UUID}/{logpoint_identifier}/orders/{request_id}"
}

ProcessingPolicy - Edit

Edits the Processing Policy with given ID.

PUT

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/ProcessingPolicy/{id}

Parameter

Field

Label in UI

Type

Description

enrich_policy

Enrichment Policy

String

Existing Enrichment Policy id or None(exact). Use the value of the id parameter from EnrichmentPolicy - List API to obtain Enrichment Policy id . Mandatory Field

id

-

String

Existing Processing Policy id . Mandatory Field

norm_policy

Normalization Policy

String

Existing Normalization Policy name or None(exact). Use the value of the name parameter from NormalizationPolicy - List API to obtain the value of Normalization Policy name . Mandatory Field

policy_name

Policy Name

String

Processing Policy name . Mandatory Field

routing_policy

Routing Policy

String

Existing Routing Policy id or None (exact). Use the value of the id parameter from RoutingPolicy - List API to obtain Routing Policy id . Mandatory Field

Request Example

{
    "data": {
        "enrich_policy": "57591a2cd8aaa41bfef54888",
        "norm_policy": "_logpoint",
        "policy_name": "policyName",
        "routing_policy": "586cc3edd8aaa406f6fdc8e3"
    }
}

Success Response

{
    "status": "Success",
    "message": "/monitorapi/{pool_UUID}/{logpoint_identifier}/orders/{request_id}"
}

ProcessingPolicy - Get

Fetches the Processing Policy with given ID.

GET

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/ProcessingPolicy/{id}

Parameter

Field

Label in UI

Type

Description

id

-

String

Existing Processing Policy id . Use the value of the id parameter of the required Processing Policy from ProcessingPolicy - List API.

Success Response

{
    "active": true,
    "enrich_policy": "None",
    "id": "59099afa854ff52b6819a739",
    "norm_policy": "None",
    "policy_name": "test_processingpolicy7",
    "routing_policy": "590961d2d8aaa45aa5501ce2",
    "tid": ""
}

ProcessingPolicy - List

Lists all Processing Policies.

GET

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/ProcessingPolicy

Success Response

[
    {
        "active": true,
        "enrich_policy": "None",
        "id": "590961d2d8aaa45aa5501cdf",
        "norm_policy": "_logpoint",
        "policy_name": "_logpoint",
        "routing_policy": "590961d2d8aaa45aa5501cdd",
        "tid": ""
    },
    {
        "active": true,
        "enrich_policy": "57591a2cd8aaa41bfef54888",
        "id": "590961d2d8aaa45aa5501ce0",
        "norm_policy": "None",
        "policy_name": "default",
        "routing_policy": "590961d2d8aaa45aa5501cde",
        "tid": ""
    }
]

ProcessingPolicy - Trash

Deletes the Processing Policy with given ID.

DELETE

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/ProcessingPolicy/{id}

Parameter

Field

Label in UI

Type

Description

id

-

String

Existing Processing Policy id . Use the value of the id parameter of the Processing Policy to be deleted from ProcessingPolicy - List API. Mandatory Field

Success Response

{
    "status": "Success",
    "message": "/monitorapi/{pool_UUID}/{logpoint_identifier}/orders/{request_id}"
}

Helpful?

We are glad this guide helped.


Please don't include any personal information in your comment

Contact Support