---
title: "Bootstrap catalog"
method: POST
path: "/catalog/bootstrap"
---

# Bootstrap catalog

`POST /catalog/bootstrap`

## Request

- Base URL: `https://docs.vertica.com/v1`
- URL: `https://docs.vertica.com/v1/catalog/bootstrap`
- Auth: none declared
- TypeScript: <https://skmtc.dev/vertica/apis/node-management-agent-api/docs/catalog/bootstrap/post.ts> (a function with typed inputs; its response is checked against the schema)

## Request body

- BootstrapCatalogParams: Parameters for bootstrapping the catalog All values in the request but not in this struct are silently ignored.
  - `aws_access_key_id` string
  - `aws_secret_access_key` string
  - `broadcast_addr` string
  - `catalog_path` string
  - `communal_storage` string
  - `control_addr` string
  - `db_name` string
  - `db_password` string
  - `generate_http_certs` boolean
  - `host` string
  - `ipv6` boolean
  - `large_cluster` integer
  - `license_key` string
  - `networking_mode` string
  - `node_name` string
  - `num_shards` integer
  - `parameters` object
  - `port_number` integer
  - `spread_logging` boolean
  - `spread_logging_level` integer
  - `spread_port` string
  - `storage_location` string
  - `superuser_name` string

## Response `200`

A GenericMapResponse is the default response that is generated,
the response value is of type "Map" with both key and value of type "string".

- object

## Other responses

- `400`: A RFC7807Error is a generated error that follows RFC7807 specification.
- `405`: A RFC7807Error is a generated error that follows RFC7807 specification.
- `500`: A RFC7807Error is a generated error that follows RFC7807 specification.

---

[API](https://skmtc.dev/vertica/apis/node-management-agent-api.md) - [All operations](https://skmtc.dev/vertica/apis/node-management-agent-api/llms.txt) - [OpenAPI document](https://skmtc.dev/vertica/apis/node-management-agent-api/revisions/1d9449e2142a?raw)