Sign in

v1

latestOpenAPI 3.1.02026-07-26189891.1 MB
Keys

Update one or more fields of a key resource

Updates all of the fields described in the request body of the specified key. Fields left out of the body will remain unaffected.

put/v1/config/keys/{id}

Path parameters

idstring required

The ID of the key

Example:629e3f7e62295be60488fb26

The id of the key to update

Request body

namestring

A user friendly name for the key

Example request

{
  "name": "servergroup_0_ingestion"
}

Response

The update was successful; the key resource is returned with updated fields.

idstring

The ID of the key

keystring

A secret key which can be used to authenticate requests to Mezmo.

namestring

A user friendly name for the key

type'ingestion' | 'service'

The type of the key

createdinteger

The time the key was created as a Unix timestamp in milliseconds

Example response

{
  "id": "629e3f7e62295be60488fb26",
  "key": "7b273eb8adc962f2711ad760730debb0",
  "name": "servergroup_0_ingestion",
  "type": "ingestion",
  "created": 1654538253244
}