Snippets

List Snippets

Changed on

Returns the paginated list of custom snippets that have been created for this portal.

get/v3/portals/{portalId}/snippets

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v3/portals/{portalId}/snippets
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Path parameters

portalIdstring uuid required
Example:f32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the portal.

Query parameters

sortstring

Sorts a collection of portal snippets. Supported sort attributes are:

  • created_at
  • updated_at
  • name
  • title
  • visibility
page[size]integer
Example:10

The maximum number of items to include per page. The last page of a collection may include fewer items.

page[number]integer
Example:1

Determines which page of the entities to retrieve.

Filter snippets returned in the response.

{
  "created_at": {
    "eq": "2022-03-30T07:20:50Z"
  },
  "updated_at": {
    "eq": "2022-03-30T07:20:50Z"
  }
}

Response

A paginated list of custom snippets in a portal.

Example response

{
  "data": [
    {
      "id": "437c7192-fea0-4f35-8478-c8d57783f8c1",
      "name": "my-snippet",
      "title": "My Snippet",
      "visibility": "public",
      "status": "published",
      "description": "A custom snippet",
      "created_at": "2021-01-01T00:00:00Z",
      "updated_at": "2021-01-01T00:00:00Z"
    }
  ],
  "meta": {
    "page": {
      "number": 1,
      "size": 10,
      "total": 1
    }
  }
}

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