Policy > Infra > Hierarchical API

Associated URIs:

API Description API Path

Read infra


Read infra. Returns only the infra related properties. Inner object
are not populated.
GET /policy/api/v1/infra
GET /policy/api/v1/global-infra
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra

Update the infra including all the nested entities


Patch API at infra level can be used in two flavours
1. Like a regular API to update Infra object
2. Hierarchical API: To create/update/delete entire or part of intent
hierarchy
Hierarchical API: Provides users a way to create entire or part of
intent in single API invocation. Input is expressed in a tree format.
Each node in tree can have multiple children of different types.
System will resolve the dependecies of nodes within the intent tree
and will create the model. Children for any node can be specified using
ChildResourceReference or ChildPolicyConfigResource.
If a resource is specified using ChildResourceReference then it will
not be updated only its children will be updated. If Object is specified
using ChildPolicyConfigResource, object along with its children will be
updated.
Hierarchical API can also be used to delete any sub-branch of entire tree.
PATCH /policy/api/v1/infra
PATCH /policy/api/v1/global-infra
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra

Update the infra object


Updates only the single infra object. This does not allow hierarchical
updates of entities.
PUT /policy/api/v1/infra