Upgrade a Resource

Upgrade resources that are eligible for an upgrade to v5 format.

post/metadata/upgrade/resources.json

Request

Base URL
https://passbolt.local
Auth
HTTP bearer
TypeScript
https://skmtc.dev/passbolt/apis/passbolt-api/docs/metadata/upgrade/resources.json/post.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

filter[is-shared]boolean

Only return shared items.

contain[permissions]1 | 0

Add permissions to response body.

Request body

metadatastring required

An armoured OpenPGP message. Its cleartext is a JSON object carrying an object_type field that names the payload, PASSBOLT_RESOURCE_METADATA for a resource, and the descriptive fields that used to travel in clear in the v4 format. The fields expected for a resource, and the two decryption paths, are described in the guide on working with v5 encrypted metadata.

metadata_key_idstring uuid required

metadata_key_type'user_key' | 'shared_key' required

idstring uuid required

modifiedstring date-time required

modified_bystring uuid required

Response

Operation is successful.

Changes

No recorded changes to this operation across all 1 revision of this API.