---
title: "Create a metadata key."
method: POST
path: "/metadata/keys.json"
tags: ["Metadata keys"]
---

# Create a metadata key.

`POST /metadata/keys.json`

## Request

- Base URL: `https://passbolt.local`
- URL: `https://passbolt.local/metadata/keys.json`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/passbolt/apis/passbolt-api/docs/metadata/keys.json/post.ts> (a function with typed inputs; its response is checked against the schema)

## Request body

- MetadataKeyAdd
  - `armored_key` string, required
  - `fingerprint` string, required
  - `metadata_private_keys` E2eeDataUserId[], required
    - `data` string, required
    - `user_id` string, uuid, required

## Response `200`

Operation is successful

- object
  - `header` Header, required
    - `id` string, uuid, required
    - `status` 'success' | 'error', required
    - `servertime` integer, required
    - `action` string, uuid, required
    - `message` string, required
    - `url` string, uri, required
    - `code` integer, required
  - `body` MetadataKeysIndexAndView[], required
    - `fingerprint` string, required
    - `armored_key` string, required
    - `expired` string, date-time, required
    - `data` string, required
    - `user_id` string, uuid, required
    - `id` string, uuid, required
    - `created` string, date-time, required
    - `modified` string, date-time, required
    - `deleted` string, date-time, required
    - `created_by` string, uuid, required
    - `modified_by` string, uuid, required
    - `metadata_private_keys` MetadataPrivateKeysIndexAndView[]
      - `data` string, required
      - `user_id` string, uuid, required
      - `created_by` string, uuid, required
      - `modified_by` string, uuid, required
      - `id` string, uuid, required
      - `metadata_key_id` string, uuid, required
      - `created` string, date-time, required
      - `modified` string, date-time, required

## Other responses

- `400`: Bad request
- `401`: Authentication required.

---

[API](https://skmtc.dev/passbolt/apis/passbolt-api.md) - [All operations](https://skmtc.dev/passbolt/apis/passbolt-api/llms.txt) - [OpenAPI document](https://skmtc.dev/passbolt/apis/passbolt-api/revisions/8d72215e2274?raw)