PyScripts Module REST API¶

GET /v1/rating/module_config/pyscripts/scripts¶

Get the script list

Parameters:	no_data (bool) – Set to True to remove script data from output.
Return:	List of every scripts.
Return type:	ScriptCollection

GET /v1/rating/module_config/pyscripts/scripts/(script_id)¶

Return a script.

Parameters:	script_id (uuid) – UUID of the script to filter on.
Return type:	Script

POST /v1/rating/module_config/pyscripts/scripts¶

Create pyscripts script.

Parameters:	script_data (Script) – Informations about the script to create.
Return type:	Script

PUT /v1/rating/module_config/pyscripts/scripts¶

Update pyscripts script.

Parameters:	script_id (uuid) – UUID of the script to update. script_data (Script) – Script data to update.
Return type:	Script

DELETE /v1/rating/module_config/pyscripts/scripts¶

Delete the script.

Parameters:	script_id (uuid) – UUID of the script to delete.

type Script¶

Type describing a script.

Data samples:

Json

{
    "checksum": "da39a3ee5e6b4b0d3255bfef95601890afd80709",
    "data": "return 0",
    "name": "policy1",
    "script_id": "bc05108d-f515-4984-8077-de319cbf35aa"
}

XML

b'<value>\n  <script_id>bc05108d-f515-4984-8077-de319cbf35aa</script_id>\n  <name>policy1</name>\n  <data>return 0</data>\n  <checksum>da39a3ee5e6b4b0d3255bfef95601890afd80709</checksum>\n</value>'

checksum¶

Checksum of the script data.

data¶

Data of the script.

name¶

Name of the script.

script_id¶

UUID of the script.

type ScriptCollection¶

Type describing a list of scripts.

Data samples:

Json

{
    "scripts": [
        {
            "checksum": "da39a3ee5e6b4b0d3255bfef95601890afd80709",
            "data": "return 0",
            "name": "policy1",
            "script_id": "bc05108d-f515-4984-8077-de319cbf35aa"
        }
    ]
}

XML

b'<value>\n  <scripts>\n    <item>\n      <script_id>bc05108d-f515-4984-8077-de319cbf35aa</script_id>\n      <name>policy1</name>\n      <data>return 0</data>\n      <checksum>da39a3ee5e6b4b0d3255bfef95601890afd80709</checksum>\n    </item>\n  </scripts>\n</value>'

scripts¶

List of scripts.