Compliance APIs¶

Compliance - Run Compliance¶

• API for running the compliance on provided collection.

CURL Sample

curl -X POST https://portal.prancer.io/prancer-customer1/api/compliance/run/ -H 'authorization: Bearer <JWT Bearer Token>' -H 'content-type: application/json' -d '{ "collection" : "azure_cloud" }'

• URL: https://portal.prancer.io/prancer-customer1/api/compliance/run/
• Method: POST
• Header:

    - content-type: application/json
    - Authorization: Bearer <JWT Bearer Token>

• Param:

{
    "collection" : "azure_cloud"
}

• Explanation:

  Required Fields

  • collection: Name of the collection for which you want to run the compliance.

Response:

{
    "data": {},
    "error": "",
    "error_list": [],
    "message": "Compliance started running successfully.",
    "metadata": {},
    "status": 200
}

Compliance - Run Crawler¶

• API for running the crawler on provided collection.

CURL Sample

curl -X POST https://portal.prancer.io/prancer-customer1/api/compliance/crawler/ -H 'authorization: Bearer <JWT Bearer Token>' -H 'content-type: application/json' -d '{ "collection" : "azure_cloud" }'

• URL: https://portal.prancer.io/prancer-customer1/api/compliance/crawler/
• Method: POST
• Header:

    - content-type: application/json
    - Authorization: Bearer <JWT Bearer Token>

• Param:

{
    "collection" : "azure_cloud"
}

• Explanation:

  Required Fields

  • collection: Name of the collection for which you want to run the compliance.

Response:

{
    "data": {},
    "error": "",
    "error_list": [],
    "message": "Crawler started running successfully.",
    "metadata": {},
    "status": 200
}

Compliance - Add Schedulers¶

• API for adding a new Scheduler.

CURL Sample

curl -X POST \
  https://portal.prancer.io/prancer-customer1/api/compliance/scheduler/ \
  -H 'authorization: Bearer <JWT Bearer Token>' \
  -H 'content-type: application/json' \
  -d '{
    "collection":"azure_cloud",
    "schedule":"Daily@01:00 date@13/05/2021",
    "name":"Test",
    "description":"test ",
    "recur":"1",
    "test":"CRAWLER",
    "crawler":true,
    "pac" : true,
    "webhook" : {
        "webhook_url" : "https://portal.prancer.io/prancer-customer1/api/run/compliance",
        "webhook_data" : {
            "config_id" : "620e24b4a3ddf04e384543b9"
        },
        "webhook_method" : "POST",
        "webhook_headers" : {}
    }
}'

• URL: https://portal.prancer.io/prancer-customer1/api/compliance/scheduler/
• Method: POST
• Header:

    - content-type: application/json
    - Authorization: Bearer <JWT Bearer Token>

• Param:

{
    "collection":"azure_cloud",
    "schedule":"Daily@01:00 date@13/05/2021",
    "name":"Test",
    "description":"test ",
    "recur":"1",
    "test":"CRAWLER",
    "crawler":true,
    "pac" : true,
    "job_type" : "pac"
    "webhook" : {
        "webhook_url" : "<PAC url>",
        "webhook_data" : {
            "config_id" : "620e24b4a3ddf04e384543b9"
        },
        "webhook_method" : "GET",
        "webhook_headers": {
            "token_name":"scheduler-notify-1662959297881",
            "token_id":"631ebec1c5d1d17f93aa0b45"
        }
    }
}

