Update policy

PUT 
/metalakes/:metalake/policies/:policy

Alters the specified policy information in the specified metalake

Request

Path Parameters

metalake stringrequired

The name of the metalake

policy stringrequired

The name of the policy

application/json

Body

updates

object[]

required

Array [

oneOf

RenamePolicyRequest

@type stringrequired

Possible values: [rename]

newName stringrequired

The new name of the policy

UpdatePolicyCommentRequest

@type stringrequired

Possible values: [updateComment]

newComment stringrequired

The new comment of the policy

UpdatePolicyContentRequest

@type stringrequired

Possible values: [updateContent]

policyType stringrequired

The type of the policy

newContent

object

required

The new content of the policy, its structure depends on the 'policyType'.

oneOf

CustomPolicyContent

Content for a custom policy type.

supportedObjectTypes string[]required

Possible values: [CATALOG, SCHEMA, TABLE, FILESET, TOPIC, MODEL], >= 1

The types of metadata objects this policy content can be applied to.

properties

object

A map of string-to-string properties for the policy content.

property name* string

customRules object

A map of custom rules where the key is the rule name and the value can be of any type.

]

Responses

200

Returns the updated policy object

application/vnd.gravitino.v1+json

Schema

Schema

code int32

Possible values: [0]

Status code of the response

policy

object

A basic policy without content

oneOf

CustomPolicy

A policy with custom content

name stringrequired

The name of the policy

comment stringnullable

A comment about the policy

policyType stringrequired

The type of the policy

enabled booleanrequired

Whether the policy is enabled

audit

object

required

Audit information for a Gravitino resource.

creator string

The user who created the resource

createTime date-time

The time the resource was created

lastModifier string

The user who last modified the resource

lastModifiedTime date-time

The time the resource was last modified

inherited booleannullable

Whether the policy is inherited from the parent metadata object

content

object

required

Content for a custom policy type.

supportedObjectTypes string[]required

Possible values: [CATALOG, SCHEMA, TABLE, FILESET, TOPIC, MODEL], >= 1

The types of metadata objects this policy content can be applied to.

properties

object

A map of string-to-string properties for the policy content.

property name* string

customRules object

A map of custom rules where the key is the rule name and the value can be of any type.

Example (from schema)

{
  "code": 0
}

PolicyResponse

{
  "code": 0,
  "policy": {
    "name": "my_policy1",
    "comment": "This is a test policy",
    "policyType": "custom",
    "enabled": false,
    "content": {
      "customRules": {
        "rule1": 123
      },
      "supportedObjectTypes": [
        "SCHEMA",
        "TABLE",
        "MODEL",
        "TOPIC",
        "FILESET",
        "CATALOG"
      ],
      "properties": {
        "key1": "value1"
      }
    },
    "inherited": null,
    "audit": {
      "creator": "anonymous",
      "createTime": "2025-08-04T10:29:23.463Z"
    }
  }
}

404

Not Found - The specified policy does not exist in the specified metalake

application/vnd.gravitino.v1+json

Schema

Schema

code integerrequired

Possible values: >= 1000 and <= 1100

HTTP response code

type stringrequired

Internal type definition of the error

message stringrequired

A human-readable message

stack string[]

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string",
  "stack": [
    "string"
  ]
}

NoSuchMetalakeException

{
  "code": 1003,
  "type": "NoSuchMetalakeException",
  "message": "Failed to operate metalake(s) [test] operation [LOAD], reason [NoSuchMetalakeException]",
  "stack": [
    "org.apache.gravitino.exceptions.NoSuchMetalakeException: Metalake test does not exist",
    "..."
  ]
}

NoSuchPolicyException

{
  "code": 1003,
  "type": "NoSuchPolicyException",
  "message": "Failed to operate policy(s) [my_policy] operation [LOAD] under metalake [my_test_metalake], reason [NoSuchPolicyException]",
  "stack": [
    "org.apache.gravitino.exceptions.NoSuchPolicyException: Policy my_policy does not exist",
    "..."
  ]
}

5xx

A server-side problem that might not be addressable from the client side. Used for server 5xx errors without more specific documentation in individual routes.

application/vnd.gravitino.v1+json

Schema

Schema

code integerrequired

Possible values: >= 1000 and <= 1100

HTTP response code

type stringrequired

Internal type definition of the error

message stringrequired

A human-readable message

stack string[]

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string",
  "stack": [
    "string"
  ]
}

Example

{
  "code": 1002,
  "type": "RuntimeException",
  "message": "Internal Server Error",
  "stack": [
    "java.lang.RuntimeException: Internal Server Error"
  ]
}

Loading...