CatalogServiceFilterParameters
objectFilter using one of the following operators: eq, oeq, neq
Show Child Parameters
One OfFilter using one of the following operators: eq, oeq, neq, contains, ocontains
Show Child Parameters
One OfFilter using one of the following operators: eq, oeq, neq, contains, ocontains
Show Child Parameters
One OfFilter by custom fields using dot-notation to specify the custom field.
Filter operators are dictated by the custom field type. For example:
filter[custom_fields.owner]filter[custom_fields.owner][neq]=kongfilter[custom_fields.dashboard.link][contains]=https
One OfFilter using one of the following operators: eq, oeq, neq, contains, ocontains
Show Child Parameters
One OfFilter using one of the following operators: eq, oeq, neq, contains, ocontains
Show Child Parameters
One OfFilters on the given datetime (RFC-3339) field value.
Value strictly equals given RFC-3339 formatted timestamp in UTC
Example:2022-03-30T07:20:50Z
One OfFilters on the given datetime (RFC-3339) field value.
Value strictly equals given RFC-3339 formatted timestamp in UTC
Example:2022-03-30T07:20:50Z
CatalogService
objectThe service object contains information about a Service Catalog service.
The service ID.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
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
The display name of the Service.
>= 1 characters<= 120 characters
Example:User Service
Optionally provide a description of the Service.
<= 2048 characters
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"}}
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"}
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
CreateCatalogServiceApiSpec
objectThe name of the API
>= 1 characters<= 120 characters
Example:Pet Store
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
One OfRepresents the provider, or source, of an API spec
Show Child Parameters
UpdateCatalogServiceApiSpec
objectThe name of the API
>= 1 characters<= 120 characters
Example:Pet Store
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
One OfRepresents the provider, or source, of an API specs.
Note that provider cannot be patched for API specs that are bound to a resource.
Trying to do so will result in a 400 response.
Show Child Parameters
PreviewCatalogServiceApiSpec
objectOne OfRepresents the provider, or source, of an API spec