Update collection

patch

/api/pvlt/1.0/ctl/collections/{collection}

Updates properties of a collection.

The update includes:

• Adding any properties in the request that are not in the collection.
• Amending the description, is_index, and is_nullable attributes, where they have changed, for any properties in the request that are in the collection. is_nullable can only be changed from false to true. All other attributes of existing properties are ignored.

note

The combined length of the collection name and the longest property name can not exceed 40 characters.

The collection request can be provided in JSON or PVSchema format by setting the Content-Type header to application/json or application/pvschema, respectively. The collection can be returned in JSON or PVSchema format using the format query parameter or by setting the Accept header to application/json or application/pvschema, respectively. The default is to return JSON.

See PVSchema for more details on the structure and content of PVSchema.

The collection name provided in the path parameter must match the collection name in the JSON or PVSchema.

The response contains the collection with all the properties.

info

This command may take a while to complete (e.g. when adding an index) and is excluded from Vault's standard call timeout.

The role that performs this operation must have the CapCollectionsWriter capability. See Access control for more information about how capabilities are used to control access to operations.

Request

Path parameters

• collection - string required*

  The name of a collection.

  Match pattern: ^[a-zA-Z][a-zA-Z0-9_]*$Max length: 40Example: "customers"

Query parameters

• format - string

  The format of the response. Overrides any Accept header value provided.

  Default: jsonAllowed values: pvschema, json
• options - array of strings

  Options for the operation. Options include:

  • show_builtins – show built-in properties in the response.

  Each string:

  Allowed values: show_builtins

Request body

Details of the collection, including its properties.

application/json

object required*

Additional properties: falseProperties:

• creation_time - string

  The time when the collection was created, in RFC3339Nano format. Vault sets this value automatically. Sending a value for this field is ignored.

  Format: date-timeExample: "2022-07-05T08:47:12.041234Z"
• modification_time - string

  The time when the collection was last modified, in RFC3339Nano format. Vault sets this value automatically. Sending a value for this field is ignored.

  Format: date-timeExample: "2022-07-05T08:47:12.041234Z"
• name - string required*

  The name of a collection.

  Match pattern: ^[a-zA-Z][a-zA-Z0-9_]*$Max length: 40Example: "customers"
• properties - array of objects required*

  Each object:

  Additional properties: falseProperties:

  • creation_time - string

    The time when the property was created, in RFC3339Nano format. Vault sets this value automatically. Sending a value for this field is ignored.

    Format: date-timeExample: "2022-07-05T08:47:12.041234Z"
  • modification_time - string

    The time when the property was last modified, in RFC3339 format. Vault sets this value automatically. Sending a value for this field is ignored.

    Format: date-timeExample: "2022-07-05T08:47:12.047Z"
  • description - string

    The description of a model.

    Max length: 450
  • is_builtin - boolean

    Whether the property is created by Vault (or by the user). Built-in properties cannot be deleted or modified. Sending a value for this field is ignored.

    Default: falseExample: false
  • is_encrypted - boolean

    Whether the value is stored encrypted.

    Default: trueExample: true
  • is_index - boolean

    Whether the backend storage is optimized for searches on this property. Cannot be set to true for properties with data types LONG_TEXT, JSON, or BLOB, or custom data types based on those types.

    Default: falseExample: false
  • is_nullable - boolean

    Whether the value of the property can be removed (set to null).

    Default: falseExample: false
  • is_readonly - boolean

    Whether the user can modify values of this property. Ignored for user define properties. Sending a value for this field is ignored.

    Default: falseExample: false
  • is_unique - boolean

    Whether the backend storage enforces unique values for active objects. Cannot be set to true for properties with data types LONG_TEXT, JSON, or BLOB, or custom data types based on those types.

    Default: falseExample: false
  • name - string required*

    The name of a property.

    Match pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$Max length: 40Example: "first_name"
  • data_type_name - string required*

    The name of a data type.

    Match pattern: ^[a-zA-Z][a-zA-Z0-9_]*$Max length: 450Example: "STRING"
• type - string required*

  The schema prototype the collection is based on.

  Allowed values: PERSONS, DATA

Example

{
  "type": "PERSONS",
  "name": "customers",
  "properties": [
    {
      "description": "Date of birth",
      "name": "date_of_birth",
      "data_type_name": "DATE_OF_BIRTH",
      "is_nullable": true
    },
    {
      "description": "Email",
      "name": "email",
      "data_type_name": "EMAIL",
      "is_unique": true,
      "is_index": true,
      "is_nullable": true
    },
    {
      "description": "First name",
      "name": "first_name",
      "data_type_name": "NAME"
    },
    {
      "description": "Last name",
      "name": "last_name",
      "data_type_name": "NAME"
    },
    {
      "description": "Phone number",
      "name": "phone_number",
      "data_type_name": "PHONE_NUMBER",
      "is_unique": true,
      "is_index": true,
      "is_nullable": true
    }
  ]
}

