Manage Frameworks

Endpoints

GET /frameworks

Get all the frameworks in Immuta.

Response

POST /frameworks

Body parameters

Response

DELETE /frameworks/{frameworkId}

Deletes the framework you specify in the request.

Request parameter

Response

The response returns a 204 response code if the request was successful.

GET /frameworks/{frameworkId}

Gets the framework you specify in the request.

Request parameter

Response

PUT /frameworks/{frameworkId}

Update a framework. This example updates a framework to be inactive.

Request parameter

Body parameters

Response

POST /frameworks/{frameworkId}/clone

Clone a framework from an existing framework.

Request parameter

Response

GET /frameworks/{frameworkId}/versions

Gets every version of the framework you specify in the request.

Request parameter

Response

Framework payload

The framework payload is used when creating or updating a framework. See the parameters below.

Tags object

The tags object specifies the tags created for and used in the framework. It includes metadata for the tags, like sensitivity and descriptions. The table below outlines its child parameters.

Rules object

The rules object specifies the rules used in the framework. The table below outlines its child parameters.

Framework reference

The framework reference is the response for many /frameworks requests. See the parameters described below.