List Snippets

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

get

Query Parameters

sortstring

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

  • created_at
  • updated_at
  • name
  • title
  • visibility
page[size]integer

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

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

filterobject

Filter snippets returned in the response.

* Additional properties are NOT allowed.
Show Child Parameters

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

application/json

A paginated list of custom snippets in a portal.

ListPortalSnippetsResponse

A paginated list of custom snippets in a portal.

* Additional properties are NOT allowed.
dataarray[object]required

Information about a snippet in a portal.

* Additional properties are NOT allowed.
Show Child Parameters
metaobjectrequired

returns the pagination information

Show Child Parameters
get/portals/{portalId}/snippets
 
application/json

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

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Body

application/json

Create a snippet in a portal.

CreatePortalSnippetRequest

Create a snippet in a portal.

* Additional properties are NOT allowed.
namestringrequired

The unique name of a snippet in a portal.

<= 512 characters

Example:my-snippet

titlestring

The display title of a snippet in a portal.

<= 512 characters

Example:My Snippet

contentstringrequired

The renderable markdown content of a page in a portal.

<= 1000000 characters

Example:# Welcome to My Snippet

visibilitystring

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

Allowed values:publicprivate

Example:public

statusstring

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

Allowed values:publishedunpublished

Example:published

descriptionstring

<= 160 characters

Example:A custom page about developer portals

Response

application/json

Details about a snippet in a portal.

PortalSnippetResponse

Details about a snippet in a portal.

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

namestringrequired

The unique name of a snippet in a portal.

<= 512 characters

Example:my-snippet

titlestring

The display title of a snippet in a portal.

<= 512 characters

Example:My Snippet

contentstringrequired

The renderable markdown content of a page in a portal.

<= 1000000 characters

Example:# Welcome to My Snippet

visibilitystringrequired

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

Allowed values:publicprivate

Example:public

statusstringrequired

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

Allowed values:publishedunpublished

Example:published

descriptionstring

<= 160 characters

Example:A custom page about developer portals

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

post/portals/{portalId}/snippets

Body

{ "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" }
 
application/json

Get a Snippet

Returns the configuration of a single custom snippet for this portal. Custom snippets can be used to display static content, documentation, or other information to developers.

get

Path Parameters

portalIdstring(uuid)required

ID of the portal.

snippetIdstring(uuid)required

ID of the snippet.

Example:ebbac5b0-ac89-45c3-9d2e-c4542c657e79

Response

application/json

Details about a snippet in a portal.

PortalSnippetResponse

Details about a snippet in a portal.

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

namestringrequired

The unique name of a snippet in a portal.

<= 512 characters

Example:my-snippet

titlestring

The display title of a snippet in a portal.

<= 512 characters

Example:My Snippet

contentstringrequired

The renderable markdown content of a page in a portal.

<= 1000000 characters

Example:# Welcome to My Snippet

visibilitystringrequired

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

Allowed values:publicprivate

Example:public

statusstringrequired

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

Allowed values:publishedunpublished

Example:published

descriptionstring

<= 160 characters

Example:A custom page about developer portals

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

get/portals/{portalId}/snippets/{snippetId}
 
application/json

Update Snippet

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

patch

Path Parameters

portalIdstring(uuid)required

ID of the portal.

snippetIdstring(uuid)required

ID of the snippet.

Example:ebbac5b0-ac89-45c3-9d2e-c4542c657e79

Body

application/json

Update a snippet in a portal.

UpdatePortalSnippetRequest

Update a snippet in a portal.

* Additional properties are NOT allowed.
namestring

The unique name of a snippet in a portal.

<= 512 characters

Example:my-snippet

titlestring

The display title of a snippet in a portal.

<= 512 characters

Example:My Snippet

contentstring

The renderable markdown content of a page in a portal.

<= 1000000 characters

Example:# Welcome to My Snippet

visibilitystring

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

Allowed values:publicprivate

Example:public

statusstring

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

Allowed values:publishedunpublished

Example:published

descriptionstring

<= 160 characters

Example:A custom page about developer portals

Response

application/json

Details about a snippet in a portal.

PortalSnippetResponse

Details about a snippet in a portal.

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

namestringrequired

The unique name of a snippet in a portal.

<= 512 characters

Example:my-snippet

titlestring

The display title of a snippet in a portal.

<= 512 characters

Example:My Snippet

contentstringrequired

The renderable markdown content of a page in a portal.

<= 1000000 characters

Example:# Welcome to My Snippet

visibilitystringrequired

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

Allowed values:publicprivate

Example:public

statusstringrequired

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

Allowed values:publishedunpublished

Example:published

descriptionstring

<= 160 characters

Example:A custom page about developer portals

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

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

Body

{ "title": "About Us", "name": "about-us", "content": "Welcome to the About Us page. This is where you can learn about our company." }
 
application/json

Delete Snippet

Deletes a single custom snippet for this portal.

delete

Path Parameters

portalIdstring(uuid)required

ID of the portal.

snippetIdstring(uuid)required

ID of the snippet.

Example:ebbac5b0-ac89-45c3-9d2e-c4542c657e79

Response

No Content

delete/portals/{portalId}/snippets/{snippetId}