Relation Endpoints

NB: create/delete relations between discovery created resources are forbidden

PreviousCommon Endpoints NextBatch Endpoints

Last updated 5 months ago

GET a list of catalog relations.

get

/public/v1/catalog/relations

Query parameters

sourceIdstring

Id of the source entity from which we want to get, if not provided, it will return all relations of the target entity or all relations if targetId is not provided

targetIdstring

Id of the target entity from which we want to get, if not provided, it will return all relations of the source entity or all relations if sourceId is not provided

pageNumbernumber

pageSizenumber · default: 20

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://app.configure8.io/public/v1/catalog/relations'

200

{
  "totalFound": 1,
  "pageNumber": 1,
  "pageSize": 1,
  "items": [
    {
      "sourceEntityId": "text",
      "targetEntityId": "text",
      "field": "text",
      "label": "belongs_to"
    }
  ]
}

Create relation between catalog entities. NB: Resource-Resource relations are available only for non-discovery created resources.

post

/public/v1/catalog/relations

Body

serviceIdstring

Service id as an additional relation parameter. Used ONLY when creating Environment-Resource relation

sourceEntityIdstringrequired

Id of the entity from which we want to create a relation

targetEntityIdstringrequired

Id of the entity to which we want to create a relation

fieldstring

Entity relation field

labelstring · enumrequired

Entity relation type

Options: belongs_to, depends_on, provides, has_environment, part_of, consumes, uses, contains, has_repository, has_library, has_manifest, has_dependency, child_of, relative_to, owned_by,

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://app.configure8.io/public/v1/catalog/relations' \
  --header 'Content-Type: application/json' \
  --data '{"sourceEntityId":"text","targetEntityId":"text","label":"belongs_to"}'

201

400

401

403

404

422

{
  "sourceEntityId": "text",
  "targetEntityId": "text",
  "field": "text",
  "label": "belongs_to"
}

Delete catalog entity relation.

delete

/public/v1/catalog/relations

Body

serviceIdstring

Catalog relation service id

sourceEntityIdstringrequired

Catalog Source entity id

targetEntityIdstringrequired

Catalog Target entity id

fieldstring

Entity relation field

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://app.configure8.io/public/v1/catalog/relations' \
  --header 'Content-Type: application/json' \
  --data '{"sourceEntityId":"text","targetEntityId":"text"}'

200

401

403

404

422

No body