Skip to main content

Retrieve an LLM supported provider in NetApp Console local deployment

GET /supportedProviders/{supported_provider_id}

Returns detailed information about a specific Large Language Model (LLM) supported provider, identified by its unique ID.

Parameters

Name Type In Required Description

supported_provider_id

string

path

True

Unique identifier of the supported provider or provider name.

  • example: 550e8400-e29b-41d4-a716-446655440000 or openai

Response

Status: 200, Successfully retrieved the supported provider.
Name Type Required Description

description

string

False

Human-readable description of the supported provider.

id

string

True

Globally unique identifier of the supported provider. Defined values are:

  • Conforms to the UUIDv4 Schema

isConfigured

boolean

False

Indicates whether this supported provider has been configured with credentials.

isEnabled

boolean

False

Indicates whether this supported provider is currently enabled for use.

metadata

type_bxp_metadata

False

Metadata associated with the resource.

name

string

True

Name of the LLM supported provider. Defined values are:

  • "openai" - OpenAI API

  • "anthropic" - Anthropic Claude API

  • "commonOpenAI" - Generic OpenAI-compatible API

supportedModelTypes

array[string]

False

List of model types supported by this supported provider.

type

string

True

Media type of the resource. Defined values are:

  • "application/vnd.netapp.bxp.supportedProvider"

version

string

True

Version of the resource. Defined values are:

  • "1.0"
Example response 
{
  "description": "OpenAI API - Access to GPT models including GPT-4, GPT-4o, and GPT-3.5",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "isConfigured": false,
  "isEnabled": true,
  "metadata": {
    "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32",
    "creationTimestamp": "2022-10-06T20:58:16.305662Z",
    "labels": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "modificationTimestamp": "2022-10-06T20:58:16.305662Z",
    "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32"
  },
  "name": "openai",
  "supportedModelTypes": [
    "chat",
    "completion",
    "embedding",
    "image",
    "audio"
  ],
  "type": "application/vnd.netapp.bxp.supportedProvider",
  "version": "1.0"
}

Response

Status: 401, Unauthorized - authentication required.
Name Type Required Description

correlationId

string

False

Internal UUID representing the request or trace ID related.

detail

string

False

Details about the problem.

invalidParams

array[invalidParams]

False

List of invalid parameters.

status

string

True

HTTP error code related to the problem.

title

string

True

Title description of the problem.

type

string

True

Content-type of the object.

Response

Status: 403, Forbidden - insufficient permissions.
Name Type Required Description

correlationId

string

False

Internal UUID representing the request or trace ID related.

detail

string

False

Details about the problem.

invalidParams

array[invalidParams]

False

List of invalid parameters.

status

string

True

HTTP error code related to the problem.

title

string

True

Title description of the problem.

type

string

True

Content-type of the object.

Response

Status: 404, Not found - supported provider does not exist.
Name Type Required Description

correlationId

string

False

Internal UUID representing the request or trace ID related.

detail

string

False

Details about the problem.

invalidParams

array[invalidParams]

False

List of invalid parameters.

status

string

True

HTTP error code related to the problem.

title

string

True

Title description of the problem.

type

string

True

Content-type of the object.

Response

Status: 500, Internal server error.
Name Type Required Description

correlationId

string

False

Internal UUID representing the request or trace ID related.

detail

string

False

Details about the problem.

invalidParams

array[invalidParams]

False

List of invalid parameters.

status

string

True

HTTP error code related to the problem.

title

string

True

Title description of the problem.

type

string

True

Content-type of the object.

Error

Status: 400, Bad request - invalid supported provider id format.
Name Type Required Description

correlationId

string

False

Internal UUID representing the request or trace ID related.

detail

string

False

Details about the problem.

invalidParams

array[invalidParams]

False

List of invalid parameters.

status

string

True

HTTP error code related to the problem.

title

string

True

Title description of the problem.

type

string

True

Content-type of the object.

Definitions

See Definitions

type_bxp_label

Name/value pair.

Name Type Required Description

name

string

True

Name of the label.

value

string

True

Value of the label.

type_bxp_metadata

Metadata associated with the resource.

Name Type Required Description

createdBy

string

False

UUID of the user who created the resource.

creationTimestamp

string

False

Resource creation date.

labels

array[type_bxp_label]

False

Array of name/value pairs representing additional information for the resource.

modificationTimestamp

string

False

Resource modification date.

modifiedBy

string

False

UUID of the user who modified the resource.

invalidParams

Name Type Required Description

name

string

True

Name of the invalid parameter.

reason

string

True

Reason why the parameter is invalid.