---
schema_version: "1"
id: a6dd7e3765d517734da3f61f705a023d2afd626c44e6ae02eab850f0dc407224
title: CatalogedApi
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_catalogedapi.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_catalogedapi.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: bb75e3eabe84528129c6aad9d7d1f187987d50b0ac90fa8e322de141d7945e75
description: Represents an API brought into API Catalog for Salesforce from an external source.
---
# CatalogedApi

Represents an API brought into API Catalog for Salesforce from an external source.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

CatalogedApi components have the suffix .catalogedApi and are stored in the catalogedApis folder.

## Version

CatalogedApi components are available in API version 65.0 and later.

## Fields

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



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

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

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

            </tr>

          </thead>

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

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

              <td class="entry" headers="d232674e104" data-title="Description">The description defined when the API is cataloged.</td>

            </tr>

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

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

              <td class="entry" headers="d232674e104" data-title="Description">The content of the API schema in JSON format.</td>

            </tr>

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

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

              <td class="entry" headers="d232674e104" data-title="Description">The ID of the API in the external source that it's imported
                from.</td>

            </tr>

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

              <td class="entry" headers="d232674e101" data-title="Field Type">
                <a class="xref" href="#CatalogedApiInstance">CatalogedApiInstance</a>[]
              </td>

              <td class="entry" headers="d232674e104" data-title="Description">Reference to the cataloged API that this instance is specific to.</td>

            </tr>

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

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

              <td class="entry" headers="d232674e104" data-title="Description">
                <p class="p">Required. The API name as it appears in API Catalog.</p>

              </td>

            </tr>

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

              <td class="entry" headers="d232674e101" data-title="Field Type">ExternalServiceRegistrationProviderType (enumeration of type
                string)</td>

              <td class="entry" headers="d232674e104" data-title="Description">Required. Indicates the source of the API specification registered with API
                Catalog.<p class="p">API Catalog supports the value <samp class="codeph nolang">Anypoint</samp> for deployment and
                  supports other values for enumeration. See information about the
                  values in <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_externalserviceregistration.htm" target="_blank">the registrationProviderType
                    field</a>. </p>

              </td>

            </tr>

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

              <td class="entry" headers="d232674e101" data-title="Field Type">APIType (enumeration of type string)</td>

              <td class="entry" headers="d232674e104" data-title="Description">
                <p class="p">Required. Specifies the API type. If not specified, the API type
                  is derived based on the descriptor content. Nillable.</p>

                <p class="p">Values are:</p>

                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">GraphQL</samp></li>

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

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

                </ul>

              </td>

            </tr>

          </tbody>

        </table>

## CatalogedApiInstance

Represents a MuleSoft API instance brought into API Catalog for Salesforce from Anypoint Platform.

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



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

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

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

            </tr>

          </thead>

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

              <td class="entry" headers="d232674e269" data-title="Field Type">APIInstanceAccessStatus (enumeration of type string)</td>

              <td class="entry" headers="d232674e272" data-title="Description">
                <p class="p">Required. The access status for the API instance.</p>

                <p class="p">Values are:</p>

                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Approved</samp></li>

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

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

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

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

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

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

                </ul>

              </td>

            </tr>

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

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

              <td class="entry" headers="d232674e272" data-title="Description">The content of the API schema in JSON format.</td>

            </tr>

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

              <td class="entry" headers="d232674e269" data-title="Field Type">APIInstanceApprovalType (enumeration of type string)</td>

              <td class="entry" headers="d232674e272" data-title="Description">
                <p class="p">Required. The approval type for access in Anypoint Platform. </p>

                <p class="p">Values are:</p>

                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">AutoApproval</samp></li>

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

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

                </ul>

              </td>

            </tr>

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

              <td class="entry" headers="d232674e269" data-title="Field Type">APIInstanceEndpointType (enumeration of type string)</td>

              <td class="entry" headers="d232674e272" data-title="Description">
                <p class="p">The endpoint type to invoke the instance. Available in API version 66.0 and later. </p>

                <p class="p">Values are:</p>

                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Callout</samp></li>

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

                </ul>

              </td>

            </tr>

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

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

              <td class="entry" headers="d232674e272" data-title="Description">
                <p class="p">Required. The instance name as it appears in API Catalog. </p>

              </td>

            </tr>

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

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

              <td class="entry" headers="d232674e272" data-title="Description">
                <p class="p">Required. The service registration in external services related
                  to this API instance.</p>

              </td>

            </tr>

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

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

              <td class="entry" headers="d232674e272" data-title="Description">
                <p class="p">Required. The uniform resource identifier (URI) for the
                  instance.</p>

              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

This XML is an example of a CatalogedApi component.

<?xml version="1.0" encoding="UTF-8"?>
<CatalogedApi xmlns="http://soap.sforce.com/2006/04/metadata">
    <externalSourceIdentifier\>urn:ms:03ff2c74-d0ea-4eba-a536-36dfd2d0fdbb:api-project::petstore-engineering</externalSourceIdentifier\>
    <instances\>
        <accessStatus\>NoStatus</accessStatus\>
        <apiInstanceDescriptor\>{&quot;@type&quot;:&quot;anypointAPIInstanceDescriptor&quot;,&quot;environmentType&quot;:&quot;SANDBOX&quot;,&quot;environmentName&quot;:&quot;Sandbox&quot;,&quot;environmentId&quot;:&quot;79305d19-1d89-413f-88ec-d7a8dbd1e29d&quot;,&quot;instanceId&quot;:&quot;4051358&quot;,&quot;authenticationMethod&quot;:&quot;NO\_AUTH&quot;,&quot;componentType&quot;:&quot;apiInstance&quot;,&quot;instanceOrigin&quot;:&quot;MANUAL&quot;}</apiInstanceDescriptor\>
        <approvalType\>NoApproval</approvalType\>
        <label\>petstore-engineering</label\>
        <serviceRegistration\>PetstoreEngineeringv109C60C7C</serviceRegistration\>
        <uri\>https://google.com</uri\>
    </instances\>
    <label\>petstore-engineering</label\>
    <providerType\>Anypoint</providerType\>
    <type\>REST</type\>
</CatalogedApi\>