Resource

• Create a resource entity

• Update a resource entity

Resource

Create a new resource catalog entity

post

/public/v1/catalog/entities/resource

Body

namestringrequired

Name of the entity

descriptionstring

Description of the entity

providerResourceKeystringrequired

The key/ID of the resource in the provider

Example: 123456789012

providerstringrequired

Provider name

providerResourceTypestringrequired

Provider resource type

providerAccountIdstring

The key/ID of the account that owns this resource

locationstring

Resource location

detailsobject

Resource details in json format

deepLinkUrlstring

Deep link to the resource

linksobject[]

List of URLs linked to this entity

metaTagsobject[]

List of metadata tags linked to this entity

parentsobject[]

Catalog entity's parents

generalAccessstring · enum[]

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

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 ("create", "delete", "execute", "modify", "read") associated with each user or team.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app.configure8.io/public/v1/catalog/entities/resource' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","providerResourceKey":"123456789012","provider":"text","providerResourceType":"text","details":{},"links":[{"url":"text","title":"text","icon":"text"}],"metaTags":[{"name":"text","value":"text","type":"JSON","createdBy":"MANUAL"}],"parents":[{"id":"text","secondaryId":"text","field":"text","label":"belongs_to"}],"generalAccess":["read"],"permissions":{"ANY_ADDITIONAL_PROPERTY":["create"]}}'

201

401

403

409

422

201

{
  "id": "text",
  "name": "text",
  "orgId": "text",
  "description": "text",
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2025-02-21T18:15:55.105Z",
  "lastChangedDateTime": "2025-02-21T18:15:55.105Z",
  "provider": "text",
  "providerType": "text",
  "providerResourceKey": "text",
  "providerResourceType": "text",
  "providerAccountId": "text",
  "location": "text",
  "details": {},
  "deepLinkUrl": "text",
  "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"
    ]
  }
}

Update a resource catalog entity

patch

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

Path parameters

idstringrequired

Unique id of catalog entity to update

Body

namestring

Catalog entity name, should be unique, not updatable for discovery created catalog entity

descriptionstring

Catalog entity description, not updatable for discovery created catalog entity

replaceMetadataTagsboolean

Replace metadata tags with the provided list

providerResourceKeystring

The key/ID of the resource in the provider

Example: 123456789012

providerAccountIdstring

The key/ID of the account that owns this resource

locationstring

Resource location

detailsobject

Resource details in json format

deepLinkUrlstring

Deep link to the resource

linksobject[]

List of URLs linked to this entity, replaces the existing list

metaTagsobject[]

List of metadata tags linked to this entity, replaces the existing list

permissionsPatternsstring[]

parentsobject[]

Catalog entity's parents, replaces the existing parents list

generalAccessstring · enum[]

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

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 ("create", "delete", "execute", "modify", "read") associated with each user or team.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://app.configure8.io/public/v1/catalog/entities/resource/{id}' \
  --header 'Content-Type: application/json' \
  --data '{"providerResourceKey":"123456789012","details":{},"links":[{"url":"text","title":"text","icon":"text"}],"metaTags":[{"name":"text","value":"text","type":"JSON","createdBy":"MANUAL"}],"permissionsPatterns":[null],"parents":[{"id":"text","secondaryId":"text","field":"text","label":"belongs_to"}],"generalAccess":["read"],"permissions":{"ANY_ADDITIONAL_PROPERTY":["create"]}}'

200

401

403

404

409

422

200

{
  "id": "text",
  "name": "text",
  "orgId": "text",
  "description": "text",
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2025-02-21T18:15:55.105Z",
  "lastChangedDateTime": "2025-02-21T18:15:55.105Z",
  "provider": "text",
  "providerType": "text",
  "providerResourceKey": "text",
  "providerResourceType": "text",
  "providerAccountId": "text",
  "location": "text",
  "details": {},
  "deepLinkUrl": "text",
  "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"
    ]
  }
}