GRgravitee-io
Themes

Create or update a Theme

Changed on

Create or update a next-gen portal Theme from PortalThemeSpec

put/organizations/{orgId}/environments/{envId}/portal-themes

Request

  • Base URL
    https://eu.cloudgate.gravitee.io/apim/automation
  • URL
    https://eu.cloudgate.gravitee.io/apim/automation/organizations/{orgId}/environments/{envId}/portal-themes
  • Auth
    • HTTP bearer
    • or HTTP basic
    • or HTTP bearer

Path parameters

orgIdstring required
Example:dedd0e0f-b3e9-4d2f-89cd-b2a9de7cb145

organization ID

envIdstring required
Example:a44e0d1b-9fa9-4d64-8b76-3634623a2e27

environment ID

Query parameters

dryRunboolean
Example:true

For modifying requests, this parameter allow you to test the result of an endpoint without actually persisting the state of the underlying spec.

Request body

hridstring required

A unique human readable id identifying this resource

namestring required

Display name of the theme

logostring

Primary logo. Inline data URI (for example data:image/png;base64,...), the same shape the console produces on upload.

optionalLogostring

Alternate logo for contexts where the primary one does not render well (dark background, small badge, etc.).

faviconstring

Browser tab icon. Same inline data URI convention as logo.

backgroundImagestring

Hero / landing page background image. Same inline data URI convention as logo.

Example request

{
  "hrid": "demo_api",
  "name": "Default Theme"
}

Response

State of the successfully created/updated Theme

hridstring required

A unique human readable id identifying this resource

namestring required

Display name of the theme

logostring

Primary logo. Inline data URI (for example data:image/png;base64,...), the same shape the console produces on upload.

optionalLogostring

Alternate logo for contexts where the primary one does not render well (dark background, small badge, etc.).

faviconstring

Browser tab icon. Same inline data URI convention as logo.

backgroundImagestring

Hero / landing page background image. Same inline data URI convention as logo.

idstring

Resource UUID.

environmentIdstring

The environment ID.

organizationIdstring

The organization ID.

Example response

{
  "hrid": "demo_api",
  "name": "Default Theme"
}

Changes