Snippets

Update Snippet

Changed on

Updates the configuration of a single custom snippet for this portal.

patch/v3/portals/{portalId}/snippets/{snippetId}

Request

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

Path parameters

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

The Portal identifier

snippetIdstring uuid required
Example:ebbac5b0-ac89-45c3-9d2e-c4542c657e79

ID of the snippet.

Request body

namestring

The unique name of a snippet in a portal.

titlestring

The display title of a snippet in a portal.

contentstring

The renderable markdown content of a page in a portal.

visibility'public' | 'private'

Whether the resource is publicly accessible to non-authenticated users.

status'published' | 'unpublished'

Whether the resource is visible on a given portal. Defaults to unpublished.

descriptionstring

Example request

{
  "name": "my-snippet",
  "title": "My Snippet",
  "content": "# Welcome to My Snippet",
  "visibility": "public",
  "status": "published",
  "description": "A custom page about developer portals"
}

Response

Details about a snippet in a portal.

idstring uuid required

Contains a unique identifier used for this resource.

namestring required

The unique name of a snippet in a portal.

titlestring

The display title of a snippet in a portal.

contentstring required

The renderable markdown content of a page in a portal.

visibility'public' | 'private' required

Whether the resource is publicly accessible to non-authenticated users.

status'published' | 'unpublished' required

Whether the resource is visible on a given portal. Defaults to unpublished.

descriptionstring
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": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  "name": "my-snippet",
  "title": "My Snippet",
  "content": "# Welcome to My Snippet",
  "visibility": "public",
  "status": "published",
  "description": "A custom page about developer portals",
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}

Changes

  • 5d2b35832e3fRevision changes
    • warning

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

  • ecce2daf9de6Revision changes
    • breaking

      the response property /////// became nullable for the status

    • breaking

      the response property /////// became nullable for the status

    • breaking

      the response property /////// became nullable for the status

    • breaking

      the response property /////// became nullable for the status

    • breaking

      the response property /////// became nullable for the status