Jump to

• Request
• Response

Rename a table from its current name to a new name

post

{scheme}://{host}/{basePath}/v1/{prefix}/tables/rename

Rename a table from one identifier to another. It's valid to move a table across namespaces, but the server implementation is not required to support it.

Request

Path Parameters

• prefix(required): string
  An optional prefix in the path

Header Parameters

• Idempotency-Key: string(uuid)
  Optional client-provided idempotency key for safe request retries. When present, the server ensures no additional effects for requests that carry the same Idempotency-Key. If a prior request with this key has been finalized, the server returns an equivalent final response without re-running the operation. The response body may reflect a newer state of the catalog than existed at the time of the commit. Finalization rules: - Finalize & replay: 200, 201, 204, and deterministic terminal 4xx (including 409 such as AlreadyExists, NamespaceNotEmpty, etc.) - Do not finalize (not stored/replayed): 5xx Key Requirements: - Key format: UUIDv7 in string form (RFC 9562). - The idempotency key must be globally unique (no reuse across different operations). - Catalogs SHOULD NOT expire keys before the end of the advertised token lifetime. - If Idempotency-Key is used, clients MUST reuse the same key when retrying the same logical operation and MUST generate a new key for a different operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• destination(required): object TableIdentifier
• source(required): object TableIdentifier

{
    "type":"object",
    "required":[
        "source",
        "destination"
    ],
    "properties":{
        "source":{
            "$ref":"#/components/schemas/TableIdentifier"
        },
        "destination":{
            "$ref":"#/components/schemas/TableIdentifier"
        }
    }
}

Nested Schema : TableIdentifier

Type: object

Show Source

• name(required): string
• namespace(required): array Namespace
  Reference to one or more levels of a namespace

{
    "type":"object",
    "required":[
        "namespace",
        "name"
    ],
    "properties":{
        "namespace":{
            "$ref":"#/components/schemas/Namespace"
        },
        "name":{
            "type":"string",
            "nullable":false
        }
    }
}

Nested Schema : Namespace

Type: array

Reference to one or more levels of a namespace

Show Source

• Array of: string

{
    "description":"Reference to one or more levels of a namespace",
    "type":"array",
    "items":{
        "type":"string"
    },
    "example":[
        "accounting",
        "tax"
    ]
}

Example:

[
    "accounting",
    "tax"
]

Examples

Select an example Rename a table in the same namespace

Back to Top

Response

Supported Media Types

• application/json

204 Response

Success, no content

400 Response

Indicates a bad request error. It could be caused by an unexpected request body format or other forms of request validation failure, such as invalid json. Usually serves application/json content, although in some cases simple text/plain content might be returned by the server's middleware.

Body ()

Root Schema : IcebergErrorResponse

Type: object

JSON wrapper for all error responses (non-2xx)

Show Source

• error(required): object ErrorModel
  JSON error payload returned in a response with further details on the error

{
    "description":"JSON wrapper for all error responses (non-2xx)",
    "type":"object",
    "required":[
        "error"
    ],
    "properties":{
        "error":{
            "$ref":"#/components/schemas/ErrorModel"
        }
    },
    "additionalProperties":false,
    "example":{
        "error":{
            "message":"The server does not support this operation",
            "type":"UnsupportedOperationException",
            "code":406
        }
    }
}

Example:

{
    "error":{
        "message":"The server does not support this operation",
        "type":"UnsupportedOperationException",
        "code":406
    }
}

Nested Schema : ErrorModel

Type: object

JSON error payload returned in a response with further details on the error

Show Source

• code(required): integer
  Minimum Value: 400

  Maximum Value: 600

  HTTP response code

  Example: 404
• message(required): string
  Human-readable error message
• stack: array stack
• type(required): string
  Internal type definition of the error

  Example: NoSuchNamespaceException

