---
title: "Update several deployment settings"
method: POST
path: "/api/v1/settings"
tags: ["Settings"]
---

# Update several deployment settings

`POST /api/v1/settings`

## Request

- Base URL: `https://pcp.example.com`
- URL: `https://pcp.example.com/api/v1/settings`
- Auth: HTTP bearer

## Request body

- Settings: Settings schema
  - `alerting` object, nullable
    - `email` string
  - `auth` object, nullable
    - `api_key_rotation_grace_hours` integer
    - `api_key_rotation_ttl_days` integer
    - `badge_ttl_seconds` integer
  - `edge` object, nullable
    - `enrollment_key` string
  - `mailer` object, nullable
    - `from_address` string
    - `host` string
    - `password` string
    - `port` integer
    - `tls` boolean
    - `username` string
  - `packages` object, nullable
    - `repository_url` string
  - `retention` object, nullable
    - `min_versions` integer, nullable
  - `security` object, nullable
    - `mfa_enforced` boolean
  - `sso` object, nullable
    - `providers` object[]
      - `domains` string[]
      - `provider` string
  - `vector` object, nullable
    - `address` string
  - `webhook` object, nullable
    - `auth_type` string
    - `enabled` boolean
    - `events` object
    - `secret` string
    - `url` string

## Response `200`

OK

- Settings: Settings schema
  - `alerting` object, nullable
    - `email` string
  - `auth` object, nullable
    - `api_key_rotation_grace_hours` integer
    - `api_key_rotation_ttl_days` integer
    - `badge_ttl_seconds` integer
  - `edge` object, nullable
    - `enrollment_key` string
  - `mailer` object, nullable
    - `from_address` string
    - `host` string
    - `password` string
    - `port` integer
    - `tls` boolean
    - `username` string
  - `packages` object, nullable
    - `repository_url` string
  - `retention` object, nullable
    - `min_versions` integer, nullable
  - `security` object, nullable
    - `mfa_enforced` boolean
  - `sso` object, nullable
    - `providers` object[]
      - `domains` string[]
      - `provider` string
  - `vector` object, nullable
    - `address` string
  - `webhook` object, nullable
    - `auth_type` string
    - `enabled` boolean
    - `events` object
    - `secret` string
    - `url` string

## Other responses

- `400`: Bad Request _(validation or deserialization error)_
- `401`: Missing, invalid or expired credentials
- `403`: The caller may not do this
- `500`: Internal Server Error _(panics)_
- `default`

---

[API](https://skmtc.dev/plakar/apis/plakar-control-plane-api-v1.md) - [All operations](https://skmtc.dev/plakar/apis/plakar-control-plane-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/plakar/apis/plakar-control-plane-api-v1/revisions/2ac049494a01?raw)