• Explanation:

  Required Fields

  • collection: Name of the collection for which you want to schedule a Job. Optional if pac is true.
  • schedule: We can schedule the following types of Schedulers.
    • Once ( Ex. once@11:00 date@10/26/2019 )
    • Hourly ( Ex. hourly@11:00 date@10/26/2019 )
    • Daily ( Ex. daily@11:00 date@10/26/2019 )
    • Weekly ( Ex. weekly@11:00 date@10/26/2019 )
    • Monthly ( Ex. monthly@11:00 date@10/26/2019 )
  • name: Name of the Scheduler Job.
  • description: Description about the Scheduler Job.
  • recur: It defines the Job will run after no. of recuring defined. ( Ex. recur is 2, then Job will run after every 2 hours )
  • test : Valid value for this field is TEST, CRAWLER and BOTH.
    • TEST: Run the only compliance on specified collection.
    • CRAWLER: Run only crawler on specified collection.
    • BOTH: Run both Crawler and then compliance on specified collection.
  • crawler : Require to set this field to true if the test value is CRAWLER or BOTH.

  Optional Fields

  • pac : Boolean field to represent the scheduler is set for PAC. collection attribute is optional if pac is true.
  • job_type : Valid value for this field is iac, cspm and pac. if value of pac is not set or is false then default value of job_type is iac and if value of pac is true then default value of job_type is pac.
  • webhook : If you want to get the callback on any API server then you can define the webhook.
    • webhook_url : API url which you want to call while scheduler run.
    • webhook_data : Data in JSON format, which you want to pass in callback API.
    • webhook_method : API method type. It can be either "POST", "PUT", "DELETE","GET".
    • webhook_headers : Header data in JSON format which you want to pass in callback request.

• NOTE: scheduled DateTime is considered in UTC timezone

Response:

{
    "data": {
        "jobs": [
            {
                "id": "azure_cloud_nbyrl_9441",
                "name": "azure_cloud",
                "next_run_time": "2021-05-14 01:00:00"
            }
        ]
    },
    "error": "",
    "error_list": [],
    "message": "Job scheduled successfully",
    "metadata": {},
    "status": 200
}

Compliance - Update Schedulers¶

• API for update the existing scheduler.

CURL Sample

curl -X PUT \
  https://portal.prancer.io/prancer-customer1/api/compliance/scheduler/ \
  -H 'authorization: Bearer <JWT Bearer Token>' \
  -H 'content-type: application/json' \
  -d '{
    "id": "azure_cloud_nbyrl_9441",
    "collection":"azure_cloud",
    "schedule":"Daily@03:00 date@13/04/2022",
    "name":"Updated Name",
    "description":"Updated Description",
    "recur":"2",
    "test":"CRAWLER",
    "crawler":true,
    "pac" : true,
    "webhook" : {
        "webhook_url" : "https://portal.prancer.io/prancer-customer1/api/run/compliance",
        "webhook_data" : {
            "config_id" : "620e24b4a3ddf04e384543b9"
        },
        "webhook_method" : "POST",
        "webhook_headers" : {}
    }
}'

• URL: https://portal.prancer.io/prancer-customer1/api/compliance/scheduler/
• Method: PUT
• Header:

    - content-type: application/json
    - Authorization: Bearer <JWT Bearer Token>

• Param:

{
    "id": "azure_cloud_nbyrl_9441",
    "collection":"azure_cloud",
    "schedule":"Daily@01:00 date@13/05/2021",
    "name":"Test",
    "description":"test ",
    "recur":"1",
    "test":"CRAWLER",
    "crawler":true,
    "pac" : true,
    "webhook" : {
        "webhook_url" : "https://portal.prancer.io/prancer-customer1/api/run/compliance",
        "webhook_data" : {
            "config_id" : "620e24b4a3ddf04e384543b9"
        },
        "webhook_method" : "POST",
        "webhook_headers" : {}
    }
}