{
    "type":"object",
    "description":"JSON error payload returned in a response with further details on the error",
    "required":[
        "message",
        "type",
        "code"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"Human-readable error message"
        },
        "type":{
            "type":"string",
            "description":"Internal type definition of the error",
            "example":"NoSuchNamespaceException"
        },
        "code":{
            "type":"integer",
            "minimum":400,
            "maximum":600,
            "description":"HTTP response code",
            "example":404
        },
        "stack":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : stack

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

401 Response

Unauthorized. The REST Catalog SHOULD respond with the 401 UnauthorizedResponse when the access token provided is expired, revoked, malformed, or invalid for other reasons. The client MAY request a new access token and retry the request.

Body ()

Root Schema : IcebergErrorResponse

Type: object

JSON wrapper for all error responses (non-2xx)

Show Source

• error(required): object ErrorModel
  JSON error payload returned in a response with further details on the error

{
    "description":"JSON wrapper for all error responses (non-2xx)",
    "type":"object",
    "required":[
        "error"
    ],
    "properties":{
        "error":{
            "$ref":"#/components/schemas/ErrorModel"
        }
    },
    "additionalProperties":false,
    "example":{
        "error":{
            "message":"The server does not support this operation",
            "type":"UnsupportedOperationException",
            "code":406
        }
    }
}

Example:

{
    "error":{
        "message":"The server does not support this operation",
        "type":"UnsupportedOperationException",
        "code":406
    }
}

Nested Schema : ErrorModel

Type: object

JSON error payload returned in a response with further details on the error

Show Source

• code(required): integer
  Minimum Value: 400

  Maximum Value: 600

  HTTP response code

  Example: 404
• message(required): string
  Human-readable error message
• stack: array stack
• type(required): string
  Internal type definition of the error

  Example: NoSuchNamespaceException

{
    "type":"object",
    "description":"JSON error payload returned in a response with further details on the error",
    "required":[
        "message",
        "type",
        "code"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"Human-readable error message"
        },
        "type":{
            "type":"string",
            "description":"Internal type definition of the error",
            "example":"NoSuchNamespaceException"
        },
        "code":{
            "type":"integer",
            "minimum":400,
            "maximum":600,
            "description":"HTTP response code",
            "example":404
        },
        "stack":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : stack

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

403 Response

Forbidden. Authenticated user does not have the necessary permissions.

Body ()

Root Schema : IcebergErrorResponse

Type: object

JSON wrapper for all error responses (non-2xx)

Show Source

• error(required): object ErrorModel
  JSON error payload returned in a response with further details on the error

{
    "description":"JSON wrapper for all error responses (non-2xx)",
    "type":"object",
    "required":[
        "error"
    ],
    "properties":{
        "error":{
            "$ref":"#/components/schemas/ErrorModel"
        }
    },
    "additionalProperties":false,
    "example":{
        "error":{
            "message":"The server does not support this operation",
            "type":"UnsupportedOperationException",
            "code":406
        }
    }
}

Example:

{
    "error":{
        "message":"The server does not support this operation",
        "type":"UnsupportedOperationException",
        "code":406
    }
}

Nested Schema : ErrorModel

Type: object

JSON error payload returned in a response with further details on the error

Show Source

• code(required): integer
  Minimum Value: 400

  Maximum Value: 600

  HTTP response code

  Example: 404
• message(required): string
  Human-readable error message
• stack: array stack
• type(required): string
  Internal type definition of the error

  Example: NoSuchNamespaceException

{
    "type":"object",
    "description":"JSON error payload returned in a response with further details on the error",
    "required":[
        "message",
        "type",
        "code"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"Human-readable error message"
        },
        "type":{
            "type":"string",
            "description":"Internal type definition of the error",
            "example":"NoSuchNamespaceException"
        },
        "code":{
            "type":"integer",
            "minimum":400,
            "maximum":600,
            "description":"HTTP response code",
            "example":404
        },
        "stack":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : stack

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

404 Response

Not Found - NoSuchTableException, Table to rename does not exist - NoSuchNamespaceException, The target namespace of the new table identifier does not exist

Body ()

Root Schema : IcebergErrorResponse

Type: object

JSON wrapper for all error responses (non-2xx)

Show Source

• error(required): object ErrorModel
  JSON error payload returned in a response with further details on the error

{
    "description":"JSON wrapper for all error responses (non-2xx)",
    "type":"object",
    "required":[
        "error"
    ],
    "properties":{
        "error":{
            "$ref":"#/components/schemas/ErrorModel"
        }
    },
    "additionalProperties":false,
    "example":{
        "error":{
            "message":"The server does not support this operation",
            "type":"UnsupportedOperationException",
            "code":406
        }
    }
}

Example:

{
    "error":{
        "message":"The server does not support this operation",
        "type":"UnsupportedOperationException",
        "code":406
    }
}

Nested Schema : ErrorModel

Type: object

JSON error payload returned in a response with further details on the error

Show Source

• code(required): integer
  Minimum Value: 400

  Maximum Value: 600

  HTTP response code

  Example: 404
• message(required): string
  Human-readable error message
• stack: array stack
• type(required): string
  Internal type definition of the error

  Example: NoSuchNamespaceException

{
    "type":"object",
    "description":"JSON error payload returned in a response with further details on the error",
    "required":[
        "message",
        "type",
        "code"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"Human-readable error message"
        },
        "type":{
            "type":"string",
            "description":"Internal type definition of the error",
            "example":"NoSuchNamespaceException"
        },
        "code":{
            "type":"integer",
            "minimum":400,
            "maximum":600,
            "description":"HTTP response code",
            "example":404
        },
        "stack":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : stack

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Examples

Select an example The requested table does not exist The requested namespace does not exist

406 Response

Not Acceptable / Unsupported Operation. The server does not support this operation.

Body ()

Root Schema : ErrorModel

Type: object

JSON error payload returned in a response with further details on the error

Show Source

• code(required): integer
  Minimum Value: 400

  Maximum Value: 600

  HTTP response code

  Example: 404
• message(required): string
  Human-readable error message
• stack: array stack
• type(required): string
  Internal type definition of the error

  Example: NoSuchNamespaceException

{
    "type":"object",
    "description":"JSON error payload returned in a response with further details on the error",
    "required":[
        "message",
        "type",
        "code"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"Human-readable error message"
        },
        "type":{
            "type":"string",
            "description":"Internal type definition of the error",
            "example":"NoSuchNamespaceException"
        },
        "code":{
            "type":"integer",
            "minimum":400,
            "maximum":600,
            "description":"HTTP response code",
            "example":404
        },
        "stack":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : stack

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

409 Response

Conflict - The target identifier to rename to already exists as a table or view

Body ()

Root Schema : IcebergErrorResponse

Type: object

JSON wrapper for all error responses (non-2xx)

Show Source

• error(required): object ErrorModel
  JSON error payload returned in a response with further details on the error

{
    "description":"JSON wrapper for all error responses (non-2xx)",
    "type":"object",
    "required":[
        "error"
    ],
    "properties":{
        "error":{
            "$ref":"#/components/schemas/ErrorModel"
        }
    },
    "additionalProperties":false,
    "example":{
        "error":{
            "message":"The server does not support this operation",
            "type":"UnsupportedOperationException",
            "code":406
        }
    }
}

Example:

{
    "error":{
        "message":"The server does not support this operation",
        "type":"UnsupportedOperationException",
        "code":406
    }
}

Nested Schema : ErrorModel

Type: object

JSON error payload returned in a response with further details on the error

Show Source

• code(required): integer
  Minimum Value: 400

  Maximum Value: 600

  HTTP response code

  Example: 404
• message(required): string
  Human-readable error message
• stack: array stack
• type(required): string
  Internal type definition of the error

  Example: NoSuchNamespaceException

{
    "type":"object",
    "description":"JSON error payload returned in a response with further details on the error",
    "required":[
        "message",
        "type",
        "code"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"Human-readable error message"
        },
        "type":{
            "type":"string",
            "description":"Internal type definition of the error",
            "example":"NoSuchNamespaceException"
        },
        "code":{
            "type":"integer",
            "minimum":400,
            "maximum":600,
            "description":"HTTP response code",
            "example":404
        },
        "stack":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : stack

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

419 Response

This is an optional status response type that the REST Catalog can issue when the token has expired. The client MAY request a new access token and retry the request. 401 UnauthorizedResponse SHOULD be preferred over this response type on token expiry.

Body ()

Root Schema : IcebergErrorResponse

Type: object

JSON wrapper for all error responses (non-2xx)

Show Source

• error(required): object ErrorModel
  JSON error payload returned in a response with further details on the error

{
    "description":"JSON wrapper for all error responses (non-2xx)",
    "type":"object",
    "required":[
        "error"
    ],
    "properties":{
        "error":{
            "$ref":"#/components/schemas/ErrorModel"
        }
    },
    "additionalProperties":false,
    "example":{
        "error":{
            "message":"The server does not support this operation",
            "type":"UnsupportedOperationException",
            "code":406
        }
    }
}

Example:

{
    "error":{
        "message":"The server does not support this operation",
        "type":"UnsupportedOperationException",
        "code":406
    }
}

Nested Schema : ErrorModel

Type: object

JSON error payload returned in a response with further details on the error

Show Source

• code(required): integer
  Minimum Value: 400

  Maximum Value: 600

  HTTP response code

  Example: 404
• message(required): string
  Human-readable error message
• stack: array stack
• type(required): string
  Internal type definition of the error

  Example: NoSuchNamespaceException

{
    "type":"object",
    "description":"JSON error payload returned in a response with further details on the error",
    "required":[
        "message",
        "type",
        "code"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"Human-readable error message"
        },
        "type":{
            "type":"string",
            "description":"Internal type definition of the error",
            "example":"NoSuchNamespaceException"
        },
        "code":{
            "type":"integer",
            "minimum":400,
            "maximum":600,
            "description":"HTTP response code",
            "example":404
        },
        "stack":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : stack

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

503 Response

The service is not ready to handle the request, request could have been partially processed. The service may additionally send a Retry-After header to indicate when to retry, a non idempotent request should only be retried by the client when the Retry-After header is present.

Body ()

Root Schema : IcebergErrorResponse

Type: object

JSON wrapper for all error responses (non-2xx)

Show Source

• error(required): object ErrorModel
  JSON error payload returned in a response with further details on the error

{
    "description":"JSON wrapper for all error responses (non-2xx)",
    "type":"object",
    "required":[
        "error"
    ],
    "properties":{
        "error":{
            "$ref":"#/components/schemas/ErrorModel"
        }
    },
    "additionalProperties":false,
    "example":{
        "error":{
            "message":"The server does not support this operation",
            "type":"UnsupportedOperationException",
            "code":406
        }
    }
}

Example:

{
    "error":{
        "message":"The server does not support this operation",
        "type":"UnsupportedOperationException",
        "code":406
    }
}

Nested Schema : ErrorModel

Type: object

JSON error payload returned in a response with further details on the error

Show Source

• code(required): integer
  Minimum Value: 400

  Maximum Value: 600

  HTTP response code

  Example: 404
• message(required): string
  Human-readable error message
• stack: array stack
• type(required): string
  Internal type definition of the error

  Example: NoSuchNamespaceException

{
    "type":"object",
    "description":"JSON error payload returned in a response with further details on the error",
    "required":[
        "message",
        "type",
        "code"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"Human-readable error message"
        },
        "type":{
            "type":"string",
            "description":"Internal type definition of the error",
            "example":"NoSuchNamespaceException"
        },
        "code":{
            "type":"integer",
            "minimum":400,
            "maximum":600,
            "description":"HTTP response code",
            "example":404
        },
        "stack":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : stack

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

5XX Response

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.

Body ()

Root Schema : IcebergErrorResponse

Type: object

JSON wrapper for all error responses (non-2xx)

Show Source

• error(required): object ErrorModel
  JSON error payload returned in a response with further details on the error

{
    "description":"JSON wrapper for all error responses (non-2xx)",
    "type":"object",
    "required":[
        "error"
    ],
    "properties":{
        "error":{
            "$ref":"#/components/schemas/ErrorModel"
        }
    },
    "additionalProperties":false,
    "example":{
        "error":{
            "message":"The server does not support this operation",
            "type":"UnsupportedOperationException",
            "code":406
        }
    }
}

Example:

{
    "error":{
        "message":"The server does not support this operation",
        "type":"UnsupportedOperationException",
        "code":406
    }
}

Nested Schema : ErrorModel

Type: object

JSON error payload returned in a response with further details on the error

Show Source

• code(required): integer
  Minimum Value: 400

  Maximum Value: 600

  HTTP response code

  Example: 404
• message(required): string
  Human-readable error message
• stack: array stack
• type(required): string
  Internal type definition of the error

  Example: NoSuchNamespaceException

{
    "type":"object",
    "description":"JSON error payload returned in a response with further details on the error",
    "required":[
        "message",
        "type",
        "code"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"Human-readable error message"
        },
        "type":{
            "type":"string",
            "description":"Internal type definition of the error",
            "example":"NoSuchNamespaceException"
        },
        "code":{
            "type":"integer",
            "minimum":400,
            "maximum":600,
            "description":"HTTP response code",
            "example":404
        },
        "stack":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : stack

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top