Palo Alto Networks Compliance Frameworks API
Operations for managing compliance framework definitions including CRUD, clone, benchmark, and release operations.
Operations 16
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
Ask an LLM
“Which compliance frameworks exist in my tenant service group, via the unversioned definitions endpoint?”
“Can the short /definitions listing filter frameworks by category or status?”
Tell an agent
Using the unversioned definitions endpoint, list all compliance frameworks.
Via the short-path definitions API, list frameworks in category {category} with status {status}.
Ask an LLM
“How do I define a new compliance framework through the unversioned definitions endpoint?”
“Does the server assign the id when I post a framework to the short /definitions path?”
Tell an agent
Through the unversioned definitions endpoint, create compliance framework {name}.
Post a framework named {name} sourced from {source_url} to the short-path definitions API.
Ask an LLM
“Can I fetch the in-progress draft of a framework from the unversioned definitions endpoint?”
“What does the op parameter choose when reading a framework on the short /definitions path?”
Tell an agent
From the unversioned definitions endpoint, get framework {id} with op {op}.
Via the short-path API, show the released revision of framework {id} using op {op}.
PUT
/definitions/{id}
Update a compliance framework (unversioned path) · Update Compliance Framework
#
Ask an LLM
“How does editing a framework on the unversioned endpoint decide between the in-progress draft and a new revision?”
“Can I release a framework revision right away when updating through the short /definitions path?”
Tell an agent
On the unversioned definitions endpoint, rename framework {id} to {name}.
Via the short-path API, update framework {id} and set release to {release}.
DELETE
/definitions/{id}
Delete a compliance framework (unversioned path) · Delete Compliance Framework
#
Ask an LLM
“Does deleting a framework on the unversioned definitions endpoint remove every revision too?”
“Is framework deletion through the short /definitions path permanent?”
Tell an agent destructive · confirm first
Permanently delete framework {id} via the unversioned definitions endpoint.
Remove framework {id} and its revisions using the short /definitions path.
POST
/definitions/{id}:clone
Clone a compliance framework (unversioned path) · Clone Compliance Framework
#
Ask an LLM
“Can I copy an existing framework into my TSG using the unversioned clone action?”
“What call on the short /definitions path duplicates a framework?”
Tell an agent
Clone framework {id} with the unversioned definitions clone action.
Duplicate framework {id} into my TSG through the short-path API.
POST
/definitions/{id}:benchmark
Mark framework as benchmark (unversioned path) · Benchmark Compliance Framework
#
Ask an LLM
“How do I flag a framework as a benchmark on the unversioned definitions endpoint?”
“Which short-path action sets the benchmark designation on a framework?”
Tell an agent
Using the unversioned endpoint, mark framework {id} as a benchmark.
Flag framework {id} as benchmark via the short /definitions path.
POST
/definitions/{id}:un-benchmark
Remove benchmark flag (unversioned path) · Remove Framework Benchmark
#
Ask an LLM
“Can I clear the benchmark designation from a framework via the unversioned definitions endpoint?”
“Which short-path action un-benchmarks a framework?”
Tell an agent
Via the short-path API, remove the benchmark flag from framework {id}.
Un-benchmark framework {id} on the unversioned definitions endpoint.
GET
/compliance-frameworks/v1/definitions
List compliance frameworks (v1 API) · List Compliance Frameworks
#
Ask an LLM
“What compliance frameworks does the v1 compliance-frameworks API return for my TSG?”
“Can I filter the v1 framework list down to one category or a status?”
Tell an agent
List all compliance frameworks with the v1 compliance-frameworks API.
With the v1 API, list frameworks whose category is {category} and status is {status}.
POST
/compliance-frameworks/v1/definitions
Create a compliance framework (v1 API) · Create Compliance Framework
#
Ask an LLM
“Can I create a custom compliance framework with a hierarchy using the v1 compliance-frameworks API?”
“Which fields does the v1 API accept when I add a framework, such as source URL and logo?”
Tell an agent
Create a v1 compliance framework called {name} described as {description}.
With the v1 API, add framework {name} in category {category}.
GET
/compliance-frameworks/v1/definitions/{id}
Get a framework revision (v1 API) · Get Framework Revision
#
Ask an LLM
“How do I read the currently released revision of a framework with the v1 compliance-frameworks API?”
“Can the v1 API return a framework's in-progress revision instead of the released one?”
Tell an agent
Get v1 compliance framework {id} using op {op}.
Show the in-progress revision of framework {id} from the v1 API with op {op}.
PUT
/compliance-frameworks/v1/definitions/{id}
Update a compliance framework (v1 API) · Update Compliance Framework
#
Ask an LLM
“Does updating a framework through the v1 API create a new in-progress revision when none exists?”
“Can I publish my framework edits immediately with the v1 release flag?”
Tell an agent
Update v1 compliance framework {id} with description {description}.
Edit framework {id} in the v1 API and release it with release {release}.
DELETE
/compliance-frameworks/v1/definitions/{id}
Delete a compliance framework (v1 API) · Delete Compliance Framework
#
Ask an LLM
“Can I permanently remove a framework and all its revisions with the v1 compliance-frameworks API?”
“What gets deleted along with a framework in the v1 API?”
Tell an agent destructive · confirm first
Delete v1 compliance framework {id} and all of its revisions.
Permanently remove framework {id} through the v1 compliance-frameworks API.
POST
/compliance-frameworks/v1/definitions/{id}:clone
Clone a compliance framework (v1 API) · Clone Compliance Framework
#
Ask an LLM
“Can I duplicate a compliance framework into my TSG with the v1 API?”
“Which v1 compliance-frameworks action makes a copy of an existing framework?”
Tell an agent
Make a v1 copy of compliance framework {id} in my TSG.
Clone framework {id} using the v1 compliance-frameworks clone action.
POST
/compliance-frameworks/v1/definitions/{id}:benchmark
Mark framework as benchmark (v1 API) · Benchmark Compliance Framework
#
Ask an LLM
“Can I designate a framework as a benchmark using the v1 compliance-frameworks API?”
“Which v1 action turns a framework into a benchmark?”
Tell an agent
Designate v1 compliance framework {id} as a benchmark.
Use the v1 API to set the benchmark designation on framework {id}.
POST
/compliance-frameworks/v1/definitions/{id}:un-benchmark
Remove benchmark flag (v1 API) · Remove Framework Benchmark
#
Ask an LLM
“How do I stop a framework from being a benchmark with the v1 compliance-frameworks API?”
“Which v1 action removes the benchmark designation?”
Tell an agent
Take the benchmark designation off v1 compliance framework {id}.
Use the v1 API to un-benchmark framework {id}.