• Explanation:

  Required Fields

  • collection: Name of the collection for which you want to scheduler a Job. Optional if pac is true.
  • schedule: We can schedule the following types of Schedulers.
    • Once ( Ex. once@11:00 date@10/26/2019 )
    • Hourly ( Ex. hourly@11:00 date@10/26/2019 )
    • Daily ( Ex. daily@11:00 date@10/26/2019 )
    • Weekly ( Ex. weekly@11:00 date@10/26/2019 )
    • Monthly ( Ex. monthly@11:00 date@10/26/2019 )
  • name: Name of the Scheduler Job.
  • description: Description about the Scheduler Job.
  • recur: It defines the Job will run after no. of recuring defined. ( Ex. recur is 2, then Job will run after every 2 hours )
  • test : Valid value for this field is TEST, CRAWLER and BOTH.
    • TEST: Run the only compliance on specified collection.
    • CRAWLER: Run only crawler on specified collection.
    • BOTH: Run both Crawler and then compliance on specified collection.
  • crawler : Require to set this field to true if the test value is CRAWLER or BOTH.

  Optional Fields

  • pac : Boolean field to represent the scheduler is set for PAC. collection attribute is optional if pac is true.
  • webhook : If you want to get the callback on any API server then you can define the webhook.
    • webhook_url : API url which you want to call while scheduler run.
    • webhook_data : Data in JSON format, which you want to pass in callback API.
    • webhook_method : API method type. It can be either "POST", "PUT", "DELETE","GET".
    • webhook_headers : Header data in JSON format which you want to pass in callback request.

• NOTE: scheduled DateTime is considered in UTC timezone

Response:

{
    "data": {
        "jobs": [
            {
                "id": "azure_cloud_nbyrl_9441",
                "name": "azure_cloud",
                "next_run_time": "2021-05-14 01:00:00"
            }
        ]
    },
    "error": "",
    "error_list": [],
    "message": "Job scheduled successfully",
    "metadata": {},
    "status": 200
}

Compliance - Get scheduler list¶

• API for getting the list of scheduled jobs.

CURL Sample

curl -X GET \
  https://portal.prancer.io/prancer-customer1/api/compliance/scheduler/?collection=aws_cspm_test&count=3&index=0 \
  -H 'authorization: Bearer <JWT Bearer Token>' \
  -H 'content-type: application/json'

• URL: https://portal.prancer.io/prancer-customer1/api/compliance/scheduler/
• Method: GET
• Header:

    - content-type: application/json
    - Authorization: Bearer <JWT Bearer Token>

• Param:

{
    "collection": "azure_cloud",
    "count" : 3,
    "index" : 0
}

• Explanation:

  Optional Fields

  • collection: Name of the collection for which you want to filter the Jobs.
  • index: determines from which index have to start populating of the data.
  • count: determines the number of records per page need to populate in response.

NOTE: - index and count parameters are useful for pagination. If no index pass then it will return all the records.

Response:

{
    "data": {
        "jobs": [
            {
                "collection": "azure_cloud",
                "crawler": true,
                "description": "Wizard Created azure_cloud scheduled",
                "id": "azure_cloud_nbyrl_9441",
                "name": "Scheduled azure_cloud",
                "next_run_time": "2021-05-13 15:30:00",
                "recur": "2",
                "schedule": "Hourly@15:00 date@12/05/2021",
                "test": "BOTH",
                "job_type": "cspm"
            }
        ]
    },
    "error": "",
    "error_list": [],
    "message": "",
    "metadata": {},
    "status": 200
}

Compliance - Get a scheduler¶

• API for get a scheduled job.

CURL Sample

curl -X GET \
  https://portal.prancer.io/prancer-customer1/api/compliance/scheduler/?scheduler_id=azure_cloud_nbyrl_9441 \
  -H 'authorization: Bearer <JWT Bearer Token>' \
  -H 'content-type: application/json'

• URL: https://portal.prancer.io/prancer-customer1/api/compliance/scheduler/
• Method: GET
• Header:

    - content-type: application/json
    - Authorization: Bearer <JWT Bearer Token>

• Param:

{
    "scheduler_id" : "azure_cloud_nbyrl_9441"
}

• Explanation:

  Required Fields

  • scheduler_id: Id of the Scheduled Job.

Response:

