Catalog Resources

Get a Resource

Changed on

Fetches a resource by ID.

get/v1/resources/{id}

Request

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

Response

A response containing a single resource object.

idstring base64url required

The resource ID.

namestring nullable required

The name of the resource. Will be null when the resource has not yet been hydrated by the integration.

typestring required

The resource type. Available resource types are compiled from the integrations installed within the catalog.

configCatalogResourceConfig required

JSON object representing the properties used to identify the resource in the third-party system. The schema depends on the resource type and is dynamically registered at runtime.

integration_dataobject nullable required

JSON object containing schemaless integration data of the resource. This field is always populated by the system backing the integration. When null, the resource has been manually initialized via API but has yet to be hydrated by the integration.

archivedboolean required

Whether or not the resource has been archived.

service_associationsnumber required

The number of catalog services this resource is mapped to.

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": "4UdXnoaDYYJsH_Ir",
  "integration": {
    "name": "gateway-manager",
    "display_name": "gateway-manager",
    "instance": {
      "id": "772b9caf-ddbc-4f4f-8aa4-8dfbbe420351",
      "name": "aws-lambda-prod",
      "display_name": "AWS (prod)"
    }
  },
  "type": "gateway_svc",
  "config": {
    "control_plane_id": "ccadfb0a-56cd-4f74-955d-aec1d87157c8",
    "gateway_service_id": "94896d05-0c4d-45eb-aae3-de754885dd58"
  },
  "service_associations": 2,
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}

Changes

  • 68d43091b84dRevision changes
    • 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

  • f324fb7610e4Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status