Read a catalog resource
curl --request GET \
--url https://api.murmur.dev/v1/catalog/{ref.kind}/{ref.name} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.murmur.dev/v1/catalog/{ref.kind}/{ref.name}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.murmur.dev/v1/catalog/{ref.kind}/{ref.name}', 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.murmur.dev/v1/catalog/{ref.kind}/{ref.name}",
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: Bearer <token>"
],
]);
$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.murmur.dev/v1/catalog/{ref.kind}/{ref.name}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.murmur.dev/v1/catalog/{ref.kind}/{ref.name}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.murmur.dev/v1/catalog/{ref.kind}/{ref.name}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"kind": "<string>",
"payload": "aSDinaTvuI8gbWludGxpZnk=",
"inputFormat": "INPUT_FORMAT_UNSPECIFIED",
"generation": "<string>"
}{
"code": 123,
"message": "<string>",
"details": [
{
"@type": "<string>"
}
]
}Endpoints
Read a catalog resource
GetResource returns a single catalog resource by kind and name.
GET
/
v1
/
catalog
/
{ref.kind}
/
{ref.name}
Read a catalog resource
curl --request GET \
--url https://api.murmur.dev/v1/catalog/{ref.kind}/{ref.name} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.murmur.dev/v1/catalog/{ref.kind}/{ref.name}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.murmur.dev/v1/catalog/{ref.kind}/{ref.name}', 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.murmur.dev/v1/catalog/{ref.kind}/{ref.name}",
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: Bearer <token>"
],
]);
$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.murmur.dev/v1/catalog/{ref.kind}/{ref.name}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.murmur.dev/v1/catalog/{ref.kind}/{ref.name}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.murmur.dev/v1/catalog/{ref.kind}/{ref.name}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"kind": "<string>",
"payload": "aSDinaTvuI8gbWludGxpZnk=",
"inputFormat": "INPUT_FORMAT_UNSPECIFIED",
"generation": "<string>"
}{
"code": 123,
"message": "<string>",
"details": [
{
"@type": "<string>"
}
]
}Authorizations
murmur API key: mur_<key_id>.
Path Parameters
e.g. "vm-profile", "environment", "pool-config"
resource name within the kind (required)
Query Parameters
Identity provider of the tenant namespace (e.g. PROVIDER_GITHUB_APP for a GitHub org).
Available options:
PROVIDER_UNSPECIFIED, PROVIDER_GITHUB_OAUTH, PROVIDER_GITHUB_APP, PROVIDER_GOOGLE_OIDC, PROVIDER_SERVICE_PROFILE username or org name
Response
A successful response.
The resource document as base64-encoded JSON.
InputFormat describes how the CLI accepts input for a catalog resource kind.
Available options:
INPUT_FORMAT_UNSPECIFIED, INPUT_FORMAT_YAML, INPUT_FORMAT_MARKDOWN Version generation of the stored resource, read atomically with payload. Pass it back as SetResourceRequest.if_generation_match for a consistent read-modify-write. 0 when the resource has no stored version (platform builtins and change-request records).