CatalogedApi | Metadata API Developer Guide

Parent Type

This type extends the Metadata 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

Field Name	Field Type	Description
description	string	The description defined when the API is cataloged.
descriptor	string	The content of the API schema in JSON format.
externalSourceIdentifier	string	The ID of the API in the external source that it's imported from.
instances	CatalogedApiInstance[]	Reference to the cataloged API that this instance is specific to.
label	string	Required. The API name as it appears in API Catalog.
providerType	ExternalServiceRegistrationProviderType (enumeration of type string)	Required. Indicates the source of the API specification registered with API Catalog. API Catalog supports the value `Anypoint` for deployment and supports other values for enumeration. See information about the values in the registrationProviderType field.
type	APIType (enumeration of type string)	Required. Specifies the API type. If not specified, the API type is derived based on the descriptor content. Nillable. Values are: `GraphQL` `gRPC` `REST`

CatalogedApiInstance

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

Field Name	Field Type	Description
accessStatus	APIInstanceAccessStatus (enumeration of type string)	Required. The access status for the API instance. Values are: `Approved` `Deleted` `NoStatus` `NotAccessible` `Pending` `Rejected` `Revoked`
apiInstanceDescriptor	string	The content of the API schema in JSON format.
approvalType	APIInstanceApprovalType (enumeration of type string)	Required. The approval type for access in Anypoint Platform. Values are: `AutoApproval` `ManualApproval` `NoApproval`
endpointType	APIInstanceEndpointType (enumeration of type string)	The endpoint type to invoke the instance. Available in API version 66.0 and later. Values are: `Callout` `Discovery`
label	string	Required. The instance name as it appears in API Catalog.
serviceRegistration	string	Required. The service registration in external services related to this API instance.
uri	string	Required. The uniform resource identifier (URI) for the instance.

Declarative Metadata Sample Definition

This XML is an example of a CatalogedApi component.

1<?xml version="1.0" encoding="UTF-8"?>
2<CatalogedApi xmlns="http://soap.sforce.com/2006/04/metadata">
3    <externalSourceIdentifier>urn:ms:03ff2c74-d0ea-4eba-a536-36dfd2d0fdbb:api-project::petstore-engineering</externalSourceIdentifier>
4    <instances>
5        <accessStatus>NoStatus</accessStatus>
6        <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>
7        <approvalType>NoApproval</approvalType>
8        <label>petstore-engineering</label>
9        <serviceRegistration>PetstoreEngineeringv109C60C7C</serviceRegistration>
10        <uri>https://google.com</uri>
11    </instances>
12    <label>petstore-engineering</label>
13    <providerType>Anypoint</providerType>
14    <type>REST</type>
15</CatalogedApi>