---
schema_version: "1"
id: dbeb1931fe3ebe22c435c8f1976c515d4703c664af89d34d36e3961e133b2e70
title: AuraDefinitionBundle
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_tooling/tooling_api_objects_auradefinitionbundle.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_auradefinitionbundle.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 97ce955f86ca23c21aba567709c2cf503dd6c17b43fc271c1a993c77cd7c3b75
description: Represents a Lightning Aura component definition bundle, such as a component or application bundle. A bundle contains a Lightning Aura component definition and all its related resources. Available in API version 32.0 and later.
---
# AuraDefinitionBundle

Represents a Lightning Aura component definition bundle, such as a component or application bundle. A bundle contains a Lightning Aura component definition and all its related resources. Available in API version 32.0 and later.

## Supported SOAP API Calls

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

## Supported REST API HTTP Methods

Query, GET, POST, PATCH, DELETE

## Fields

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


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

              <th class="featureTableHeader  " id="d42527e105">Details</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d42527e102" data-title="Field Name"><span class="keyword parmname">ApiVersion</span></td>

              <td class="entry" headers="d42527e105" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">double</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Filter, Sort</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">The API version for this bundle. Every bundle has an API version specified
                    at creation.</dd>


                </dl>

              </td>

            </tr>

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

              <td class="entry" headers="d42527e105" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">textarea</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Filter, Group, Sort</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">The text description of the bundle. Maximum size of 255 characters.</dd>


                </dl>

              </td>

            </tr>

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

              <td class="entry" headers="d42527e105" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Filter, Group, Sort</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">The unique name of the record in the API. This name can contain only
                    underscores and alphanumeric characters, and must be unique in your org. It
                    must begin with a letter, not include spaces, not end with an underscore, and
                    not contain two consecutive underscores. This field is automatically generated
                    but you can supply your own value if you create the record using the
                    API.<div class="box message info">
                      <div class="inner">
                        <div class="bd">
                          <div class="media">
                            <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/images/icon_note.png" alt="Note">
                            <div class="mediaBd">
                              <h4 class="mbs">Note</h4>
                              <p>When creating large sets of data, always specify a unique
                                <span class="keyword parmname">DeveloperName</span> for each record. If no
                                <span class="keyword parmname">DeveloperName</span> is specified, performance slows down
                                while Salesforce generates one for each record.
                              </p>
                            </div>
                          </div>
                        </div>
                      </div>
                    </div>
                    <div class="box message info">
                      <div class="inner">
                        <div class="bd">
                          <div class="media">
                            <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/images/icon_note.png" alt="Note">
                            <div class="mediaBd">
                              <h4 class="mbs">Note</h4>
                              <p>Only users with View DeveloperName OR View Setup
                                and Configuration permission can view, group, sort,
                                and filter this field.</p>
                            </div>
                          </div>
                        </div>
                      </div>
                    </div>
                  </dd>


                </dl>

              </td>

            </tr>

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

              <td class="entry" headers="d42527e105" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Create, Group, Nillable</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">The unique name used as the AuraDefinitionBundle 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.</dd>

                  <dd class="dd">Query this field only if the query result contains no more than one record.
                    Otherwise, an error is returned. If more than one record exists, use multiple
                    queries to retrieve the records. This limit protects performance.</dd>


                </dl>

              </td>

            </tr>

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

              <td class="entry" headers="d42527e105" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">picklist</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">The language of the <span class="keyword parmname">MasterLabel</span>.</dd>


                </dl>

              </td>

            </tr>

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

              <td class="entry" headers="d42527e105" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">ManageableState enumerated list</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Filter, Group, Nillable, Restricted picklist, Sort</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Indicates the manageable state of the specified component that is contained
                    in a package: <ul class="ul bulletList">
                      <li class="li"><samp class="codeph nolang">beta</samp></li>

                      <li class="li"><samp class="codeph nolang">deleted</samp></li>

                      <li class="li"><samp class="codeph nolang" id="option_deprecated"><a name="option_deprecated"><!-- --></a>deprecated</samp></li>

                      <li class="li"><samp class="codeph nolang">deprecatedEditable</samp></li>

                      <li class="li"><samp class="codeph nolang">installed</samp></li>

                      <li class="li"><samp class="codeph nolang">installedEditable</samp></li>

                      <li class="li"><samp class="codeph nolang">released</samp></li>

                      <li class="li"><samp class="codeph nolang">unmanaged</samp></li>

                    </ul>
                  </dd>


                </dl>

                <p class="p">This field is available in API version 38.0 and later.</p>

              </td>

            </tr>

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

              <td class="entry" headers="d42527e105" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Create, Filter, Group, Sort, Update</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Master label for the Lightning bundle. This internal label doesn’t get
                    translated.</dd>


                </dl>

              </td>

            </tr>

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

              <td class="entry" headers="d42527e105" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd"><samp class="codeph nolang">mns:AuraDefinitionBundle</samp></dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Create, Nillable, Update</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">The AuraDefinitionBundle metadata.</dd>

                  <dd class="dd">Query this field only if the query result contains no more than one record.
                    Otherwise, an error is returned. If more than one record exists, use multiple
                    queries to retrieve the records. This limit protects performance.</dd>


                </dl>

              </td>

            </tr>

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

              <td class="entry" headers="d42527e105" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Filter, Group, Sort</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">The namespace prefix that is associated with this object. Each Developer
                    Edition org that creates a managed package has a unique namespace prefix.
                    Limit: 15 characters. You can refer to a component in a managed package by
                    using the <samp class="codeph nolang"><var class="keyword varname">namespacePrefix</var>__<var class="keyword varname">componentName</var></samp>
                    notation. <p class="p">The namespace prefix can have one of the following values.</p>
                    <a name="namespace_prefix_values"><!-- --></a>
                    <ul class="ul bulletList" id="namespace_prefix_values">
                      <li class="li">In Developer Edition orgs, <span class="keyword parmname">NamespacePrefix</span> is set
                        to the namespace prefix of the org for all objects that support it, unless
                        an object is in an installed managed package. In that case, the object has
                        the namespace prefix of the installed managed package. This field’s value
                        is the namespace prefix of the Developer Edition org of the package
                        developer.</li>

                      <li class="li">In orgs that are not Developer Edition orgs,
                        <span class="keyword parmname">NamespacePrefix</span> is set only for objects that are
                        part of an installed managed package. All other objects have no namespace
                        prefix.
                      </li>

                    </ul>
                  </dd>


                </dl>

              </td>

            </tr>

          </tbody>

        </table>

## Usage

For more information, see the [Lightning Aura Components Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.lightning.meta/lightning/ "HTML (New Window)").