---
title: "Create Snippet"
url: "https://nov18-dev.movespot.fyi/apis/portal-management-v3-3/versions/209d0e93-97b5-4dd3-a5a4-172ba6d8a51e/operations/create-portal-snippet"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/portal-management-v3-3/versions/209d0e93-97b5-4dd3-a5a4-172ba6d8a51e.md

# Create Snippet

`POST` `/portals/{portalId}/snippets`

Operation ID: `create-portal-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.

## Path parameters

- `portalId` (string, uuid, required) - ID of the portal.

## Request body (required)

Content types: `application/json`

## Responses

- `201` - Details about a snippet in a portal.
- `400` - Bad Request
- `401` - Unauthorized
- `403` - Forbidden
- `404` - Not Found

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Portal Management V3
  version: 3.4.1
servers:
  - url: https://us.api.konghq.com/v3
    description: United-States Production region
  - url: https://eu.api.konghq.com/v3
    description: Europe Production region
  - url: https://au.api.konghq.com/v3
    description: Australia Production region
  - url: https://me.api.konghq.com/v3
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v3
    description: India Production region
  - url: https://sg.api.konghq.com/v3
    description: Singapore Production region
paths:
  /portals/{portalId}/snippets:
    post:
      operationId: create-portal-snippet
      summary: Create Snippet
      description: 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.
      parameters:
        - $ref: "#/components/parameters/PortalId"
      requestBody:
        $ref: "#/components/requestBodies/CreatePortalSnippet"
      responses:
        "201":
          $ref: "#/components/responses/PortalSnippet"
        "400":
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: "#/components/schemas/BadRequestError"
              examples:
                UpdatePortalPageBadRequestExample1:
                  $ref: "#/components/examples/UpdatePortalSnippetBadRequestExample1"
                UpdatePortalSnippetBadRequestExample2:
                  $ref: "#/components/examples/UpdatePortalSnippetBadRequestExample2"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
      tags:
        - Snippets
security:
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  parameters:
    PortalId:
      schema:
        type: string
        format: uuid
      name: portalId
      in: path
      required: true
      description: ID of the portal.
  requestBodies:
    CreatePortalSnippet:
      description: Create a snippet in a portal.
      required: true
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/CreatePortalSnippetRequest"
          examples:
            Example 1:
              $ref: "#/components/examples/CreatePortalSnippetExample1"
  responses:
    PortalSnippet:
      description: Details about a snippet in a portal.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/PortalSnippetResponse"
          examples:
            Example 1:
              $ref: "#/components/examples/PortalSnippetExample1"
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/UnauthorizedExample"
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/ForbiddenExample"
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
  schemas:
    BadRequestError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          required:
            - invalid_parameters
          properties:
            invalid_parameters:
              $ref: "#/components/schemas/InvalidParameters"
    CreatePortalSnippetRequest:
      description: Create a snippet in a portal.
      type: object
      properties:
        name:
          $ref: "#/components/schemas/SnippetName"
        title:
          $ref: "#/components/schemas/SnippetTitle"
        content:
          $ref: "#/components/schemas/SnippetContent"
        visibility:
          $ref: "#/components/schemas/SnippetVisibilityStatus"
        status:
          $ref: "#/components/schemas/PublishedStatus"
        description:
          $ref: "#/components/schemas/Description"
      additionalProperties: false
      required:
        - name
        - content
      title: CreatePortalSnippetRequest
    PortalSnippetResponse:
      description: Details about a snippet in a portal.
      type: object
      properties:
        id:
          $ref: "#/components/schemas/UUID"
        name:
          $ref: "#/components/schemas/SnippetName"
        title:
          $ref: "#/components/schemas/SnippetTitle"
        content:
          $ref: "#/components/schemas/SnippetContent"
        visibility:
          $ref: "#/components/schemas/VisibilityStatus"
        status:
          $ref: "#/components/schemas/PublishedStatus"
        description:
          $ref: "#/components/schemas/Description"
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
      additionalProperties: false
      required:
        - id
        - name
        - content
        - visibility
        - status
        - created_at
        - updated_at
      title: PortalSnippetResponse
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          type: integer
          readOnly: true
        title:
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
        type:
          description: The error type.
          type: string
          readOnly: true
        instance:
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
    InvalidParameters:
      description: invalid parameters
      type: array
      items:
        oneOf:
          - $ref: "#/components/schemas/InvalidParameterStandard"
          - $ref: "#/components/schemas/InvalidParameterMinimumLength"
          - $ref: "#/components/schemas/InvalidParameterMaximumLength"
          - $ref: "#/components/schemas/InvalidParameterChoiceItem"
          - $ref: "#/components/schemas/InvalidParameterDependentItem"
      minItems: 1
      nullable: false
      uniqueItems: true
    UnauthorizedError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 401
            title:
              example: Unauthorized
            type:
              example: https://httpstatuses.com/401
            instance:
              example: kong:trace:1234567890
            detail:
              example: Invalid credentials
    ForbiddenError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 403
            title:
              example: Forbidden
            type:
              example: https://httpstatuses.com/403
            instance:
              example: kong:trace:1234567890
            detail:
              example: Forbidden
    NotFoundError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 404
            title:
              example: Not Found
            type:
              example: https://httpstatuses.com/404
            instance:
              example: kong:trace:1234567890
            detail:
              example: Not found
    SnippetName:
      description: The unique name of a snippet in a portal.
      type: string
      example: my-snippet
      maxLength: 512
      title: SnippetName
    SnippetTitle:
      description: The display title of a snippet in a portal.
      type: string
      example: My Snippet
      maxLength: 512
      title: SnippetTitle
    SnippetContent:
      description: The renderable markdown content of a page in a portal.
      type: string
      example: "# Welcome to My Snippet"
      maxLength: 1000000
      title: SnippetContent
    SnippetVisibilityStatus:
      description: >
        Whether a snippet is publicly accessible to non-authenticated users.

        If not provided, the default_page_visibility value of the portal will be
        used.
      type: string
      example: public
      enum:
        - public
        - private
      title: PageVisibilityStatus
    PublishedStatus:
      description: Whether the resource is visible on a given portal. Defaults to
        unpublished.
      type: string
      example: published
      enum:
        - published
        - unpublished
      title: PublishedStatus
    Description:
      type: string
      example: A custom page about developer portals
      maxLength: 160
      title: ResourceDescription
    UUID:
      description: Contains a unique identifier used for this resource.
      type: string
      format: uuid
      example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
      readOnly: true
    VisibilityStatus:
      description: Whether the resource is publicly accessible to non-authenticated users.
      type: string
      example: public
      enum:
        - public
        - private
      title: VisibilityStatus
    CreatedAt:
      description: An ISO-8601 timestamp representation of entity creation date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    UpdatedAt:
      description: An ISO-8601 timestamp representation of entity update date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    InvalidParameterStandard:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          $ref: "#/components/schemas/InvalidRules"
        source:
          type: string
          example: body
        reason:
          type: string
          example: is a required field
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
    InvalidParameterMinimumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - min_length
            - min_digits
            - min_lowercase
            - min_uppercase
            - min_symbols
            - min_items
            - min
          nullable: false
          readOnly: true
        minimum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must have at least 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - minimum
    InvalidParameterMaximumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - max_length
            - max_items
            - max
          nullable: false
          readOnly: true
        maximum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must not have more than 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - maximum
    InvalidParameterChoiceItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - enum
          nullable: false
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        choices:
          type: array
          items: {}
          minItems: 1
          nullable: false
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - choices
    InvalidParameterDependentItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - dependent_fields
          nullable: true
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        dependents:
          type: array
          items: {}
          nullable: true
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - rule
        - reason
        - dependents
    InvalidRules:
      description: invalid parameters rules
      type: string
      enum:
        - required
        - is_array
        - is_base64
        - is_boolean
        - is_date_time
        - is_integer
        - is_null
        - is_number
        - is_object
        - is_string
        - is_uuid
        - is_fqdn
        - is_arn
        - unknown_property
        - missing_reference
        - is_label
        - matches_regex
        - invalid
        - is_supported_network_availability_zone_list
        - is_supported_network_cidr_block
        - is_supported_provider_region
        - type
      nullable: true
      readOnly: true
  examples:
    UpdatePortalSnippetBadRequestExample1:
      value:
        status: 400
        title: Invalid Request
        instance: kong:trace:1433447772874964729
        detail: Invalid Parameters
        invalid_parameters:
          - field: my_property
            rule: unknown_property
            reason: '"my_property" is not allowed'
            source: body
    UpdatePortalSnippetBadRequestExample2:
      value:
        status: 400
        title: Invalid Request
        instance: kong:trace:1433447772874964729
        detail: Invalid Parameters
        invalid_parameters:
          - field: title
            rule: max_length
            reason: value of "title" must not exceed 512 characters
            source: body
            maximum: 512
    CreatePortalSnippetExample1:
      value:
        title: Getting Started
        name: getting-started
        content: Welcome to the Getting Started page. This is where you can learn how to
          use our APIs.
        visibility: public
        status: published
    PortalSnippetExample1:
      value:
        id: 8f9fd312-a987-4628-b4c5-bb4f4fddd5f7
        name: snip1
        title: Home
        content: Welcome to the first snippet of the portal.
        visibility: public
        status: published
        created_at: 2022-02-07T17:46:57.52Z
        updated_at: 2022-10-08T17:00:00.52Z
    UnauthorizedExample:
      value:
        status: 401
        title: Unauthorized
        instance: kong:trace:8347343766220159418
        detail: Unauthorized
    ForbiddenExample:
      value:
        status: 403
        title: Forbidden
        instance: kong:trace:2723154947768991354
        detail: You do not have permission to perform this action
    NotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
  securitySchemes:
    personalAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The personal access token is meant to be used as an alternative to
        basic-auth when accessing Konnect via APIs.

        You can generate a Personal Access Token (PAT) from the [personal access
        token page](https://cloud.konghq.com/global/account/tokens/) in the
        Konnect dashboard.

        The PAT token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer kpat_xgfT...'`
    systemAccountAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The system account access token is meant for automations and
        integrations that are not directly associated with a human identity.

        You can generate a system account Access Token by creating a system
        account and then obtaining a system account access token for that
        account.

        The access token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer spat_i2Ej...'`
```
