REST Resource: organizations.sites

Resource: SiteData

JSON representation
{
  "language": string,
  "logoUrl": string,
  "migrationDestSiteId": string,
  "orgName": string,
  "currentDomain": string,
  "description": string,
  "themeVersion": string,
  "timeZone": string,
  "customDomain": string,
  "name": string,
  "stylesheetDirty": boolean,
  "customerId": string,
  "https": boolean,
  "fileLimit": integer,
  "lastModified": string,
  "portalVersion": integer,
  "analyticsScript": string,
  "defaultURL": string,
  "lastLogin": string,
  "trashed": boolean,
  "trashedBy": string,
  "direction": string,
  "itSecretKey": string,
  "iconBg": string,
  "iconUrl": string,
  "id": string,
  "lastPublished": string,
  "migrationSrcSiteId": string,
  "status": string,
  "altLogoUrl": string,
  "customDomainEnabled": boolean,
  "trashedOn": string,
  "idpEnabled": boolean,
  "showSettings": boolean,
  "analyticsTrackingId": string,
  "created": string,
  "currentURL": string,
  "defaultDomain": string,
  "teams": [
    string
  ],
  "theme": string,
  "zoneId": string,
  "anonAllowedByDefault": boolean,
  "approvedEmails": string,
  "siteDomainSuffix": string
}
Fields
language

string

Language for the portal (such as "en").

logoUrl

string

Logo image used on desktop devices.

migrationDestSiteId

string

Not used by Apigee hybrid.

orgName

string

Name of the Apigee organization.

currentDomain

string

Domain name currently in use by the portal.

description

string

Description of the portal.

themeVersion

string

Version of the theme used by the portal. (Internal use only.)

timeZone

string

Time zone.

customDomain

string

Custom domain (if applicable).

name

string

Name of the portal.

stylesheetDirty

boolean

Boolean flag that specifies whether the custom CSS needs to be recalculated.

customerId

string

Not used by Apigee hybrid.

https

boolean

Boolean flag that specifies whether the URL will be HTTPS.

fileLimit

integer

Maximimum number of file assets that can be uploaded.

lastModified

string (int64 format)

Time the portal was last modified in milliseconds since epoch.

portalVersion

integer

Version of the portal.

analyticsScript

string

Custom HTML/JS analytics script added before the tag on all pages of the site.

defaultURL

string

Default URL to access the portal.

lastLogin

string (int64 format)

Time that a user last signed in to the portal in milliseconds since epoch.

trashed

boolean

Boolean flag that specifies whether the portal has been deleted.

trashedBy

string

Name of the user that deleted the portal.

direction

string

Type of writing system, such as left-to-right (ltr).

itSecretKey

string

Not used by Apigee hybrid.

iconBg

string

Not used by Apigee hybrid.

iconUrl

string

Not used by Apigee hybrid.

id

string

ID of the portal.

lastPublished

string (int64 format)

Time the portal was last published in milliseconds since epoch.

migrationSrcSiteId

string

Not used by Apigee hybrid.

status

string

Status of the portal indicating whether the portal is published (Active) or unpublished (Inactive).

altLogoUrl

string

Logo image used on mobile devices.

customDomainEnabled

boolean

Not used currently by Apigee hybrid.

trashedOn

string (int64 format)

Time the portal was deleted in milliseconds since epoch.

idpEnabled

boolean

Boolean flag that specifies whether an identity provider has been enabled.

showSettings

boolean

Not used by Apigee hybrid.

analyticsTrackingId

string

created

string (int64 format)

Time the portal was created in milliseconds since epoch.

currentURL

string

URL currently in use by the portal.

defaultDomain

string

Default domain for the portal.

teams[]

string

Not used by Apigee hybrid.

theme

string

Name of the theme used on the portal (apigee).

zoneId

string

ID of the identity zone.

anonAllowedByDefault

boolean

Boolean flag that sets the default visibility for pages and API products that are published on the portal. When set totrue, allows access by all users (public).

approvedEmails

string

List of emails that are allowed to sign up on the portal.

siteDomainSuffix

string

Suffix for the portal domain. By default, this is set to ".apigee.io".

Methods

create

Creates a new portal.

getConfig

Gets the portal configuration.

getCustomcss

Gets the custom CSS for a portal.

getDrafttoken

Gets the draft token for a portal.

getKeystores

Lists the keystores and certs that are available for TLS configuration.

getOrgtype

Gets the organization type for a portal.

getPortal

Gets the details for a portal.

getPublishedapis

Lists all published APIs.

getSmtp

Gets the SMTP configuration for a portal.

render

Gets the title and contents of the page on the portal.

send-test-email

Sends a test email using the email template.

trash

Deletes a portal.

updateCustomcss

Updates the custom CSS for a portal.

updatePortal

Updates a portal.

updateSmtp

Updates the SMTP configuration for a portal.