Catalog Services

Update Service

Changed on

Updates a service.

patch/v1/catalog-services/{id}

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v1/catalog-services/{id}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Request body

namestring

The machine name of the Service that uniquely identifies it within the catalog.

display_namestring

The display name of the Service.

descriptionstring nullable

Optionally provide a description of the Service.

labelsLabelsUpdate nullable

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 "_".

custom_fieldsCustomFields

Map of customizable, catalog-defined fields providing information about a service.

Example request

{
  "name": "user-svc",
  "display_name": "User Service",
  "labels": {
    "env": "test"
  },
  "custom_fields": {
    "owner": "John Appleseed",
    "dashboard": {
      "name": "On-Call Dashboard",
      "link": "https://my-dashboard-svc.io/dashboards/1"
    }
  }
}

Response

A response containing a single service object.

idstring uuid required

The service ID.

namestring required

The machine name of the Service that uniquely identifies it within the catalog.

display_namestring required

The display name of the Service.

descriptionstring nullable required

Optionally provide a description of the Service.

custom_fieldsCustomFields required

Map of customizable, catalog-defined fields providing information about a service.

labelsLabels required

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 "_".

created_atstring date-time required

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time required

An ISO-8601 timestamp representation of entity update date.

Example response

{
  "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  "name": "user-svc",
  "display_name": "User Service",
  "custom_fields": {
    "owner": "John Appleseed",
    "dashboard": {
      "name": "On-Call Dashboard",
      "link": "https://my-dashboard-svc.io/dashboards/1"
    }
  },
  "labels": {
    "env": "test"
  },
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}

Changes

  • 7aab863a6daaRevision changes
    • breaking

      added to the / response property oneOf list for the response status

    • warning

      added the new key_invalid enum value to the ////// response property for the response status

    • warning

      added the new unique enum value to the ////// response property for the response status

  • 68d43091b84dRevision changes
    • warning

      added the new 400.00 enum value to the response property for the response status

    • warning

      added the new 403.00 enum value to the response property for the response status

    • warning

      added the new 404.00 enum value to the response property for the response status

    • warning

      added the new 409.00 enum value to the response property for the response status