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}

Update one or more fields of a key resource

cURL

curl --request PUT \
  --url https://api.mezmo.com/v1/config/keys/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "servergroup_0_ingestion"
}
'

200

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

Authorizations

AccessTokenservicekeyAuth

Authorization · string · header · required

This key is used for all apis with the exception of ingest. You can obtain it following these instructions and placing the key in the header of your call in the format of Authorization: Token {accesstoken} For example:

curl -H 'Authorization: Token <ACCESS TOKEN>'

Path Parameters

id · string · required

The id of the key to update The ID of the key

Example:

"629e3f7e62295be60488fb26"

Body

application/json

name · string

A user friendly name for the key

Maximum string length: 30

Example:

"servergroup_0_ingestion"

Response

200

application/json

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

id · string

The ID of the key

Example:

"629e3f7e62295be60488fb26"

key · string

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

Example:

"7b273eb8adc962f2711ad760730debb0"

name · string

A user friendly name for the key

Maximum string length: 30

Example:

"servergroup_0_ingestion"

type · enum<string>

The type of the key

Available options: ingestion, service

Example:

"ingestion"

created · integer

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

Example:

1654538253244