topic Re: Sample REST api response for show-tasks, for a failed task in API / CLI Discussion

Sample REST api response for show-tasks, for a failed task

pdn — Wed, 01 Mar 2023 21:28:03 GMT

I can't find a sample REST api response for show-tasks, for a failed task. In our checkpoint fw, as well as checkpoint documentation (below).

Can someone here please share a sample failed task response? I am specifically interested in the comment field, for our automation effort.

Thanks,

Peter

https://sc1.checkpoint.com/documents/latest/APIs/?#web/show-tasks~v1.8%20

Re: Sample REST api response for show-tasks, for a failed task

pdn — Thu, 02 Mar 2023 01:20:00 GMT

Any feedback please? Anyone from Checkpoint tech support can help here?

Appreciate prompt response so I can move forward with my project.

Re: Sample REST api response for show-tasks, for a failed task

Amir_Senn — Thu, 02 Mar 2023 10:55:11 GMT

Hi, looking for something in particular?

Best way to create those error are start putting wrong/illegal values in the request.

Wrong or expired session ID, non-existing parameters or illegal values are a few ideas.

Re: Sample REST api response for show-tasks, for a failed task

pdn — Thu, 02 Mar 2023 15:38:04 GMT

Hhi Amir,

We just want to see the all the failed conditions and comments for the failed tasks, with that show-tasks endpoint.

I only have read-only access to our lab checkpoint firewall. So, I can't do those tests you suggested. Can you help do the test and share the failed responses?

Thanks,

Peter

Re: Sample REST api response for show-tasks, for a failed task

PhoneBoy — Thu, 02 Mar 2023 16:19:59 GMT

There are many reasons a task might fail.
If you cannot do these tests in your environment, I recommend checking out our automation lab: https://community.checkpoint.com/t5/R81-Automation-and-Orchestration/ct-p/r81-automation-orchestration
You can perform whatever tests you'd like there and see the precise API results.

Re: Sample REST api response for show-tasks, for a failed task

pdn — Thu, 02 Mar 2023 20:25:24 GMT

Thanks @PhoneBoy . I can try to play more in there. But if Checkpoint staff has a list readily to share, please do.

Re: Sample REST api response for show-tasks, for a failed task

PhoneBoy — Thu, 02 Mar 2023 22:49:12 GMT

If anything has any pre-prepared "examples" of a failed task, it would be Demo Mode.
However, it doesn't appear there is (only a task with a "Warning").
And, in any case, even if we are to provide an example, there may be different failure conditions and responses (depending on the task).

One example posted to the community for a failed policy installation: https://community.checkpoint.com/t5/API-CLI-Discussion/show-task-failure-with-quot-no-scope-found-for-client-session/m-p/136986#M6514
Another one is: https://community.checkpoint.com/t5/API-CLI-Discussion/Checkpoint-task-from-show-changes-API-command-fails/m-p/129509#M6237

You may be able to search the community and find other examples.

Re: Sample REST api response for show-tasks, for a failed task

pdn — Fri, 03 Mar 2023 19:28:35 GMT

Thank you again @PhoneBoy .