List collection properties

get

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

Lists the properties of a collection.

The role that performs this operation must have the CapCollectionsReader 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

• custom_audit - string

  Custom audit information to be included in the audit log.

• 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

Possible responses

200

The request is successful.

application/json

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_substring_index - boolean

  Whether the backend storage is optimized for substring searches on this property. See indexing in the data type reference for a list of supported data 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"

Example

[
  {
    "description": "Date of birth",
    "name": "date_of_birth",
    "data_type_name": "DATE_OF_BIRTH",
    "is_unique": false,
    "is_index": false,
    "is_substring_index": false,
    "is_encrypted": true,
    "is_nullable": true,
    "is_builtin": false,
    "is_readonly": false,
    "creation_time": "2023-01-25T16:21:48.308234Z",
    "modification_time": "2023-01-25T16:21:48.308234Z"
  },
  {
    "description": "Email",
    "name": "email",
    "data_type_name": "EMAIL",
    "is_unique": true,
    "is_index": true,
    "is_substring_index": false,
    "is_encrypted": true,
    "is_nullable": true,
    "is_builtin": false,
    "is_readonly": false,
    "creation_time": "2023-01-25T16:21:48.308234Z",
    "modification_time": "2023-01-25T16:21:48.308234Z"
  },
  {
    "description": "First name",
    "name": "first_name",
    "data_type_name": "NAME",
    "is_unique": false,
    "is_index": false,
    "is_substring_index": false,
    "is_encrypted": true,
    "is_nullable": false,
    "is_builtin": false,
    "is_readonly": false,
    "creation_time": "2023-01-25T16:21:48.308234Z",
    "modification_time": "2023-01-25T16:21:48.308234Z"
  },
  {
    "description": "Last name",
    "name": "last_name",
    "data_type_name": "NAME",
    "is_unique": false,
    "is_index": false,
    "is_substring_index": false,
    "is_encrypted": true,
    "is_nullable": false,
    "is_builtin": false,
    "is_readonly": false,
    "creation_time": "2023-01-25T16:21:48.308234Z",
    "modification_time": "2023-01-25T16:21:48.308234Z"
  },
  {
    "description": "Phone number",
    "name": "phone_number",
    "data_type_name": "PHONE_NUMBER",
    "is_unique": true,
    "is_index": true,
    "is_substring_index": false,
    "is_encrypted": true,
    "is_nullable": true,
    "is_builtin": false,
    "is_readonly": false,
    "creation_time": "2023-01-25T16:21:48.308234Z",
    "modification_time": "2023-01-25T16:21:48.308234Z"
  },
  {
    "description": "Social Security Number",
    "name": "ssn",
    "data_type_name": "SSN",
    "is_unique": true,
    "is_index": true,
    "is_substring_index": false,
    "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"
  }
]

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."
• error_url - string

  The URL to the error documentation.

  Example: "https://docs.piiano.com/api/error-codes#PV1005"

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."
• error_url - string

  The URL to the error documentation.

  Example: "https://docs.piiano.com/api/error-codes#PV1005"

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."
• error_url - string

  The URL to the error documentation.

  Example: "https://docs.piiano.com/api/error-codes#PV1005"

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."
• error_url - string

  The URL to the error documentation.

  Example: "https://docs.piiano.com/api/error-codes#PV1005"

Example

{
  "context": {
    "objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
  },
  "error_code": "PVxxxx",
  "message": "The object is not found.",
  "error_url": "https://docs.piiano.com/api/error-codes#PV1005"
}

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."
• error_url - string

  The URL to the error documentation.

  Example: "https://docs.piiano.com/api/error-codes#PV1005"

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."
• error_url - string

  The URL to the error documentation.

  Example: "https://docs.piiano.com/api/error-codes#PV1005"

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."
• error_url - string

  The URL to the error documentation.

  Example: "https://docs.piiano.com/api/error-codes#PV1005"

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."
• error_url - string

  The URL to the error documentation.

  Example: "https://docs.piiano.com/api/error-codes#PV1005"

Example

{
  "error_code": "PV1000",
  "message": "Something went wrong",
  "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."
• error_url - string

  The URL to the error documentation.

  Example: "https://docs.piiano.com/api/error-codes#PV1005"

Example

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

Try the API

Authorization

API key:

Path parameters

Collection*:

Query parameters

Custom_audit:

Options:

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

Code examples

Example