idstringrequired
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Get a Service
Fetches a service.
get
Path Parameters
Response
application/json
Response
application/json
A response containing a single service object.
CatalogService
The service object contains information about a Service Catalog service.
idstring(uuid)requiredread-only
The service ID.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
namestringrequired
The machine name of the Service that uniquely identifies it within the catalog.
Match pattern:^[0-9a-z.-]+$
>= 1 characters<= 120 characters
Example:user-svc
display_namestringrequired
The display name of the Service.
>= 1 characters<= 120 characters
Example:User Service
descriptionstring | nullrequired
Optionally provide a description of the Service.
<= 2048 characters
custom_fieldsobjectrequired
Map of customizable, catalog-defined fields providing information about a service.
Example:{"owner":"John Appleseed","dashboard":{"name":"On-Call Dashboard","link":"https://my-dashboard-svc.io/dashboards/1"}}
labelsobjectrequired
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
created_atstring(date-time)requiredread-only
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
updated_atstring(date-time)requiredread-only
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
get/catalog-services/{id}
Authentication
Path Parameters
application/json
Update Service
Updates a service.
patch
Path Parameters
idstringrequired
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Body
application/json
Body
application/json
UpdateCatalogService
* Additional properties are NOT allowed.
namestring
The machine name of the Service that uniquely identifies it within the catalog.
Match pattern:^[0-9a-z.-]+$
>= 1 characters<= 120 characters
Example:user-svc
display_namestring
The display name of the Service.
>= 1 characters<= 120 characters
Example:User Service
descriptionstring | null
Optionally provide a description of the Service.
<= 2048 characters
labelsobject | null
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
Labels are intended to store INTERNAL metadata.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
custom_fieldsobject
Map of customizable, catalog-defined fields providing information about a service.
Example:{"owner":"John Appleseed","dashboard":{"name":"On-Call Dashboard","link":"https://my-dashboard-svc.io/dashboards/1"}}
Response
application/json
Response
application/json
A response containing a single service object.
CatalogService
The service object contains information about a Service Catalog service.
idstring(uuid)requiredread-only
The service ID.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
namestringrequired
The machine name of the Service that uniquely identifies it within the catalog.
Match pattern:^[0-9a-z.-]+$
>= 1 characters<= 120 characters
Example:user-svc
display_namestringrequired
The display name of the Service.
>= 1 characters<= 120 characters
Example:User Service
descriptionstring | nullrequired
Optionally provide a description of the Service.
<= 2048 characters
custom_fieldsobjectrequired
Map of customizable, catalog-defined fields providing information about a service.
Example:{"owner":"John Appleseed","dashboard":{"name":"On-Call Dashboard","link":"https://my-dashboard-svc.io/dashboards/1"}}
labelsobjectrequired
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
created_atstring(date-time)requiredread-only
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
updated_atstring(date-time)requiredread-only
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
patch/catalog-services/{id}
Authentication
Path Parameters
Body
{
"description": "This is a sample service"
}
application/json
Delete Service
Deletes a service.
delete
Path Parameters
idstringrequired
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Response
Response
Service was deleted successfully.
delete/catalog-services/{id}
Authentication
Path Parameters
Catalog Service API Specs
Attach API specifications which describe the interface and behavior of the service.
These specifications describe service API constracts for internal or external consumption.
You may attach an API specification by uploading a file, providing a link to the specification, or my mapping a resource from a API spec compliant integration.
Create API spec
Creates an API spec associated to the given service.
post
Path Parameters
idstringrequired
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Body
application/json
Body
application/json
CreateCatalogServiceApiSpec
* Additional properties are NOT allowed.
namestringrequired
The name of the API
>= 1 characters<= 120 characters
Example:Pet Store
descriptionstring | nullrequired
The description of the API
<= 2048 characters
Example:A sample API that uses a pet store as an example to demonstrate features in the OpenAPI specification
provider
One Ofrequired
Represents the provider, or source, of an API spec
UrlApiSpecProviderobject
Show Child Parameters
Response
application/json
Response
application/json
A response containing a single API spec.
CatalogServiceApiSpec
idstring(uuid)required
The API spec ID
Example:eadb88fe-e8eb-45c2-9591-dc783f93f29b
service_idstring(uuid)required
The ID of the service the API spec is associated to.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
namestringrequired
The name of the API
>= 1 characters<= 120 characters
Example:Pet Store
descriptionstring | nullrequired
The description of the API.
<= 2048 characters
Example:A sample API that uses a pet store as an example to demonstrate features in the OpenAPI specification.
resource_idstring | nullrequired
The ID of the Resource that is bound to the API spec.
Only set when the given provider.type requires a 1-to-1 mapping between Resource
and API Spec.
Example:IqkHvMdyHukxcwAs
provider
Any Ofrequired
Represents the provider, or source, of API spec contents.
UrlApiSpecProviderobject
Show Child Parameters
created_atstring(date-time)requiredread-only
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
updated_atstring(date-time)requiredread-only
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
post/catalog-services/{id}/api-specs
Authentication
Path Parameters
Body
{
"name": "spec-from-url",
"description": "API Spec from URL",
"provider": {
"type": "url",
"config": {
"url": "https://my-company.com/api-specs/openapi.yaml"
}
}
}
application/json