Common Endpoints

Common Endpoints

• Get catalog entities filtered by query

• Get a catalog entity by id

• Delete a catalog entity

• Get metadata of a given catalog

• Update the metadata for a catalog

Common Endpoints

Get catalog entities filtered by query.

post

/public/v1/catalog/entities

Body

searchTermsstring

Term to search by

searchOnlyByNameboolean

Perform search only by entity name. By default search will be performed considering all text properties

pageNumbernumber

pageSizenumber · default: 20

includePropertiesstring[]

Entity properties that will be returned in result. By default all entity properties are included in response. If includeProperties is passed, regardless of which properties are specified, 'id' and 'type' fields will be always included

typesstring · enum[]

Catalog entity types to filter by

sortall of

Sort entities by property in ASC or DESC order

propertyFiltersone of[]

Filters for matching properties' values: Can be SIMPLE and COMPOUND. SIMPLE is a key-value pair. COMPOUND is a set of key-value pairs combined with OR or AND operator

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app.configure8.io/public/v1/catalog/entities' \
  --header 'Content-Type: application/json' \
  --data '{"searchOnlyByName":false,"pageNumber":0,"pageSize":20,"includeProperties":[null],"types":["application"],"sort":{"property":"text","order":"ASC"},"propertyFilters":[{"value":"text","filterType":"SIMPLE","name":"id"}]}'

200

400

401

403

200

{
  "totalFound": 1,
  "pageNumber": 1,
  "pageSize": 1,
  "items": [
    {
      "id": "text",
      "name": "text",
      "orgId": "text",
      "description": "text",
      "createdBy": "text",
      "lastChangedBy": "text",
      "createDateTime": "2025-02-21T18:03:00.479Z",
      "lastChangedDateTime": "2025-02-21T18:03:00.479Z",
      "type": "application",
      "metaTags": [
        {
          "name": "text",
          "value": "text",
          "type": "JSON",
          "createdBy": "MANUAL"
        }
      ],
      "links": [
        {
          "url": "text",
          "title": "text",
          "icon": "text"
        }
      ],
      "parents": [
        {
          "id": "text",
          "secondaryId": "text",
          "field": "text",
          "label": "belongs_to"
        }
      ],
      "generalAccess": [
        "read"
      ],
      "permissions": {
        "ANY_ADDITIONAL_PROPERTY": [
          "create"
        ]
      }
    }
  ]
}

Get a catalog entity by id.

get

/public/v1/catalog/entities/{id}

Path parameters

idstringrequired

Unique id of catalog entity to return

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.configure8.io/public/v1/catalog/entities/{id}'

200

401

403

404

200

{
  "id": "text",
  "name": "text",
  "orgId": "text",
  "description": "text",
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2025-02-21T18:03:00.479Z",
  "lastChangedDateTime": "2025-02-21T18:03:00.479Z",
  "type": "application",
  "metaTags": [
    {
      "name": "text",
      "value": "text",
      "type": "JSON",
      "createdBy": "MANUAL"
    }
  ],
  "links": [
    {
      "url": "text",
      "title": "text",
      "icon": "text"
    }
  ],
  "parents": [
    {
      "id": "text",
      "secondaryId": "text",
      "field": "text",
      "label": "belongs_to"
    }
  ],
  "generalAccess": [
    "read"
  ],
  "permissions": {
    "ANY_ADDITIONAL_PROPERTY": [
      "create"
    ]
  }
}

Delete the specified catalog entity

delete

/public/v1/catalog/entities/{id}

Path parameters

idstringrequired

Unique ID for given catalog entity.

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://app.configure8.io/public/v1/catalog/entities/{id}'

200

401

403

404

409

200

No body

Metadata type possible values:

"JSON", "Code", "Link", "Text", "AutoMap", "Nickname"

Get catalog entity's metadata id.

get

/public/v1/catalog/metadata/{id}

Path parameters

idstringrequired

Unique id of catalog entity to return its metadata

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.configure8.io/public/v1/catalog/metadata/{id}'

200

400

401

403

404

200

{
  "id": "text",
  "orgId": "text",
  "type": "application",
  "metaTags": [
    {
      "name": "text",
      "value": "text",
      "type": "JSON",
      "createdBy": "MANUAL"
    }
  ]
}

Update catalog entity's metadata by id.

put

/public/v1/catalog/metadata/{id}

Path parameters

idstringrequired

Unique id of catalog entity to update its metadata

Body

metaTagsobject[]

Catalog entity's metadata

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://app.configure8.io/public/v1/catalog/metadata/{id}' \
  --header 'Content-Type: application/json' \
  --data '{"metaTags":[{"name":"text","value":"text","type":"JSON","createdBy":"MANUAL"}]}'

200

401

403

404

422

200

{
  "id": "text",
  "orgId": "text",
  "type": "application",
  "metaTags": [
    {
      "name": "text",
      "value": "text",
      "type": "JSON",
      "createdBy": "MANUAL"
    }
  ]
}

NB: Only meta tags and tags can be updated for discovery-created resources