---
schema_version: "1"
id: 392e4833a4f43565719452a2a06325f1cf573d4ec280474d46292e2db1b7bac5
title: CatalogedApiVersion
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_catalogedapiversion.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_catalogedapiversion.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: e89a07db52b78175489a68c6ca278aeaf675ea02b3dd3876e50badfb55a1f7f2
description: Represents a version of an API that is consumable in Salesforce using API Catalog.
---
# CatalogedApiVersion

Represents a version of an API that is consumable in Salesforce using API Catalog.

## 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

CatalogedApiVersion components have the suffix .catalogedApiVersion and are stored in the catalogedApiVersions folder.

## Version

CatalogedApiVersion components are available in API version 65.0 and later.

## Special Access Rules

## Fields

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



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

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

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

            </tr>

          </thead>

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

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

              <td class="entry" headers="d234405e110" data-title="Description">Required. An API managed for consumption in Salesforce using API
                Catalog.</td>

            </tr>

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

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

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

            </tr>

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

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

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

            </tr>

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

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

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

              </td>

            </tr>

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

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

              <td class="entry" headers="d234405e110" data-title="Description">Required. The ID of the API version information.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

This XML is an example of a CatalogedApiVersion component.

<?xml version="1.0" encoding="UTF-8"?>
<CatalogedApiVersion xmlns="http://soap.sforce.com/2006/04/metadata">
    <catalogedApi\>PetstoreEngineeringv109C60C7C</catalogedApi\>
    <externalSourceIdentifier\>urn:ms:03ff2c74-d0ea-4eba-a536-36dfd2d0fdbb:api-project::petstore-engineering/v1</externalSourceIdentifier\>
    <label\>petstore-engineering</label\>
    <version\>v1lwWZmDFyJYIFValk</version\>
</CatalogedApiVersion\>