Skip to main content

Retrieve an Agentic Platform configuration in NetApp Console local deployment

GET /configs/{config_id}

Retrieves a specific AgentGateway configuration using the configuration ID.

Parameters

Name Type In Required Description

config_id

string

path

True

Unique identifier for the configuration instance.

Response

Status: 200, Returns the configuration in the JSON response body.
Name Type Required Description

apiKey

string

False

The stored provider API key, currently stored in plaintext in MongoDB.

adminAddr

string

False

Admin address for the AgentGateway

baseUrl

string

False

Base URL for the provider API. The response baseUrl mirrors the baseUrl from the provider credential object used during creation.

extraHeaders

extraHeaders

False

Additional HTTP headers to send with requests

extraParams

extraParams

False

Provider-specific additional parameters

id

string

True

Unique identifier for the configuration.

llmHealthState

string

False

Health state of the LLM provider connection. Defined values are:

  • "true" - LLM provider connection is healthy and working

  • "false" - LLM provider connection is unhealthy or failed

metadata

type_bxp_metadata

False

Metadata associated with the resource.

models

array[string]

True

List of configured models. Multiple models enable load balancing.

organizationId

string

False

Organization identifier associated with this configuration. Set from the x-organization-id request header during creation.

port

integer

False

Gateway port

provider

string

True

LLM provider name. Defined values are:

  • "openai" - OpenAI API

  • "anthropic" - Anthropic Claude API

  • "commonOpenAI" - Generic OpenAI-compatible API (custom/self-hosted LLM proxies)

proxyConfigured

string

False

Indicates whether a proxy is configured for this LLM backend. This field reflects whether a cluster-level proxy is active. It is set automatically and should not be set by callers. Defined values are:

  • "true" - A proxy is configured and active for outbound LLM traffic

  • "false" - No proxy is configured; LLM traffic is routed directly

rawConfig

rawConfig

False

Raw AgentGateway YAML configuration as JSON. Currently stores only the user identifier extracted from extraParams. Does not contain the full AgentGateway backend configuration.

sslVerify

boolean

False

Indicates whether to verify SSL certificates.

state

string

True

Current state of the configuration lifecycle. Defined values are:

  • "DRAFT" - Configuration is in draft mode, not yet applied

  • "TESTING" - Configuration is being tested and validated

  • "SUCCESSFUL" - Configuration has been successfully applied and verified

  • "UNSUCCESSFUL" - Configuration application or validation failed

type

string

True

Media type of the resource. Defined values are:

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

version

string

True

Version of the configuration format. Defined values are:

  • "1.0"
Example response 
{
  "baseUrl": "https://api.openai.com",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "llmHealthState": "true",
  "metadata": {
    "creationTimestamp": "2025-01-16T10:30:00Z",
    "labels": [],
    "modificationTimestamp": "2025-01-16T10:30:00Z"
  },
  "models": [
    "gpt-4o",
    "gpt-4o-mini"
  ],
  "port": 8080,
  "provider": "openai",
  "proxyConfigured": "false",
  "sslVerify": true,
  "state": "SUCCESSFUL",
  "type": "application/vnd.netapp.bxp.config",
  "version": "1.0"
}

Error

Status: 401, Unauthorized
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.
Example error response 
{
  "detail": "The request is missing the required bearer token.",
  "status": "401",
  "title": "Missing bearer token",
  "type": "https://bluexp.netapp.io/problems/1"
}

Error

Status: 403, Forbidden
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.
Example error response 
{
  "detail": "The requested operation isn't permitted.",
  "status": "403",
  "title": "Operation not permitted",
  "type": "https://bluexp.netapp.io/problems/11"
}

Error

Status: 404, Not found
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.
Example error response 
{
  "detail": "The collection specified in the request URI wasn't found.",
  "status": "404",
  "title": "Collection not found",
  "type": "https://bluexp.netapp.io/problems/2"
}

Definitions

See Definitions

extraHeaders

Additional HTTP headers to send with requests

Hash mapping strings to string

extraParams

Provider-specific additional parameters

Hash mapping strings to string

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.

rawConfig

Raw AgentGateway YAML configuration as JSON. Currently stores only the user identifier extracted from extraParams. Does not contain the full AgentGateway backend configuration.

invalidParams

Name Type Required Description

name

string

True

Name of the invalid parameter.

reason

string

True

Reason why the parameter is invalid.