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

PortalContext

object

Describes the portal execution context

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

ID of the portal

org_idstring(uuid)required

ID of the organization

basic_auth_enabledbooleanrequired

Whether the portal can be accessed via email and password

oidc_auth_enabledbooleanrequired

Whether the portal can be accessed via authentication with Single Sign On (SSO) through OpenID Connect (OIDC) from a third-party Identity Provider

saml_auth_enabledbooleanrequired

Whether the portal can be accessed via SAML authentication

authentication_enabledbooleanrequired

Whether authentication is enabled for the portal

rbac_enabledbooleanrequired

Whether Role-Based Access Control is enabled for the portal

namestringrequired

Name of the developer portal

canonical_domainstringrequired

The canonical domain of the developer portal

Example

PortalCustomization

object

The custom settings of this portal

* Additional properties are NOT allowed.
themeobject
* Additional properties are NOT allowed.
Show Child Parameters
layoutstring
cssstring
menuobject
* Additional properties are NOT allowed.
Show Child Parameters
spec_rendererobject
* Additional properties are NOT allowed.
Show Child Parameters
robotsstring
Example