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.

POSThttps://app.configure8.io/public/v1/catalog/entities

Body

application/json

propertyFiltersarray of one 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

searchTermsstring

Term to search by

searchOnlyByNameboolean

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

typesarray of enum

Catalog entity types to filter by

includePropertiesarray of string

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

pageNumbernumber

pageSizenumber

sortall of

Sort entities by property in ASC or DESC order

Response

200400401403

Body

application/json

totalFound*number

Total elements found

pageNumber*number

pageSize*number

items*array of CatalogEntityDto (object)

Found catalog entities

Request

JavaScriptCurlPython

const response = await fetch('https://app.configure8.io/public/v1/catalog/entities', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "totalFound": 0,
  "pageNumber": 0,
  "pageSize": 0,
  "items": [
    {
      "id": "text",
      "name": "text",
      "orgId": "text",
      "type": "application",
      "description": "text",
      "metaTags": [
        {
          "name": "text",
          "value": "text",
          "type": "JSON",
          "createdBy": "MANUAL"
        }
      ],
      "links": [
        {
          "url": "text",
          "title": "text",
          "icon": "text"
        }
      ],
      "parents": [
        {
          "id": "text",
          "secondaryId": "text",
          "label": "belongs_to",
          "field": "text"
        }
      ],
      "createdBy": "text",
      "lastChangedBy": "text",
      "createDateTime": "2024-09-16T19:06:46.665Z",
      "lastChangedDateTime": "2024-09-16T19:06:46.665Z",
      "generalAccess": [
        "read"
      ]
    }
  ]
}

Get a catalog entity by id.

GEThttps://app.configure8.io/public/v1/catalog/entities/{id}

Path parameters

id*string

Unique id of catalog entity to return

Response

200401403404

Body

application/json

id*string

name*string

orgId*string

type*enum

Catalog entity type

applicationsystemserviceresourceenvironmentpersonapirepositorylibrarymanifestteambaserangecostvulnerability

descriptionstring

Catalog entity description

metaTagsarray of MetadataTagDto (object)

Catalog entity's metadata

linksarray of MetadataLinkDto (object)

Catalog entity's links

parentsarray of EntityParentDto (object)

Catalog entity's parents

createdBystring

lastChangedBystring

createDateTimestring (date-time)

lastChangedDateTimestring (date-time)

permissionsobject

List of permissions linked to this entity. The 'permissions' property is an optional object where the keys can represent either user identifier or team identifier, and the value is array of the permissions associated with each user or team.

generalAccessarray of enum

Entity visibility control. By default it is set to a default access control on organization level

Request

JavaScriptCurlPython

const response = await fetch('https://app.configure8.io/public/v1/catalog/entities/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "text",
  "name": "text",
  "orgId": "text",
  "type": "application",
  "description": "text",
  "metaTags": [
    {
      "name": "text",
      "value": "text",
      "type": "JSON",
      "createdBy": "MANUAL"
    }
  ],
  "links": [
    {
      "url": "text",
      "title": "text",
      "icon": "text"
    }
  ],
  "parents": [
    {
      "id": "text",
      "secondaryId": "text",
      "label": "belongs_to",
      "field": "text"
    }
  ],
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2024-09-16T19:06:46.665Z",
  "lastChangedDateTime": "2024-09-16T19:06:46.665Z",
  "generalAccess": [
    "read"
  ]
}

Delete the specified catalog entity

DELETEhttps://app.configure8.io/public/v1/catalog/entities/{id}

Path parameters

id*string

Unique ID for given catalog entity.

Response

200401403404409

Request

JavaScriptCurlPython

const response = await fetch('https://app.configure8.io/public/v1/catalog/entities/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Metadata type possible values:

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

Get catalog entity's metadata id.

GEThttps://app.configure8.io/public/v1/catalog/metadata/{id}

Path parameters

id*string

Unique id of catalog entity to return its metadata

Response

200400401403404

Body

application/json

id*string

orgId*string

type*enum

Catalog entity type

applicationsystemserviceresourceenvironmentpersonapirepositorylibrarymanifestteambaserangecostvulnerability

metaTagsarray of MetadataTagDto (object)

Catalog entity's metadata

Request

JavaScriptCurlPython

const response = await fetch('https://app.configure8.io/public/v1/catalog/metadata/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Update catalog entity's metadata by id.

PUThttps://app.configure8.io/public/v1/catalog/metadata/{id}

Path parameters

id*string

Unique id of catalog entity to update its metadata

Body

application/json

metaTagsarray of MetadataTagDto (object)

Catalog entity's metadata

Response

200401403404422

Body

application/json

id*string

orgId*string

type*enum

Catalog entity type

applicationsystemserviceresourceenvironmentpersonapirepositorylibrarymanifestteambaserangecostvulnerability

metaTagsarray of MetadataTagDto (object)

Catalog entity's metadata

Request

JavaScriptCurlPython

const response = await fetch('https://app.configure8.io/public/v1/catalog/metadata/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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