--- title: "Unpublish page" method: POST path: "/stakeholder-comms/cloudId/{cloudId}/api/pages/{pageId}/unpublish" tags: ["Status Page"] --- # Unpublish page `POST /stakeholder-comms/cloudId/{cloudId}/api/pages/{pageId}/unpublish` ## Request - Base URL: `https://api.atlassian.com/jsm/ops` - URL: `https://api.atlassian.com/jsm/ops/stakeholder-comms/cloudId/{cloudId}/api/pages/{pageId}/unpublish` - Auth: one of: - HTTP basic - OAuth 2 - Authorization code: `https://auth.stg.atlassian.com/authorize` - Token URL: `https://auth.stg.atlassian.com/oauth/token` scopes: `write:stakeholder-comms.page:jira-service-management` Unpublish a Status page. ## Path parameters - `pageId` string, required ## Response `200` Returned if the page is successfully unpublished. - StakeholderCommsPageResponse: Response containing a Status page (live or draft). - `page` StakeholderCommsPage: A stakeholder communications page (live or draft). - `id` string: Unique identifier of the page. - `name` string: Name of the page. - `subdomain` string: Subdomain used for the page, if configured. - `domain` string: Custom domain used for the page, if configured. - `version` integer: Version number of the page. - `url` string: Public URL of the page. - `description` string: Description of the page. - `timezone` string: Time zone used for displaying incident and communication times. - `privacyPolicyUrl` string: URL to the privacy policy. - `helpCenterUrl` string: URL to the help center. - `cloudId` string: Cloud ID the page belongs to. - `deletedAt` string, date-time: When the page was soft deleted. - `unpublishedAt` string, date-time: When the page was unpublished. - `components` string[]: Component IDs associated with the page. - `pageTheme` 'BLANK' | 'ALL_SYSTEMS_GLOW' | 'CLEAR_SKIES' | 'UP_AND_RUNNING': Visual theme of the page. - `pageThemeMode` 'LIGHT' | 'DARK': Light or dark mode for the page theme. - `seoConfig` StakeholderCommsSeoConfig: SEO configuration for a status page. - `enabled` boolean: Whether SEO is enabled. - `title` string: SEO title. - `description` string: SEO description. - `keywords` string: SEO keywords. - `googleAnalyticsEnabled` boolean: Whether Google Analytics is enabled. - `statusEmbedEnabled` boolean: Whether status embed is enabled. - `allowPageSubscribers` boolean: Whether page-level subscriptions are allowed. - `activityScore` integer: Activity score of the page. - `hiddenFromSearch` boolean: Whether the page is hidden from search engines. - `googleAnalyticsTrackingId` string: Google Analytics tracking ID. - `allowRssAtomFields` boolean: Whether RSS/Atom feeds are enabled. - `blackHole` boolean: Whether the page is in black-hole mode. - `createdBy` string: Identifier of the user who created the page. - `externalAccounts` string[]: External account identifiers linked to the page. - `bodyConfig` StakeholderCommsBodyConfig: Body layout configuration for a status page. - `uptimeStyle` 'DETAIL_CARD' | 'ONLY_STATUS': Uptime display style. - `overallUptimeDisplay` boolean: Whether to display overall uptime. - `overallUptimeRange` integer: Range in days for overall uptime display. - `enableSearchAndFilter` boolean: Whether search and filter are enabled. - `componentStyle` 'CARD' | 'TABLE': Component display style. - `numberOfCardsPerRow` integer: Number of component cards per row. - `componentUptimeDisplay` boolean: Whether to display per-component uptime. - `componentUptimeRange` integer: Range in days for per-component uptime display. - `footerData` StakeholderCommsFooterData: Footer configuration for a status page. - `footerLogoId` string: Identifier of the footer logo image. - `footerText` string: Footer text content. - `copyrightText` string: Copyright text. - `links` StakeholderCommsLink[]: Footer navigation links. - `label` string: Display label for the link. - `url` string: URL the link points to. - `position` integer: Display position of the link. - `headerData` StakeholderCommsHeaderData: Header configuration for a status page. - `coverImageId` string: Identifier of the cover image. - `headerLogoId` string: Identifier of the header logo image. - `faviconIconId` string: Identifier of the favicon icon. - `headerText` string: Header text content. - `coverImageImmersive` boolean: Whether the cover image is immersive. - `links` StakeholderCommsLink[]: Header navigation links. - `label` string: Display label for the link. - `url` string: URL the link points to. - `position` integer: Display position of the link. - `colours` StakeholderCommsColours: Colour configuration for a status page. - `cssBodyBackgroundColor` string - `cssFontColor` string - `cssLightFontColor` string - `cssGreenColor` string - `cssYellowColor` string - `cssOrangeColor` string - `cssRedColor` string - `cssBorderColor` string - `cssGraphColor` string - `cssLinkColor` string - `cssBlueColor` string - `cssNoDataColor` string - `customCss` string: Custom CSS for the page. - `customHeaderHtml` string: Custom HTML injected into the page header. - `customFooterHtml` string: Custom HTML injected into the page footer. - `pageType` 'PUBLIC' | 'PRIVATE': Type of the page. - `pageStatus` 'DRAFT' | 'PUBLISHED' | 'UNPUBLISHED' | 'PUBLISHED_WITH_CHANGES' | 'UNPUBLISHED_WITH_CHANGES' | 'SOFT_DELETED': Publication status of the page. - `customDomainConfig` StakeholderCommsCustomDomainConfig: Custom domain configuration for a status page. - `domain` string: The custom domain. - `sslStatus` 'NOT_CONFIGURED' | 'PENDING' | 'ISSUED' | 'FAILED' | 'EXPIRED' | 'DEPROVISIONING': SSL certificate status. - `recordTypes` StakeholderCommsCustomDomainRecordType[]: DNS record types required for this custom domain. - `name` string: Name of the record type. - `description` string: Description of the record type. - `records` StakeholderCommsCustomDomainRecord[]: DNS records of this type. - `id` string: Identifier of the record. - `purpose` string: Purpose of the DNS record. - `type` string: DNS record type (e.g. CNAME, TXT). - `name` string: DNS record name. - `value` string: Expected DNS record value. - `currentValue` string: Current value of the DNS record. - `status` 'VERIFIED' | 'PENDING' | 'FAILED' | 'SKIPPED': Verification status of the record. - `message` string: Optional message about the record status. - `certificateExpiresAt` string, date-time: When the SSL certificate expires. - `createdAt` string, date-time: When the page was created. - `updatedAt` string, date-time: When the page was last updated. - `error` string: Error message, if the operation was not successful. ## Other responses - `400`: Returned if the request is invalid. - `401`: Returned if the authentication credentials are incorrect. - `403`: Returned if the user does not have permission to unpublish the page. - `404`: Returned if the page is not found. - `500`: Returned if an internal server error occurs. --- [API](https://skmtc.dev/atlassian/apis/jsm-operations-api.md) - [All operations](https://skmtc.dev/atlassian/apis/jsm-operations-api/llms.txt) - [OpenAPI document](https://skmtc.dev/atlassian/apis/jsm-operations-api/revisions/804cddbe79aa?raw)