Search
K
Konnect Service Catalog

Resource Mappings

Create Resource Mapping

Creates a mapping between a catalog resource and service.

post

Body

application/json

CreateCatalogResourceMapping

* Additional properties are NOT allowed.
servicestringrequired

The id or name of the service to map the resource to.

Example:user-svc

resourceOne Of
required
CatalogResourceIdstring(base64url)

The resource ID.

>= 16 characters<= 16 characters

Example:4UdXnoaDYYJsH_Ir

Response

201 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
post/resource-mappings

Body

{ "service": "user-svc", "resource": "4UdXnoaDYYJsH_Ir" }
 
201 application/json

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