COcortex
Catalogs

Create or replace a catalog

Changed on

Creates a catalog, or replaces the existing one with the same slug.

API key must have the Edit catalogs permission.

post/api/v1/catalog-pages

Request

  • Base URL
    https://api.getcortexapp.com
  • URL
    https://api.getcortexapp.com/api/v1/catalog-pages
  • Auth
    HTTP bearer

Request body

descriptionstring

Optional description of the catalog

iconTagstring required

Tag of the icon shown for the catalog

isDraftboolean required

Whether the catalog is a draft

namestring required

Name of the catalog

relationshipTypeTagstring

Tag of the relationship type the catalog is built from, for a RELATIONSHIP_TYPE catalog

slugstring required

Unique identifier for the catalog

type'FILTER' | 'RELATIONSHIP_TYPE' | 'DOMAIN'

What the catalog is built from. Optional: inferred as FILTER when filter is set and RELATIONSHIP_TYPE when relationshipTypeTag is set. Must be set explicitly to DOMAIN for a domain catalog

Example request

{
  "iconTag": "cortex",
  "slug": "my-catalog"
}

Response

Successfully created or replaced the catalog

dateCreatedstring date-time required

Time the catalog was created

dateUpdatedstring date-time required

Time the catalog was last updated

descriptionstring

Optional description of the catalog

iconTagstring required

Tag of the icon shown for the catalog

isCortexManagedboolean required

Whether the catalog is managed by Cortex. Cortex-managed catalogs cannot be modified or deleted

isDraftboolean required

Whether the catalog is a draft

namestring required

Name of the catalog

relationshipTypeTagstring

Tag of the relationship type the catalog is built from, for RELATIONSHIP_TYPE catalogs

slugstring required

Unique identifier for the catalog

type'FILTER' | 'RELATIONSHIP_TYPE' | 'DOMAIN' required

What the catalog is built from: a filter, a relationship type, or the domain hierarchy

Example response

{
  "iconTag": "cortex",
  "slug": "my-catalog"
}

Changes