MAmailcow
API Keys

Update API keys

Changed on

Update API keys. Attributes you do not send keep their value, regen_key replaces the key value with a new random one. Service keys from mailcow.conf cannot be changed (api_key_service_locked).

post/api/v1/edit/api-key

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header X-API-Key

Request body

itemsobject

contains list of API key IDs you want to update

Example request

{
  "items": [
    "3"
  ],
  "attr": {
    "description": "provisioning",
    "access": "ro",
    "allow_from": "192.0.2.10",
    "skip_ip_check": "0",
    "active": "1",
    "regen_key": "0"
  }
}

Response

OK

type'success' | 'danger' | 'error'

Changes