Skip to main content
GET
Read a catalog resource

Authorizations

Authorization
string
header
required

murmur API key: mur_<key_id>.

Path Parameters

ref.kind
string
required

e.g. "vm-profile", "environment", "pool-config"

ref.name
string
required

resource name within the kind (required)

Query Parameters

ref.tenant.provider
enum<string>
default:PROVIDER_UNSPECIFIED

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
ref.tenant.org
string

username or org name

Response

A successful response.

kind
string
payload
string<byte>

The resource document as base64-encoded JSON.

inputFormat
enum<string>
default:INPUT_FORMAT_UNSPECIFIED

InputFormat describes how the CLI accepts input for a catalog resource kind.

Available options:
INPUT_FORMAT_UNSPECIFIED,
INPUT_FORMAT_YAML,
INPUT_FORMAT_MARKDOWN
generation
string<int64>

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).