Example

{
  "type": "PERSONS",
  "name": "customers",
  "properties": [
    {
      "description": "Social Security Number",
      "name": "ssn",
      "data_type_name": "SSN",
      "is_unique": true,
      "is_index": true,
      "is_encrypted": true,
      "is_nullable": true,
      "is_builtin": false,
      "is_readonly": false,
      "creation_time": "2023-01-25T17:31:40.291033Z",
      "modification_time": "2023-01-25T17:31:40.291033Z"
    }
  ],
  "creation_time": "2023-01-25T16:21:48.308234Z",
  "modification_time": "2023-01-25T16:21:48.308234Z"
}

application/pvschema

string required*

Example

customers PERSONS (
  ssn SSN NULL UNIQUE INDEX COMMENT 'Social Security Number',
);

Possible responses

200

The request is successful.

application/json

object required*

Additional properties: falseProperties:

• creation_time - string

  The time when the collection was created, in RFC3339Nano format. Vault sets this value automatically. Sending a value for this field is ignored.

  Format: date-timeExample: "2022-07-05T08:47:12.041234Z"
• modification_time - string

  The time when the collection was last modified, in RFC3339Nano format. Vault sets this value automatically. Sending a value for this field is ignored.

  Format: date-timeExample: "2022-07-05T08:47:12.041234Z"
• name - string required*

  The name of a collection.

  Match pattern: ^[a-zA-Z][a-zA-Z0-9_]*$Max length: 40Example: "customers"
• properties - array of objects required*

  Each object:

  Additional properties: falseProperties:

  • creation_time - string

    The time when the property was created, in RFC3339Nano format. Vault sets this value automatically. Sending a value for this field is ignored.

    Format: date-timeExample: "2022-07-05T08:47:12.041234Z"
  • modification_time - string

    The time when the property was last modified, in RFC3339 format. Vault sets this value automatically. Sending a value for this field is ignored.

    Format: date-timeExample: "2022-07-05T08:47:12.047Z"
  • description - string

    The description of a model.

    Max length: 450
  • is_builtin - boolean

    Whether the property is created by Vault (or by the user). Built-in properties cannot be deleted or modified. Sending a value for this field is ignored.

    Default: falseExample: false
  • is_encrypted - boolean

    Whether the value is stored encrypted.

    Default: trueExample: true
  • is_index - boolean

    Whether the backend storage is optimized for searches on this property. Cannot be set to true for properties with data types LONG_TEXT, JSON, or BLOB, or custom data types based on those types.

    Default: falseExample: false
  • is_nullable - boolean

    Whether the value of the property can be removed (set to null).

    Default: falseExample: false
  • is_readonly - boolean

    Whether the user can modify values of this property. Ignored for user define properties. Sending a value for this field is ignored.

    Default: falseExample: false
  • is_unique - boolean

    Whether the backend storage enforces unique values for active objects. Cannot be set to true for properties with data types LONG_TEXT, JSON, or BLOB, or custom data types based on those types.

    Default: falseExample: false
  • name - string required*

    The name of a property.

    Match pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$Max length: 40Example: "first_name"
  • data_type_name - string required*

    The name of a data type.

    Match pattern: ^[a-zA-Z][a-zA-Z0-9_]*$Max length: 450Example: "STRING"
• type - string required*

  The schema prototype the collection is based on.

  Allowed values: PERSONS, DATA

Example

{
  "type": "PERSONS",
  "name": "customers",
  "properties": [
    {
      "description": "Date of birth",
      "name": "date_of_birth",
      "data_type_name": "DATE_OF_BIRTH",
      "is_nullable": true
    },
    {
      "description": "Email",
      "name": "email",
      "data_type_name": "EMAIL",
      "is_unique": true,
      "is_index": true,
      "is_nullable": true
    },
    {
      "description": "First name",
      "name": "first_name",
      "data_type_name": "NAME"
    },
    {
      "description": "Last name",
      "name": "last_name",
      "data_type_name": "NAME"
    },
    {
      "description": "Phone number",
      "name": "phone_number",
      "data_type_name": "PHONE_NUMBER",
      "is_unique": true,
      "is_index": true,
      "is_nullable": true
    }
  ]
}

Example

{
  "type": "PERSONS",
  "name": "customers",
  "properties": [
    {
      "description": "Social Security Number",
      "name": "ssn",
      "data_type_name": "ssn",
      "is_unique": true,
      "is_index": true,
      "is_encrypted": true,
      "is_nullable": true,
      "is_builtin": false,
      "is_readonly": false,
      "creation_time": "2022-12-01T10:20:47.115228Z",
      "modification_time": "2022-12-01T10:20:47.115228Z"
    }
  ],
  "creation_time": "2022-12-01T09:45:03.015895Z",
  "modification_time": "2022-12-01T09:45:03.015895Z"
}

