Update one or more fields of a key resource

PUT

config

keys

{id}

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"
}
'

import requests

url = "https://api.mezmo.com/v1/config/keys/{id}"

payload = { "name": "servergroup_0_ingestion" }
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'servergroup_0_ingestion'})
};

fetch('https://api.mezmo.com/v1/config/keys/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mezmo.com/v1/config/keys/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'servergroup_0_ingestion'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mezmo.com/v1/config/keys/{id}"

	payload := strings.NewReader("{\n  \"name\": \"servergroup_0_ingestion\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.mezmo.com/v1/config/keys/{id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"servergroup_0_ingestion\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mezmo.com/v1/config/keys/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"servergroup_0_ingestion\"\n}"

response = http.request(request)
puts response.read_body

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

{
  "error": "\"name\" length must be less than or equal to 30 characters long",
  "code": "BadRequest",
  "status": "error"
}

{
  "error": "Key with id 629eb5369e5b231f51d3830f was not found",
  "code": "NotFound",
  "status": "error"
}

Authorizations

Authorization

string

header

required

The primary authentication method for the Mezmo API.

Pass the key in the Authorization header in the format Token <ACCESS TOKEN>. For example:

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

This key is used for all APIs with the exception of ingest.

Path Parameters

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

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

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

⌘I

Update one or more fields of a key resource

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"
}
'

import requests

url = "https://api.mezmo.com/v1/config/keys/{id}"

payload = { "name": "servergroup_0_ingestion" }
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'servergroup_0_ingestion'})
};

fetch('https://api.mezmo.com/v1/config/keys/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mezmo.com/v1/config/keys/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'servergroup_0_ingestion'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mezmo.com/v1/config/keys/{id}"

	payload := strings.NewReader("{\n  \"name\": \"servergroup_0_ingestion\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.mezmo.com/v1/config/keys/{id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"servergroup_0_ingestion\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mezmo.com/v1/config/keys/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"servergroup_0_ingestion\"\n}"

response = http.request(request)
puts response.read_body

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

{
  "error": "\"name\" length must be less than or equal to 30 characters long",
  "code": "BadRequest",
  "status": "error"
}

{
  "error": "Key with id 629eb5369e5b231f51d3830f was not found",
  "code": "NotFound",
  "status": "error"
}