{ "opencollection": "1.0.0", "info": { "name": "OpenMetadata APIs Agent Executions Policies API", "version": "1.13" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Policies", "type": "folder" }, "items": [ { "info": { "name": "List policies", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/policies", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields requested in the returned resource" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the number policies returned. (1 to 1000000, default = 10)" }, { "name": "before", "value": "", "type": "query", "description": "Returns list of policies before this cursor" }, { "name": "after", "value": "", "type": "query", "description": "Returns list of policies after this cursor" }, { "name": "include", "value": "", "type": "query", "description": "Include all, deleted, or non-deleted entities." } ] }, "docs": "Get a list of policies. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params." }, { "info": { "name": "Create a policy", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/policies", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new policy." }, { "info": { "name": "Create or update a policy", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/policies", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new policy, if it does not exist or update an existing policy." }, { "info": { "name": "Get a policy by fully qualified name", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/policies/name/:fqn", "params": [ { "name": "fqn", "value": "", "type": "path", "description": "Fully qualified name of the policy" }, { "name": "fields", "value": "", "type": "query", "description": "Fields requested in the returned resource" }, { "name": "include", "value": "", "type": "query", "description": "Include all, deleted, or non-deleted entities." }, { "name": "includeRelations", "value": "", "type": "query", "description": "Per-relation include control. Format: field:value,field2:value2. Example: owners:non-deleted,followers:all. Valid values: all, deleted, non-deleted. If not specified for a field, uses the entity's include value." } ] }, "docs": "Get a policy by fully qualified name." }, { "info": { "name": "Update a policy by name.", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/policies/name/:fqn", "params": [ { "name": "fqn", "value": "", "type": "path", "description": "Name of the policy" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing policy using JsonPatch." }, { "info": { "name": "Delete a policy by fully qualified name", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/policies/name/:fqn", "params": [ { "name": "hardDelete", "value": "", "type": "query", "description": "Hard delete the entity. (Default = `false`)" }, { "name": "fqn", "value": "", "type": "path", "description": "Fully qualified name of the policy" } ] }, "docs": "Delete a policy by `fullyQualifiedName`." }, { "info": { "name": "Get a policy by id", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/policies/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the policy" }, { "name": "fields", "value": "", "type": "query", "description": "Fields requested in the returned resource" }, { "name": "include", "value": "", "type": "query", "description": "Include all, deleted, or non-deleted entities." }, { "name": "includeRelations", "value": "", "type": "query", "description": "Per-relation include control. Format: field:value,field2:value2. Example: owners:non-deleted,followers:all. Valid values: all, deleted, non-deleted. If not specified for a field, uses the entity's include value." } ] }, "docs": "Get a policy by `Id`." }, { "info": { "name": "Update a policy", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/policies/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the policy" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing policy using JsonPatch." }, { "info": { "name": "Delete a policy by Id", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/policies/:id", "params": [ { "name": "hardDelete", "value": "", "type": "query", "description": "Hard delete the entity. (Default = `false`)" }, { "name": "id", "value": "", "type": "path", "description": "Id of the policy" } ] }, "docs": "Delete a policy by `Id`." }, { "info": { "name": "Asynchronously delete a policy by Id", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/policies/async/:id", "params": [ { "name": "hardDelete", "value": "", "type": "query", "description": "Hard delete the entity. (Default = `false`)" }, { "name": "id", "value": "", "type": "path", "description": "Id of the policy" } ] }, "docs": "Asynchronously delete a policy by `Id`." }, { "info": { "name": "Get a version of the policy by Id", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/policies/:id/versions/:version", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the policy" }, { "name": "version", "value": "", "type": "path", "description": "policy version number in the form `major`.`minor`" } ] }, "docs": "Get a version of the policy by given `Id`" }, { "info": { "name": "List all entity versions within a time range", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/policies/history", "params": [ { "name": "startTs", "value": "", "type": "query", "description": "Start timestamp in milliseconds since epoch" }, { "name": "endTs", "value": "", "type": "query", "description": "End timestamp in milliseconds since epoch" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the number of entity returned (1 to 1000000, default = 10)" }, { "name": "before", "value": "", "type": "query", "description": "Returns list of entity versions before this cursor" }, { "name": "after", "value": "", "type": "query", "description": "Returns list of entity versions after this cursor" } ] }, "docs": "Get a paginated list of all entity versions within a given time range specified by `startTs` and `endTs` in milliseconds since epoch. " }, { "info": { "name": "Get list of policy functions used in authoring conditions in policy rules.", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/policies/functions" }, "docs": "Get list of policy functions used in authoring conditions in policy rules." }, { "info": { "name": "Get list of policy resources used in authoring a policy", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/policies/resources" }, "docs": "Get list of policy resources used in authoring a policy." }, { "info": { "name": "List policy versions", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/policies/:id/versions", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the policy" } ] }, "docs": "Get a list of all the versions of a policy identified by `id`" }, { "info": { "name": "Restore a soft deleted policy", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/policies/restore", "body": { "type": "json", "data": "{}" } }, "docs": "Restore a soft deleted policy." }, { "info": { "name": "Validate a given condition", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/policies/validation/condition/:expression", "params": [ { "name": "expression", "value": "", "type": "path", "description": "Expression of validating rule" } ] }, "docs": "Validate a given condition expression used in authoring rules." } ] } ], "bundled": true }