Skip to main content

Apply an Agentic Platform configuration in NetApp Console local deployment

PATCH /configs/{config_id}

Triggers the Kubernetes (K8s) resource creation and applies the specified Agentic platform configuration. The PATCH endpoint orchestrates the full apply pipeline. A failed connection test sets the state to unsuccessful and does not apply K8s resources. The AgentGateway automatically hot reloads the updated configuration.

Provider-specific credentials can be updated using the corresponding provider object. Changing the provider in a PATCH request automatically removes the previous provider's Kubernetes (K8s) resources.

Parameters

Name Type In Required Description

config_id

string

path

True

Unique identifier for the configuration instance.

Request Body

Replaces the specified attributes in the request body with the values provided.

Name Type Required Description

adminAddr

string

False

Admin address for the AgentGateway

anthropic

provider_credentials_anthropic_config

False

Anthropic Claude provider-specific configuration

commonOpenAI

provider_credentials_commonOpenAI_config

False

Generic OpenAI-compatible API configuration (for custom/self-hosted LLM proxies). Duplicate models with equivalent dot/dash notation are merged; the first occurrence is returned. commonOpenAI is an alias for the OpenAI provider with a custom baseUrl. Both map to the same AgentGateway backend type.

extraHeaders

extraHeaders

False

Additional HTTP headers

extraParams

extraParams

False

Provider-specific additional parameters

models

array[string]

False

List of models to configure

openai

provider_credentials_openai_config

False

OpenAI provider-specific configuration

port

integer

False

Gateway port

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

requestsPerMinute

integer

False

The rate limit - maximum requests per minute (0 = unlimited).

sslVerify

boolean

False

Indicates whether to verify SSL certificates.

stateDesired

string

False

Desired state for the configuration lifecycle transition. Use this field to request a state change for the configuration. Defined values are:

  • "DRAFT" - Move configuration to draft mode

  • "TESTING" - Tests the LLM provider connection only. Does not create or modify AgentGateway resources. The llmHealthState is updated to reflect the test result.

  • "SUCCESSFUL" - Mark configuration as having been successfully applied

  • "UNSUCCESSFUL" - Mark configuration as having failed

Note Only TESTING has a distinct behavior. DRAFT, SUCCESSFUL, UNSUCCESSFUL in stateDesired have no special effect — the full apply pipeline runs.

tokensPerMinute

integer

False

The rate limit - maximum tokens per minute (0 = unlimited).

type

string

False

Media type of the resource. Defined values are:

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

version

string

False

Version of the configuration format. Defined values are:

  • "1.0"
Example request 
{
  "proxyConfigured": "false",
  "type": "application/vnd.netapp.bxp.config",
  "version": "1.0"
}

Response

Status: 200, Configuration updated successfully.
Name Type Required Description

configVersion

string

False

Version of the applied configuration

message

string

True

Success message

timestamp

string

False

Timestamp of the operation

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 
{
  "configVersion": "1.0",
  "message": "Configuration updated successfully. AgentGateway will automatically apply changes.",
  "type": "application/vnd.netapp.bxp.config",
  "version": "1.0"
}

Error

Status: 400, Bad request
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 supplied query parameters are invalid.",
  "status": "400",
  "title": "Invalid query parameters",
  "type": "https://bluexp.netapp.io/problems/1"
}

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

provider_credentials_anthropic_config

Anthropic Claude provider-specific configuration

Name Type Required Description

anthropicVersion

string

False

Anthropic API version header. If not specified, defaults to 2023-06-01.

apiKey

string

True

Anthropic API key

baseUrl

string

False

Base URL for Anthropic API (optional)

extraHeaders

Additional headers to include in requests

Hash mapping strings to string

extraParams

Additional parameters to include in requests

Hash mapping strings to string

provider_credentials_commonOpenAI_config

Generic OpenAI-compatible API configuration (for custom/self-hosted LLM proxies). Duplicate models with equivalent dot/dash notation are merged; the first occurrence is returned. commonOpenAI is an alias for the OpenAI provider with a custom baseUrl. Both map to the same AgentGateway backend type.

Name Type Required Description

apiKey

string

False

API key for the OpenAI-compatible service

baseUrl

string

True

Base URL for the OpenAI-compatible API

extraHeaders

extraHeaders

False

Additional headers to include in requests

extraParams

extraParams

False

Additional parameters to include in requests

extraHeaders

Additional HTTP headers

Hash mapping strings to string

extraParams

Provider-specific additional parameters

Hash mapping strings to string

provider_credentials_openai_config

OpenAI provider-specific configuration

Name Type Required Description

apiKey

string

True

OpenAI API key

baseUrl

string

False

Base URL for OpenAI API (optional, defaults to https://api.openai.com)

organizationId

string

False

OpenAI organization ID (optional)

invalidParams

Name Type Required Description

name

string

True

Name of the invalid parameter.

reason

string

True

Reason why the parameter is invalid.