application/pvschema

string required*

Example

customers PERSONS (
  ssn SSN NULL UNIQUE INDEX COMMENT 'Social Security Number',
);

400

The request is invalid.

application/json

object required*

Additional properties: falseProperties:

• context - object required*

  The error context.

  Values of additional properties are strings

  Example

  {
    "objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
  }
• error_code - string required*

  The error code.

  Example: "PVxxxx"
• message - string required*

  The error message.

  Example: "The object is not found."

Example

{
  "error_code": "PV1001",
  "message": "The access reason is missing.",
  "context": {
    "reason": null
  }
}

401

Authentication credentials are incorrect or missing.

application/json

object required*

Additional properties: falseProperties:

• context - object required*

  The error context.

  Values of additional properties are strings

  Example

  {
    "objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
  }
• error_code - string required*

  The error code.

  Example: "PVxxxx"
• message - string required*

  The error message.

  Example: "The object is not found."

Example

{
  "error_code": "PV1005",
  "message": "The request is unauthorized.",
  "context": {}
}

403

The caller doesn't have the required access rights.

application/json

object required*

Additional properties: falseProperties:

• context - object required*

  The error context.

  Values of additional properties are strings

  Example

  {
    "objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
  }
• error_code - string required*

  The error code.

  Example: "PVxxxx"
• message - string required*

  The error message.

  Example: "The object is not found."

Example

{
  "error_code": "PV1007",
  "message": "The operation is forbidden due to missing capabilities.",
  "context": {
    "username": "WebServer"
  }
}

404

The collection is not found.

application/json

object required*

Additional properties: falseProperties:

• context - object required*

  The error context.

  Values of additional properties are strings

  Example

  {
    "objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
  }
• error_code - string required*

  The error code.

  Example: "PVxxxx"
• message - string required*

  The error message.

  Example: "The object is not found."

Example

{
  "context": {
    "objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
  },
  "error_code": "PVxxxx",
  "message": "The object is not found."
}

405

The operation is not allowed.

application/json

object required*

Additional properties: falseProperties:

• context - object required*

  The error context.

  Values of additional properties are strings

  Example

  {
    "objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
  }
• error_code - string required*

  The error code.

  Example: "PVxxxx"
• message - string required*

  The error message.

  Example: "The object is not found."

Example

{
  "error_code": "PV1026",
  "message": "The operation is not allowed in in-memory mode.",
  "context": {}
}

409

A conflict occurs.

application/json

object required*

Additional properties: falseProperties:

• context - object required*

  The error context.

  Values of additional properties are strings

  Example

  {
    "objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
  }
• error_code - string required*

  The error code.

  Example: "PVxxxx"
• message - string required*

  The error message.

  Example: "The object is not found."

Example

{
  "error_code": "PV3218",
  "message": "Concurrent conflicting updates to the same object.",
  "context": {}
}

410

Access to a resource that is no longer available occurs.

application/json

object required*

Additional properties: falseProperties:

• context - object required*

  The error context.

  Values of additional properties are strings

  Example

  {
    "objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
  }
• error_code - string required*

  The error code.

  Example: "PVxxxx"
• message - string required*

  The error message.

  Example: "The object is not found."

Example

{
  "error_code": "PV1033",
  "message": "The resource is gone.",
  "context": {}
}

500

An error occurs on the server.

application/json

object required*

Additional properties: falseProperties:

• context - object required*

  The error context.

  Values of additional properties are strings

  Example

  {
    "objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
  }
• error_code - string required*

  The error code.

  Example: "PVxxxx"
• message - string required*

  The error message.

  Example: "The object is not found."

Example

{
  "error_code": "PV1000",
  "message": "Something went wrong",
  "context": {}
}

501

Not implemented.

application/json

object required*

Additional properties: falseProperties:

• context - object required*

  The error context.

  Values of additional properties are strings

  Example

  {
    "objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
  }
• error_code - string required*

  The error code.

  Example: "PVxxxx"
• message - string required*

  The error message.

  Example: "The object is not found."

Example

{
  "error_code": "PV2001",
  "message": "This operation is not implemented.",
  "context": {}
}

503

The service is unavailable.

application/json

object required*

Additional properties: falseProperties:

• context - object required*

  The error context.

  Values of additional properties are strings

  Example

  {
    "objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
  }
• error_code - string required*

  The error code.

  Example: "PVxxxx"
• message - string required*

  The error message.

  Example: "The object is not found."

Example

{
  "error_code": "PV1009",
  "message": "The operation timed out on the server.",
  "context": {}
}

Try the API

Authorization

API key:

Path parameters

Collection*:

Query parameters

Format:

Options:

Request body

Content-Type:

Navigate to the docs of your local Vault installation to try the API directly from there.

Code examples

Example