Batch Endpoints

NB: max batch size equals 50 elements

PreviousRelation Endpoints NextApplication

Last updated 5 months ago

Batch create new resource catalog entities

post

/public/v1/catalog/batch/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 -L \
  --request POST \
  --url 'https://app.configure8.io/public/v1/catalog/batch/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"]}}]'

200

401

403

{
  "success": 1,
  "failures": 1,
  "items": [
    {
      "id": "text",
      "name": "text",
      "orgId": "text",
      "description": "text",
      "createdBy": "text",
      "lastChangedBy": "text",
      "createDateTime": "2025-02-21T18:03:22.913Z",
      "lastChangedDateTime": "2025-02-21T18:03:22.913Z",
      "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"
        ]
      }
    }
  ],
  "failed": [
    {
      "providerResourceKey": "text",
      "status": 1,
      "error": "text"
    }
  ]
}

Batch create new base catalog entities

post

/public/v1/catalog/batch/entities/base

Body

namestringrequired

Name of the entity

descriptionstring

Description of the entity

providerResourceTypestringrequired

Provider resource type

detailsobject

Resource details in json format

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://app.configure8.io/public/v1/catalog/batch/entities/base' \
  --header 'Content-Type: application/json' \
  --data '[{"name":"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"]}}]'

200

{
  "success": 1,
  "failures": 1,
  "items": [
    {
      "id": "text",
      "name": "text",
      "orgId": "text",
      "description": "text",
      "createdBy": "text",
      "lastChangedBy": "text",
      "createDateTime": "2025-02-21T18:03:22.913Z",
      "lastChangedDateTime": "2025-02-21T18:03:22.913Z",
      "providerResourceType": "text",
      "details": {},
      "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"
        ]
      }
    }
  ],
  "failed": [
    {
      "name": "text",
      "status": 1,
      "error": "text"
    }
  ]
}

Batch delete the specified catalog entities

delete

/public/v1/catalog/batch/entities

Body

idsstring[]required

Ids of entities to delete

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://app.configure8.io/public/v1/catalog/batch/entities' \
  --header 'Content-Type: application/json' \
  --data '{"ids":[null]}'

200

401

403

{
  "deleted": 1
}