Page Contents

Parsers

Parsers¶

Parsers - Check¶

Checks the regex pattern.

POST

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

Parameter

Field	Label in UI	Type	Description
example	Example	String	Sample value to match with the pattern parameter. Mandatory Field
name	Name	String	Name of parser. Mandatory Field
pattern	Pattern	String	Regex pattern. Mandatory Field

Request Example

{
    "data": {
        "example": "\"123\"",
        "name": "testName",
        "pattern": "\"[0-9]{3}\""
    }
}

Success Response

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

Parsers - Create¶

Creates a new Parser.

POST

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

Parameter

Field	Label in UI	Type	Description
example	Example	String	Sample value to match with the pattern parameter. Mandatory Field
name	Name	String	Name of the parser. Mandatory Field
pattern	Pattern	String	Regex pattern. Mandatory Field

Request Example

{
    "data": {
        "example": "\"123\"",
        "name": "testName",
        "pattern": "\"[0-9]{3}\""
    }
}

Success Response

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

Parsers - Edit¶

Edits a parser

PUT

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

Parameter

Field	Label in UI	Type	Description
example	Example	String	Sample value to match. Mandatory Field
id	-	String	Existing parser id . Mandatory Field
pattern	Pattern	String	Regex pattern. Mandatory Field

Request Example

{
    "data": {
        "example": "\"123\"",
        "pattern": "\"[0-9]{3}\""
    }
}

Success Response

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

Parsers - Get¶

Fetches a Parser with given ID.

GET

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

Parameter

Field	Label in UI	Type	Description
id	-	String	Existing Parser id .

Success Response

{
    "_permission": {
        "delete": false,
        "edit": false
    },
    "active": true,
    "id": "590ff83bd8aaa45bad0d9b0d",
    "name": "LineParser",
    "pattern": "",
    "tid": "",
    "type": "LineParser",
    "user": "LogPoint",
    "vid": "LineParser"
}

Parsers - List¶

Lists all Parsers.

GET

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

Success Response

[
    {
        "_permission": {
            "delete": false,
            "edit": false
        },
        "active": true,
        "id": "590ff83bd8aaa45bad0d9b0d",
        "name": "LineParser",
        "pattern": "",
        "tid": "",
        "type": "LineParser",
        "user": "LogPoint",
        "vid": "LineParser"
    },
    {
        "_permission": {
            "delete": true,
            "edit": true
        },
        "active": true,
        "example": "\"123\"",
        "id": "59156b65d8aaa42d2f2c72f7",
        "name": "Test6",
        "pattern": "\"[0-9]{3}\"",
        "tid": "",
        "type": "RegexParser",
        "user": "admin",
        "vid": ""
    }
]

Parsers - Trash¶

Deletes a regex pattern with given ID.

DELETE

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

Parameter

Field	Label in UI	Type	Description
id	-	String	Existing parser id . Mandatory Field

Success Response

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

Helpful?