---
schema_version: "1"
id: a94f448ffe25f18f71871f8d51aad89ce1684f6fac533061333a2ccd3e2fa45c
title: ApexPage
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_pages.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_pages.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 8d74f6cc5c5c6e8e6203771bfde330bdc62f841963e7815c68a53aadaaa2f95f
description: Represents a Visualforce page.
---
# ApexPage

Represents a Visualforce page.

For more information, see Visualforce in Salesforce Help. This type extends the [MetadataWithContent](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_metadatawithcontent.htm "MetadataWithContent is the base type for all metadata types that contain content, such as documents or email templates. It extends Metadata. You can’t edit this object.") metadata type and inherits its content and fullName fields.

## Declarative Metadata File Suffix and Directory Location

The file suffix is .page for the page file. The accompanying metadata file is named PageName\-meta.xml.

Visualforce pages are stored in the pages folder in the corresponding package directory.

## Version

Visualforce pages are available in API version 11.0 and later.

## Fields

This metadata type contains the following fields:

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d732627e116">Field Name</th>

              <th class="featureTableHeader  " id="d732627e119">Field Type</th>

              <th class="featureTableHeader  " id="d732627e122">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d732627e116" data-title="Field Name"><span class="keyword parmname" id="api_version"><a name="api_version"><!-- --></a>apiVersion</span></td>

              <td class="entry" headers="d732627e119" data-title="Field Type">double</td>

              <td class="entry" headers="d732627e122" data-title="Description">Required. The API version for this page. Every page has an API
                version specified at creation. This field is available in API
                version 15.0 and later. If you set this field to a number lower than
                15.0, it’s changed to 15.0.</td>

            </tr>

            <tr>
              <td class="entry" headers="d732627e116" data-title="Field Name"><span class="keyword parmname">content</span></td>

              <td class="entry" headers="d732627e119" data-title="Field Type">base64Binary</td>

              <td class="entry" headers="d732627e122" data-title="Description">The page content. Base 64-encoded binary data. Before making an
                API call, client applications must encode the binary attachment data
                as base64. Upon receiving a response, client applications must
                decode the base64 data to binary. This conversion is handled for you
                by a SOAP client. This field is inherited from the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_metadatawithcontent.htm" title="MetadataWithContent is the base type for all metadata types that contain content, such as documents or email templates. It extends Metadata. You can’t edit this object.">MetadataWithContent</a> component.</td>

            </tr>

            <tr>
              <td class="entry" headers="d732627e116" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d732627e119" data-title="Field Type">string</td>

              <td class="entry" headers="d732627e122" data-title="Description">A description of what the page does.</td>

            </tr>

            <tr>
              <td class="entry" headers="d732627e116" data-title="Field Name"><span class="keyword parmname">fullName</span></td>

              <td class="entry" headers="d732627e119" data-title="Field Type">string</td>

              <td class="entry" headers="d732627e122" data-title="Description">The page developer name used as a unique identifier for API
                access. The <span class="keyword parmname">fullName</span> can contain only
                underscores and alphanumeric characters. It must be unique, begin
                with a letter, not include spaces, not end with an underscore, and
                not contain two consecutive underscores. This field is inherited
                from the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm" title="The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.">Metadata</a> component.</td>

            </tr>

            <tr>
              <td class="entry" headers="d732627e116" data-title="Field Name"><span class="keyword parmname">availableInTouch</span></td>

              <td class="entry" headers="d732627e119" data-title="Field Type">boolean</td>

              <td class="entry" headers="d732627e122" data-title="Description">Indicates if Visualforce tabs associated with the Visualforce
                page can be used in the Salesforce mobile app. (Use of this field
                for Salesforce Touch is deprecated.). This field is available in API
                version 27.0 and later. <p class="p">Standard object tabs that are overridden
                  with a Visualforce page aren’t supported in the Salesforce
                  mobile app, even if you set this field for the page. The default
                  page for the object is displayed instead of the Visualforce
                  page.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d732627e116" data-title="Field Name"><span class="keyword parmname">confirmationTokenRequired</span></td>

              <td class="entry" headers="d732627e119" data-title="Field Type">boolean</td>

              <td class="entry" headers="d732627e122" data-title="Description">
                <span class="ph" id="visualforce_metadata_isconfirmationtokenrequired_def"><a name="visualforce_metadata_isconfirmationtokenrequired_def"><!-- --></a>Indicates whether <samp class="codeph nolang">GET</samp>
                  requests for the page require a CSRF confirmation token.</span>
                This field is available in API version 28.0 and later. <p class="p"><span class="ph" id="visualforce_metadata_isconformationtokenrequired_caveat"><a name="visualforce_metadata_isconformationtokenrequired_caveat"><!-- --></a>If you change this field’s value from <samp class="codeph nolang">false</samp> to <samp class="codeph nolang">true</samp>, links to the page
                    require a CSRF token to be added to them, or the page is
                    inaccessible.</span></p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d732627e116" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d732627e119" data-title="Field Type">string</td>

              <td class="entry" headers="d732627e122" data-title="Description">Required. The label for this page.</td>

            </tr>

            <tr>
              <td class="entry" headers="d732627e116" data-title="Field Name"><span class="keyword parmname" id="field_packageVersions"><a name="field_packageVersions"><!-- --></a>packageVersions</span></td>

              <td class="entry" headers="d732627e119" data-title="Field Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_classes.htm#PackageVersion">PackageVersion</a>[]
              </td>

              <td class="entry" headers="d732627e122" data-title="Description">
                <span class="ph" id="field_packageVersions_desc"><a name="field_packageVersions_desc"><!-- --></a>The list of installed managed
                  package versions that are referenced by this Visualforce
                  page.</span>
                <p class="p">For more information about
                  managed packages, see <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.sfdx_dev.meta/sfdx_dev/sfdx_dev_dev2gp.htm" target="_blank" title="HTML (New Window)">Second-Generation Managed
                    Packages</a> in the <cite class="cite">Salesforce DX Developer
                    Guide</cite>. This field is available in API version 16.0
                  and later.</p>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following sample creates the MyPage.page page, and the corresponding MyPage.page-meta.xml metadata file.

SampleApexPage.page file:

<apex:page\>
<h1\>Congratulations</h1\>
This is your new Page.
</apex:page\>

SampleApexPage.page-meta.xml:

<?xml version="1.0" encoding="UTF-8"?>
<ApexPage xmlns="http://soap.sforce.com/2006/04/metadata">
    <description\>This is a sample Visualforce page.</description\>
    <label\>SampleApexPage</label\>
</ApexPage\>

## Wildcard Support in the Manifest File

This metadata type supports the wildcard character \* (asterisk) in the package.xml manifest file. For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

#### See Also

- [ApexComponent](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_component.htm "Represents a Visualforce component.")