> ## Documentation Index
> Fetch the complete documentation index at: https://developers.aptranet.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Preview a custom page

> Project-scoped operation. Successful JSON and status-only responses vary by operation. The service does not declare a stable response schema for this operation; do not assume a collection envelope or undocumented fields.



## OpenAPI

````yaml /openapi-shield.json post /shield/preview-custom-page
openapi: 3.1.0
info:
  title: Aptranet Cloud Shield API
  version: 1.0.0
  description: >-
    Public project-scoped API. Use the access key and secret together.
    Browser-only organization administration is documented separately. Request
    schemas and query parameters follow the service operation allowlist. Plan
    entitlements apply in addition to API permissions. Some analytics and action
    responses have operation-specific JSON shapes; where the implementation
    provides no stable response contract, the reference deliberately does not
    invent one.
servers:
  - url: https://api.aptranet.com
security:
  - bearerAuth: []
    apiSecret: []
paths:
  /shield/preview-custom-page:
    post:
      tags:
        - Cloud Shield Custom Page Sets
      summary: Preview a custom page
      description: >-
        Project-scoped operation. Successful JSON and status-only responses vary
        by operation. The service does not declare a stable response schema for
        this operation; do not assume a collection envelope or undocumented
        fields.
      operationId: POST_shield_preview_custom_page
      parameters:
        - name: page_type
          in: query
          required: true
          schema:
            type: string
            enum:
              - block.html
              - block_csrf.html
              - captcha.html
              - cookieDisabled.html
              - handshake.html
              - javascriptDisabled.html
            title: PageType
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              title: PreviewCustomPage
              properties:
                logo:
                  title: Logo
                  anyOf:
                    - type: string
                      title: A base64 encoded image of the logo to present
                    - type: 'null'
                header:
                  title: Header
                  anyOf:
                    - type: string
                      minLength: 3
                      maxLength: 62
                    - type: 'null'
                title:
                  title: Title
                  anyOf:
                    - type: string
                      minLength: 3
                      maxLength: 50
                    - type: 'null'
                text:
                  title: Text
                  anyOf:
                    - type: string
                      minLength: 20
                      maxLength: 400
                    - type: 'null'
                error:
                  title: Error
                  anyOf:
                    - type: string
                      minLength: 10
                      maxLength: 400
                    - type: 'null'
      responses:
        2XX:
          description: Successful response.
        default:
          description: >-
            Request rejected or service unavailable. See the error code and
            description; refresh before retrying a mutation whose result is
            uncertain.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
        error_description:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Project API access key.
    apiSecret:
      type: apiKey
      in: header
      name: Aptranet-Secret
      description: Current secret for the access key.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.