Retrieve a specific key - Mezmo Docs

GET

/

v1

/

config

/

keys

/

{id}

Retrieve a specific key

curl --request GET \
  --url https://api.mezmo.com/v1/config/keys/{id} \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

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::Get.new(url)
request["Authorization"] = '<api-key>'

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

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

{
  "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

id

string

required

The id of the key to retrieve The ID of the key

Example:

"629e3f7e62295be60488fb26"

Response

The key with the supplied id was found, the entire resource is returned.

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

⌘I

Retrieve a specific key

curl --request GET \
  --url https://api.mezmo.com/v1/config/keys/{id} \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

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::Get.new(url)
request["Authorization"] = '<api-key>'

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

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

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