Search
K
Konnect Service Catalog

List Resource Mappings

Returns a paginated collection of catalog resource mappings.

get

Query Parameters

filterobject

Filters a collection of resource mappings.

sort

Sorts a collection of resource mappings. Supported sort attributes are:

  • created_at

Default sort is created_at in descending order.

Response

200 application/json

A paginated list response for a collection of catalog resource mappings.

* Additional properties are NOT allowed.
metarequired
dataarray[object]required

Describes a mapping between a catalog resource and a service.

Show Child Parameters
get/resource-mappings
 
200 application/json

Fetch Resource Mapping

Fetches a resource mapping by ID.

get

Path Parameters

idstring(uuid)required

The id of the resource mapping.

Example:d277faad-ed4e-4c56-a0fb-acce065dee34

Response

200 application/json

A response containing a single catalog resource mapping.

CatalogResourceMapping

Describes a mapping between a catalog resource and a service.

idstring(uuid)required

The resource mapping ID.

Example:d277faad-ed4e-4c56-a0fb-acce065dee34

resourceobjectrequired

Short-hand descriptor of a catalog resource.

Show Child Parameters
serviceobjectrequired

Short-hand descriptor of a catalog service.

Show Child Parameters
get/resource-mappings/{id}
 
200 application/json

Delete Resource Mapping

Removes an existing mapping between a catalog resource and service.

delete

Path Parameters

idstring(uuid)required

The id of the resource mapping.

Example:d277faad-ed4e-4c56-a0fb-acce065dee34

Response

204

Resource Mapping was deleted successfully.

delete/resource-mappings/{id}
 
204

Service Resources

List Service Resources

Returns a paginated collection of resources mapped to a service.

get

Query Parameters

filterobject

Filters a collection of resources.

Path Parameters

idstringrequired

The id of the service.

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

Response

200 application/json

A paginated list response for a collection of resources mapped to a service.

* Additional properties are NOT allowed.
metarequired
dataarray[object]required

Information about a catalog resource.

Show Child Parameters
get/services/{id}/resources
 
200 application/json