{
    "data": {
        "collection": "azure_cloud",
        "crawler": true,
        "description": "Wizard Created azure_cloud scheduled",
        "id": "azure_cloud_nbyrl_9441",
        "name": "Scheduled azure_cloud",
        "next_run_time": "2021-05-13 15:30:00",
        "recur": "2",
        "schedule": "Hourly@15:00 date@12/05/2021",
        "test": "BOTH"
    },
    "error": "",
    "error_list": [],
    "message": "",
    "metadata": {},
    "status": 200
}

Compliance - Delete scheduler¶

• API for deleting a scheduled job.

CURL Sample

curl -X DELETE \
  https://portal.prancer.io/prancer-customer1/api/compliance/scheduler/ \
  -H 'authorization: Bearer <JWT Bearer Token>' \
  -H 'content-type: application/json' \
  -d '{
    "id" : "azure_cloud_nbyrl_9441"
}'

• URL: https://portal.prancer.io/prancer-customer1/api/compliance/scheduler/
• Method: DELETE
• Header:

    - content-type: application/json
    - Authorization: Bearer <JWT Bearer Token>

• Param:

{
    "id" : "azure_cloud_nbyrl_9441"
}

• Explanation:

  Required Fields

  • id: Id of the Scheduled Job.

Response:

{
    "data": {},
    "error": "",
    "error_list": [],
    "message": "Job deleted successfully",
    "metadata": {},
    "status": 200
}

Compliance - List Queued Tasks¶

• CURL Sample

curl -X GET \
   'https://portal.prancer.io/prancer-customer1/api/compliance/scheduler/queue' \
-H 'authorization: Bearer <JWT Bearer Token>' \
-H 'content-type: application/json' \

• URL: https://portal.prancer.io/prancer-customer1/api/compliance/scheduler/queue
• Method: GET
• Header:

    - content-type: application/json
    - Authorization: Bearer <JWT Bearer Token>

• Response:

{
    "data": {
        "results": [
            {
                "container": "aws_cloud",
                "logname": "logs_20220617115442_qtrke_7132",
                "name": "invoke_manual_crawler",
                "start": 1655466882334,
                "state": "INITIALIZED",
                "taskid": "task_aws_cloud_zpnaxzgm_40529109"
            },
            {
                "container": "azure_cloud",
                "logname": "logs_20220617115441_evdoc_5283",
                "name": "invoke_manual_crawler",
                "start": 1655466881315,
                "state": "INITIALIZED",
                "taskid": "task_aws_cloud_cgbaygqq_84586401"
            },
            {
                "container": "aws_cloud",
                "logname": "logs_20220617113000_uumoz_5498",
                "name": "invoke_schedule_crawler_and_test",
                "start": 1655465400349,
                "state": "RUNNING",
                "taskid": "task_aws_cloud_mgxlaxwy_33110286"
            }
        ]
    },
    "error": "",
    "error_list": [],
    "message": "Tasks list",
    "metadata": {},
    "status": 200
}

Compliance - Delete Queued Tasks¶

• CURL Sample

curl --location --request DELETE 'https://portal.prancer.io/prancer-customer1/api/compliance/scheduler/queue' \
-H 'authorization: Bearer <JWT Bearer Token>' \
-H 'content-type: application/json' \
-d '{
    "taskid" : "task_aws_cloud_cgbaygqq_84586401"
}'

• URL: https://portal.prancer.io/prancer-customer1/api/compliance/scheduler/queue
• Method: DELETE
• Header:

    - content-type: application/json
    - Authorization: Bearer <JWT Bearer Token>

• Param:

{
    "taskid" : "task_aws_cloud_cgbaygqq_84586401"
}

• Explanation:

  Required Fields

  • taskid: Id of the task which is currently exist in the queue.

Response:

{
    "data": {},
    "error": "",
    "error_list": [],
    "message": "Task cancelled",
    "metadata": {},
    "status": 200
}