Describe catalog

Returns non-secret details for a catalog in the selected environment. When that environment has no same-named catalog, the catalog from default is returned instead. The response's catalog environment identifies where its definition is stored.

get/catalogs/{name}

Request

Base URL
https://api.tower.dev/v1
Auth
- HTTP bearer
- or API key in header X-API-Key
TypeScript
https://skmtc.dev/tower/apis/tower-api/docs/catalogs/:name/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

namestring required

The name of the catalog.

Query parameters

environmentstring

Environment whose catalog to return. When it has no same-named catalog, the catalog from default is returned instead.

Response

$schemastring uri

A URL to the JSON Schema for this object.

Example response

{
  "$schema": "https://api.tower.dev/v1/schemas/DescribeCatalogResponse.json"
}

Changes

No recorded changes to this operation across all 12 revisions of this API.