Sign in

v61

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-08-018131,3812.6 MB
Snippets

Create Snippet

Creates a new custom snippet for this portal. Custom snippets can be used to display static content, documentation, or other information to developers. Title and Description properties may be provided in the frontmatter section of content. If you set values in both the POST request and in the frontmatter, the values in the frontmatter will take precedence.

post/v3/portals/{portalId}/snippets

Path parameters

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

ID of the portal.

Request body

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'

Whether a snippet is publicly accessible to non-authenticated users. If not provided, the default_page_visibility value of the portal will be used.

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"
}