Skip to content

Read backend-generated API-to-MCP mappings for an API source.

GET
/v1/api-sources/{api_source_id}/mappings

Mappings are backend-owned read-only data derived from selected operations and approval state. This endpoint returns only metadata needed by UI mapping previews: generated tool ids/names, operation ids, method/path, request content type, runtime placement, input schema fields, credential binding id, limits, and audit posture. It never returns request bodies, response bodies, examples, API keys, credential values, or payload values.

api_source_id
required
string
>= 1 characters
tenant_id
string
>= 1 characters
environment_id
string
>= 1 characters

Generated mappings for the scoped API source. Unapproved sources return an empty mappings array.

object
schemaVersion
required
apiSourceId
required
string
>= 1 characters
environmentId
required
string
>= 1 characters
approvalStatus
required
string
Allowed values: submitted under_review approved rejected disabled archived
runtimePlacement
required
object
mode
required
mcpServerCreated
required
boolean
managedMcpHostingAvailable
required
boolean
reasonCode
required
mappings
required
Array<object>
object
schemaVersion
required
apiSourceId
required
string
>= 1 characters
operationId
required
string
>= 1 characters
generatedToolId
required
string
>= 1 characters
generatedToolName
required
string
>= 1 characters
displayName
required
string
>= 1 characters
description
required
string
>= 1 characters
selected
required
boolean
approvalStatus
required
requestContentType
required
Allowed values: application/json application/x-www-form-urlencoded multipart/form-data
method
required
Allowed values: GET POST PUT PATCH DELETE
upstreamHost
required
string
>= 1 characters
pathTemplate
required
string
>= 1 characters /^//
runtimePlacement
required
object
mode
required
mcpServerCreated
required
boolean
managedMcpHostingAvailable
required
boolean
reasonCode
required
inputSchema
required
object
type
required
additionalProperties
required
boolean
required
required
Array<string>
properties
required
object
key
additional properties
object
type
required
Allowed values: string integer number boolean object array
location
required
Allowed values: path query header body
required
required
boolean
minLength
integer
maxLength
integer
>= 1
maxItems
integer
>= 1
maxBytes
integer
>= 1
validationBoundaries
required
object
pathParamsRequired
required
boolean
querySchemaValidated
required
boolean
headerSchemaValidated
required
boolean
bodySchemaValidated
required
boolean
credentialBindingId
required
Any of:
string
>= 1 characters
credentialMode
required
Allowed values: none service_account user_delegated agent_scoped workload_mapped
authRequirements
required
Array<object>
object
authGroup
required
integer
scheme
required
Allowed values: none api_key bearer basic oauth2 hmac sigv4 mtls workload_identity unsupported
placement
required
Allowed values: none header query authorization_header transport signature
schemeName
string
>= 1 characters
parameterName
string
>= 1 characters
requiredScopes
required
Array<string>
oauthFlow
Allowed values: client_credentials authorization_code jwt_bearer unknown
bearerFormat
string
>= 1 characters
credentialBindingRequired
required
boolean
callerVisible
required
boolean
supported
required
boolean
unsupportedReason
string
/^[a-z0-9_]+$/
injectionPlan
required
Allowed values: none header_api_key query_api_key authorization_bearer authorization_basic oauth2_client_credentials oauth2_user_delegated workload_identity mtls hmac_signature aws_sigv4 unsupported
injectionPlan
required
Allowed values: none header_api_key query_api_key authorization_bearer authorization_basic oauth2_client_credentials oauth2_user_delegated workload_identity mtls hmac_signature aws_sigv4 unsupported
requiredScopes
required
Array<string>
credentialCompatibility
required
Allowed values: not_required compatible unsupported
unsupportedReason
required
Any of:
string
/^[a-z0-9_]+$/
limits
required
object
timeoutMs
required
integer
>= 1 <= 30000
maxRequestBytes
required
integer
>= 1
maxResponseBytes
required
integer
>= 1
oversizeBehavior
required
adapterValidation
required
object
denyUnselected
required
boolean
denyUnapproved
required
boolean
enforceHostAllowlist
required
boolean
validateInputSchema
required
boolean
enforceCredentialBinding
required
boolean
enforceSizeLimits
required
boolean
auditSecretFree
required
boolean
audit
required
object
eventType
required
policyVersionRequired
required
boolean
credentialModeRequired
required
boolean
credentialBindingIdRequired
required
boolean
payloadLogged
required
boolean
secretMaterialLogged
required
boolean
redactionStatus
required

Missing api_source.read for the requested tenant/environment scope.

API source was not found in the requested scope.

Type set in Geist, Source Serif 4, and Departure Mono.