Skip to content

List ExternalModels

GET /api/v1/externalmodel

GET /maas/api/v1/externalmodel

Returns ExternalModels enriched with referenced ExternalProvider details and companion MaaSModelRef endpoint status.

Authorization

Parameters

Name In Type Required Description
namespace query string Yes

Responses

Status Description Response body
200 OK

ExternalModel list

object

application/json

200 OK response body

Property Type Required Description
data array of ExternalModelSummary No

Example request

curl -X GET "/maas/api/v1/externalmodel?namespace=NAMESPACE" \
  -H "Authorization: Bearer $TOKEN"

Example response

200 OK, application/json

{
  "data": [
    {
      "name": "string",
      "namespace": "string",
      "displayName": "string",
      "description": "string",
      "modelName": "string",
      "providerRefs": [
        {
          "providerName": "string",
          "weight": 0,
          "apiFormat": "string",
          "path": "string",
          "targetModel": "string",
          "config": {
            "key": "string"
          },
          "authMechanism": "apikey",
          "credentialSecretRef": "string",
          "provider": {
            "displayName": "string",
            "description": "string",
            "endpointUrl": "string",
            "authMechanism": "apikey",
            "credentialSecretRef": "string",
            "provider": "string",
            "config": {},
            "phase": "string",
            "statusMessage": "string",
            "reason": "Reconciled"
          }
        }
      ],
      "phase": "string",
      "statusMessage": "string",
      "reason": "Reconciled",
      "maaSModelRef": {
        "phase": "string",
        "statusMessage": "string",
        "reason": "Reconciled",
        "endpoint": "string",
        "governanceAttached": true
      }
    }
  ]
}