Get a Page

Returns a single page for the portal. Each page has a slug, title, and content. Public pages will be returned for non-authenticated users, while both private and public pages will be returned for authenticated users.

get
/api/v3/pages/{pagePath}

Path Parameters

pagePathstringrequired

Targeted page, url-encoded.

Example:%2Fmypage

Response

application/json

A single portal page

PortalPage

A single page for the portal

* Additional properties are NOT allowed.
idstring(uuid)required

The unique identifier of the page

Example:582b9327-3eba-4bfe-9438-6066840dbbca

titlestringrequired

The title of the page

Example:My Page

slugstringrequired

The slug of the page.

Example:/my-page

contentstringrequired

The renderable markdown content of the page

Example:# Welcome to the Developer Portal

visibilitystringrequired

Whether the page or snippet is public or private. Private pages and snippets are only accessible to authenticated users.

Allowed values:publicprivate

Example:public

descriptionstring

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

parent_page_idstring | null(uuid)required

Pages may be rendered as a tree of files.

application/json

List Snippets

Returns a paginated list of snippets for the portal. Each snippet has a name, title, and content. Public snippets will be returned for non-authenticated users, while both private and public snippets will be returned for authenticated users.

get
/api/v3/snippets

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

filter[title][eq]string

Filter by direct equality comparison of the title property with a supplied value.

Example:Good Page

filter[title]string

Filter by direct equality comparison (short-hand) of the title property with a supplied value.

Example:Good Page

filter[title][contains]string

Filter by contains comparison of the title property with a supplied substring

Example:Good

filter[name][eq]string

Filter by direct equality comparison of the name property with a supplied value.

Example:good service

filter[name]string

Filter by direct equality comparison (short-hand) of the name property with a supplied value.

Example:good service

filter[visibility][eq]string

Filter by whether the pages returned are public or private. Private pages are only accessible to authenticated users. For authenticated users, results will include both public and private pages if not specified.

Allowed values:publicprivate

Example:public

filter[visibility]string

Filter (short-hand) by whether the pages returned are public or private. Private pages are only accessible to authenticated users. For authenticated users, results will include both public and private pages if not specified.

Allowed values:publicprivate

Example:private

Response

200 application/json

Paginated list of portal snippets

ListPortalSnippets

A paginated list of snippets for the portal

* Additional properties are NOT allowed.
dataarray[object]

A single snippet for the portal

* Additional properties are NOT allowed.
Show Child Parameters
metaobject

returns the pagination information

Show Child Parameters
200 application/json

Get a Snippet

Returns a single snippet for the portal. Each snippet has a name, title, and content. Public snippets will be returned for non-authenticated users, while both private and public snippets will be returned for authenticated users.

get
/api/v3/snippets/{snippetName}

Path Parameters

snippetNamestringrequired

Targeted snippet, url-encoded. Must not start with /.

Example:mysnippet

Response

application/json

A single portal snippet

PortalSnippet

A single snippet for the portal

* Additional properties are NOT allowed.
idstring(uuid)required

The unique identifier of the page

Example:582b9327-3eba-4bfe-9438-6066840dbbca

titlestringrequired

The title of the snippet

Example:My Snippet

namestringrequired

The name of the snippet (no leading slash)

Example:my-snippet

contentstringrequired

The renderable markdown content of the snippet

Example:# Welcome to the Developer Portal

visibilitystringrequired

Whether the page or snippet is public or private. Private pages and snippets are only accessible to authenticated users.

Allowed values:publicprivate

Example:public

descriptionstring

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

application/json

Get Portal Logo

Gets logo of the developer portal.

get
/api/v3/assets/logo

Response

200

An image asset

string
200

Get Portal Favicon

Gets favicon of the developer portal.

get
/api/v3/assets/favicon

Response

200

An image asset

string
200