Update bundle

patch

/api/pvlt/1.0/ctl/bundles/{bundle}

Updates a bundle.

An update is allowed only if the prototypes of the JavaScript functions in the request are a superset of those in the bundle. The name of the bundle can't be updated.

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

Request

Path parameters

• bundle - string required*

  The name of a bundle.

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

Request body

Details of the bundle including the code that defines the functions as properties of the exports object. Name can't be updated.

application/json

object required*

Min properties: 1Properties:

• description - string

  The description of a model.

  Max length: 450
• code - string

  A byte[] containing a self-contained JavaScript code snippet.

  Format: byte

Example

{
  "name": "example_bundle",
  "description": "An example bundle that exports a validator, normalizer, and transformer",
  "code": "U2FtcGxlIGNvZGU="
}

Possible responses

200

The request is successful.

application/json

required*

All of:

12

Min properties: 1Properties:

• description - string

  The description of a model.

  Max length: 450
• code - string

  A byte[] containing a self-contained JavaScript code snippet.

  Format: byte

Example

{
  "name": "example_bundle",
  "description": "An example bundle that exports a validator, normalizer, and transformer",
  "exports": {
    "validators": [
      {
        "name": "is_positive",
        "type": "validator",
        "description": "A validator that returns true if its argument is positive.",
        "dependencies": {
          "properties": [],
          "http_get_access": [],
          "http_post_access": []
        }
      }
    ],
    "normalizers": [
      {
        "name": "to_lower",
        "type": "normalizer",
        "description": "A normalizer that formats a string to lowercase without any dependencies."
      }
    ],
    "transformers": [
      {
        "name": "to_name_with_title",
        "type": "transformer",
        "description": "A transformer that accepts a full name and returns it prepended with a title.",
        "dependencies": {
          "properties": [
            "gender",
            "marital_status"
          ]
        }
      }
    ]
  },
  "code": "U2FtcGxlIGNvZGU=",
  "creation_time": "2022-12-02T02:02:14.398599Z"
}

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 bundle 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

{
  "error_code": "PV1004",
  "message": "The bundle is not found.",
  "context": {}
}

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": {}
}

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

Bundle*:

Request body

Content-Type:

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

Code examples

Example