Skip to main content

Settings and credentials API

Change how the gateway serves each MCP: its tools, DLP, token saving, access control and other settings, overrides for one user or smart group, the credentials the gateway sends upstream, and which new tools clients can see.

Every write on this page except tool review approve and reject needs If-Match with the MCP's current version (see versions and If-Match). The MCP's settings, overrides, upstream credentials, name and enabled state share one version, so any of these changes invalidates an ETag you read earlier. Try every operation in the MCP Management API playground.

MCP settings​

GET /mcps/{mcp_id}/settings returns every settings section with defaults filled in, and whether QuilrQL policies are authoritative (policy_authority.mode). PATCH /mcps/{mcp_id}/settings (scope settings:write) changes one or more sections:

SectionWhat it controlsPatch behavior
toolsPer-tool settings such as enabled state and confirmation, keyed by tool name.Merges by key.
dlpData loss prevention actions and enabled risk categories. See Security guardrails.Merges by key.
token_savingOutput transforms that reduce tokens sent to the model. See Token saving.Merges by key.
access_controlWhich agents, smart groups and users may use this MCP. See access control order and Server access.Merges by key.
tool_syncWhat happens when the upstream tool list changes: mode is notify (record the change for review), auto (refresh the tool list) or off. new_tools decides whether tools the MCP starts listing later are held for review: inherit (follow the organization's switch, the default), hold or allow.Merges by key.
tool_exposureSmart tool lists: list only the most-used tools plus a tool search, or expose a code tool. See Tool lists.Merges by key.
onemcpHow this MCP takes part in OneMCP; hidden makes it reachable only at its own endpoint.Merges by key.
web_search_policyWeb search policy of the QuilrAI Web Search MCP. See Web search security.Replaces the stored value.
oauth_scopesOAuth scopes requested from the provider. See OAuth permissions.Replaces the stored value; null clears it.
send_user_claims_headerForward user claims to the upstream server. See Claims forwarding.Sets the value.
upstream_session_max_concurrencyMaximum concurrent upstream sessions (1 to 256).Sets the value; null clears it.
curl --request PATCH "$GW/mcpgateway/management/v1/mcps/a1b2c3d4/settings" \
--header "Authorization: Bearer $KEY" \
--header 'If-Match: "r4"' \
--header 'Content-Type: application/json' \
--data '{"tools": {"delete_file": {"enabled": false}, "write_file": {"enforce_confirmation": true}}}'

Access control order​

The user and smart group lists of access_control are checked in this order, and the first match wins:

  1. denied_users: blocked.
  2. allowed_users: allowed, even when one of the user's smart groups is denied.
  3. denied_smart_groups: blocked.
  4. allowed_smart_groups: when the list is not empty, users in none of these groups are blocked.

Anyone else is allowed. denied_users always blocks, and a user in allowed_users is not blocked by a denied smart group. Emails and group names are compared without regard to case. allowed_agents is checked separately. The console shows the same order; see Server access.

Unknown fields at any depth are refused with 400 and their paths in error.fields. Changes apply immediately to the MCP's own endpoint and to OneMCP.

Custom tools

Settings, policies, quotas, DLP and confirmation apply to every call a client makes, including calls to a custom tool, which are checked under the custom tool's own name. Calls a custom tool's script makes skip the called tool's own settings: a tool turned off here stays off for users, but custom tools on the MCP can still call it. Set the controls on the custom tool.

QuilrQL policies

When QuilrQL policies govern your organization, settings are saved but not enforced, and the response carries an inactive_under_quilrql warning. See the Policy Engine.

INPUT SCHEMAMcpSettingsPatch

Sectioned MCP settings patch. Unknown fields at any depth are refused. tools, dlp, token_saving, access_control, tool_sync, tool_exposure and onemcp merge by key into the stored settings; web_search_policy and oauth_scopes replace the stored value; oauth_scopes: null and upstream_session_max_concurrency: null clear it.

access_controlobjectoptional

Which agents, smart groups and users may use this MCP. Users are checked in this order, first match wins: denied_users (blocked), allowed_users (allowed, even when a group of theirs is denied), denied_smart_groups (blocked), then allowed_smart_groups (when not empty, users in none of them are blocked). Otherwise allowed.

Object fields
allowed_agentsarray<string>optional
Array item specification
string
allowed_smart_groupsarray<string>optional
Array item specification
string
allowed_usersarray<string>optional
Array item specification
string
denied_smart_groupsarray<string>optional
Array item specification
string
denied_usersarray<string>optional
Array item specification
string

Unknown fields are rejected in this object.

dlpobjectoptional

Data loss prevention actions and enabled risk categories for this MCP.

Object fields
data_risk_actionstringoptional
data_risk_request_actionstringoptional
data_risk_response_actionstringoptional
enabled_oob_adversarial_risk_categoriesmap<string, boolean>optional
Map value specification
boolean
enabled_oob_data_risk_categoriesmap<string, boolean>optional
Map value specification
boolean
enabled_oob_edm_sub_categoriesmap<string, boolean>optional
Map value specification
boolean
oob_adversarial_risk_category_request_actionsmap<string, string>optional
Map value specification
string
oob_adversarial_risk_category_response_actionsmap<string, string>optional
Map value specification
string
oob_data_risk_category_request_actionsmap<string, string>optional
Map value specification
string
oob_data_risk_category_response_actionsmap<string, string>optional
Map value specification
string
oob_edm_sub_category_request_actionsmap<string, string>optional
Map value specification
string
oob_edm_sub_category_response_actionsmap<string, string>optional
Map value specification
string

Unknown fields are rejected in this object.

oauth_scopesarray<string> | nulloptional
Variant 1 array<string>
array<string>

Also accepts null.

onemcpobjectoptional

How this MCP takes part in OneMCP; hidden makes it reachable only at its own endpoint.

Object fields
hiddenbooleanoptional

Unknown fields are rejected in this object.

send_user_claims_headerbooleanoptional
token_savingobjectoptional

Output transforms that reduce tokens sent to the model.

Object fields
html_to_textbooleanoptional
markdown_to_textbooleanoptional
smart_json_compressionbooleanoptional
strip_base64booleanoptional

Replaces detected base64 content with a byte-count placeholder. Removed content is unavailable to the model.

text_compressionbooleanoptional

Unknown fields are rejected in this object.

tool_exposureobjectoptional

Smart tool lists: list only the most-used tools plus a tool search, or expose a code tool. Both are off by default.

Object fields
codebooleanoptional
pinnedarray<string>optional
Array item specification
string
top_toolsbooleanoptional

Unknown fields are rejected in this object.

tool_syncobjectoptional

What happens when the upstream tool list changes: notify (record the change for review), auto (refresh the tool list) or off.

Object fields
modestringoptional
"notify""auto""off"
new_toolsstringoptional
"inherit""hold""allow"

Unknown fields are rejected in this object.

toolsmap<string, object>optional
Map value specification
enabledbooleanoptional
enforce_confirmationbooleanoptional
require_justificationbooleanoptional

Unknown fields are rejected in this object.

upstream_session_max_concurrencyinteger | nulloptional
Variant 1 integer
integer
min: 1max: 256

Also accepts null.

web_search_policyobjectoptional

Web search policy of the Quilr web search MCP: per smart group domain exclusions and URL category overrides.

Object fields
group_excluded_domainsmap<string, array<string>>optional
Map value specification
array<string>
zia_check_timeout_secondsnumberoptional
min: 1max: 30
zia_url_overridesarray<object>optional
Array item specification
actionstringrequired
"allow""block"
domain_patternsarray<string>optional
Array item specification
string
scope_namestringoptional
scope_namesarray<string>optional
Array item specification
string
scope_typestringrequired
"global""zia_group""zia_department"

Unknown fields are rejected in this object.

Unknown fields are rejected in this object.

Unknown fields are rejected in this object.

Per-user and per-group overrides​

Overrides change the tools, dlp and token_saving settings for one user (an email in your organization) or one smart group. A user override wins over smart group overrides, which win over the MCP settings.

OperationScope
GET /mcps/{mcp_id}/scoped-settings lists the overrides, a page at a time.read
PUT /mcps/{mcp_id}/scoped-settings/{scope_type}/{scope_value} creates or replaces one. scope_type is user or smart_group. "enabled": false keeps the override stored but inactive.settings:write
DELETE /mcps/{mcp_id}/scoped-settings/{scope_type}/{scope_value} removes one; deleted is false when none existed.settings:write

Saving an override identical to the stored one, or deleting one that does not exist, changes nothing and keeps the MCP's version; a stale If-Match is still 412. When QuilrQL policies govern your organization, overrides are saved but not enforced, and both writes carry the inactive_under_quilrql warning.

Read the overrides​

GET /mcps/{mcp_id}/scoped-settings returns {"mcp_id", "scoped_settings", "next_cursor", "version"}. It pages like other lists: limit (1 to 200, default 50) and cursor, the next_cursor of the previous page (null on the last page). A malformed cursor or limit is 400 invalid_request, and a list that changes between pages is 409 collection_changed; start again without a cursor (see pagination). version is the If-Match value for the writes.

To read the override of one user or smart group, send scope_type and scope_value together:

curl "$GW/mcpgateway/management/v1/mcps/a1b2c3d4/scoped-settings?scope_type=user&scope_value=dana@example.com" \
--header "Authorization: Bearer $KEY"

Both values are trimmed of surrounding spaces and then matched exactly, with case kept, so Dana@example.com does not find dana@example.com. A blank value is matched the same way. scoped_settings is empty when there is no override for that scope. Sending only one of the two is 400 invalid_request, with the missing parameter in error.fields.

Upstream credentials​

The static credential and the extra headers or query parameters that the gateway sends to the MCP's upstream server. Secrets are write-only: reads return whether a credential is configured, how it is sent, and the names of extras, never their values.

A credential has a mode. admin_shared (the default): one key, set here, used for everyone. user_required: each person brings their own key and saves it from the Quilr user dashboard (hand them the sign-in link); send the shape only (type, and header_name, query_param or scheme), never a token. Switching to user_required deletes the shared key. Switching back needs a new token and keeps the keys people saved, unused, in case you switch again; user_credentials_saved counts them. Omitting mode keeps the current one.

OperationBehavior
GET /mcps/{mcp_id}/upstream-authCredential metadata (scope read).
PUT /mcps/{mcp_id}/upstream-authCreates, rotates or changes the credential and extras, or switches mode (scope credentials:write). type is bearer, header or query. Omitted extras keep the stored ones; {} clears them. OAuth MCPs take extras only (see below).
DELETE /mcps/{mcp_id}/upstream-authRemoves the credential and, unless keep_extras=true, the extras (scope credentials:write). A REST API MCP always keeps its extra headers and query parameters; clear them with PUT {"extra_headers": {}, "extra_query_params": {}}. Refused with 409 policy_dependency while the active QuilrQL policy depends on them.

OAuth MCPs: extras only​

An OAuth MCP signs in with its provider, so it has no static credential: connect it with a connect link. You can still set the extra headers and query parameters the gateway sends with its upstream calls. Send only extra_headers and extra_query_params:

curl --request PUT "$GW/mcpgateway/management/v1/mcps/e5f6a7b8/upstream-auth" \
--header "Authorization: Bearer $KEY" \
--header 'If-Match: "r7"' \
--header 'Content-Type: application/json' \
--data '{"extra_headers": {"X-Workspace": "acme"}}'

A body with any static credential field (type, mode, token, header_name, query_param or scheme) is refused with 400 on an OAuth MCP. The read reports credential_editable: false for these MCPs.

Tool reviews​

When new upstream tools are held for review, clients do not see them until they are approved. Whether an MCP holds new tools follows tool_sync.new_tools in its settings. See Tool change watch.

GET /mcps/{mcp_id}/tool-reviews returns the review mode and the tools detected upstream that are held or rejected. POST .../tool-reviews/approve adds the named held or rejected tools to the tool list; POST .../tool-reviews/reject keeps them hidden from clients. Both take {"tools": [...]}, need tool_reviews:write but no If-Match, and answer 409 tools_not_awaiting_review when a named tool is not awaiting review.

Endpoint reference​

GET/mcps/{mcp_id}/scoped-settings

List per-user and per-group overrides

Overrides of tools, dlp and token_saving for one user or smart group, ordered by scope type and value and paginated with `limit` and `cursor`. `scope_type` with `scope_value` returns only that scope's override (an empty list when there is none). `version` is the MCP configuration version of the page it comes with.

REQUIRESread
Path, query & header parameters 5
mcp_id (path)stringrequired

MCP id (the `id` of an MCP, not its slug).

limit (query)integeroptional

Page size, 1 to 200 (default 50).

min: 1max: 200default: 50
cursor (query)stringoptional

The `next_cursor` of the previous page. 409 `collection_changed` when the list changed; restart.

scope_type (query)stringoptional

With scope_value: only the override for this scope, user or smart_group. Matched exactly after trimming spaces. Send both or neither (one alone is 400).

scope_value (query)stringoptional

With scope_type: only the override for this user email or smart group name, matched exactly (case kept) after trimming spaces. Send both or neither.

No request body.

curl --request GET \
'https://mcpgateway.quilr.ai/mcpgateway/management/v1/mcps/a1b2c3d4/scoped-settings?limit=50' \
--header 'Authorization: Bearer <management-key>'

Authentication, errors & retry rules Scopes Try it in the playground

DELETE/mcps/{mcp_id}/scoped-settings/{scope_type}/{scope_value}

Remove an override

Removes the override; `deleted` is false when none existed (the version is then unchanged). Under QuilrQL the answer carries an `inactive_under_quilrql` warning. Send the quoted `version` from the latest read in If-Match (428 when missing, 412 when stale).

REQUIRESsettings:write
Path, query & header parameters 4
mcp_id (path)stringrequired

MCP id (the `id` of an MCP, not its slug).

scope_type (path)stringrequired

`user` (an email of this tenant) or `smart_group` (a smart group name).

scope_value (path)stringrequired

The user email or smart group name. Encode `/` as `%2F`.

If-Match (header)stringrequired

Quoted `version` (ETag) from the latest read of this resource.

Full request body specification application/json

No body, or an empty JSON object.

Unknown fields are rejected in this object.

curl --request DELETE \
'https://mcpgateway.quilr.ai/mcpgateway/management/v1/mcps/a1b2c3d4/scoped-settings/user/dana%40example.com' \
--header 'Authorization: Bearer <management-key>' \
--header 'If-Match: "r4"'

Authentication, errors & retry rules Scopes Try it in the playground

PUT/mcps/{mcp_id}/scoped-settings/{scope_type}/{scope_value}

Create or replace an override

Stores the override for one user (email of this tenant) or smart group. A user override wins over smart group overrides, which win over the MCP settings. Saving an override identical to the stored one keeps the version. Under QuilrQL the override is saved with an `inactive_under_quilrql` warning. Send the quoted `version` from the latest read in If-Match (428 when missing, 412 when stale).

REQUIRESsettings:write
Path, query & header parameters 4
mcp_id (path)stringrequired

MCP id (the `id` of an MCP, not its slug).

scope_type (path)stringrequired

`user` (an email of this tenant) or `smart_group` (a smart group name).

scope_value (path)stringrequired

The user email or smart group name. Encode `/` as `%2F`.

If-Match (header)stringrequired

Quoted `version` (ETag) from the latest read of this resource.

Full request body specification application/json

enabledboolean | nulloptional

false keeps the override stored but inactive.

settingsobjectrequired

Per-user or per-smart-group override of tools, dlp and token_saving (at least one section).

min fields: 1
Object fields
dlpobject | nulloptional
ScopedDlpSettingsPatch object
data_risk_actionstring | nulloptional
Variant 1 string
string

Values: "monitor""partial-redact""redact""block"

Also accepts null.

data_risk_request_actionstring | nulloptional
Variant 1 string
string

Values: "monitor""partial-redact""redact""block"

Also accepts null.

data_risk_response_actionstring | nulloptional
Variant 1 string
string

Values: "monitor""partial-redact""redact""block"

Also accepts null.

enabled_oob_adversarial_risk_categoriesmap<string, boolean> | nulloptional
Variant 1 map<string, boolean>
map<string, boolean>

Also accepts null.

enabled_oob_data_risk_categoriesmap<string, boolean> | nulloptional
Variant 1 map<string, boolean>
map<string, boolean>

Also accepts null.

enabled_oob_edm_sub_categoriesmap<string, boolean> | nulloptional
Variant 1 map<string, boolean>
map<string, boolean>

Also accepts null.

oob_adversarial_risk_category_request_actionsmap<string, string> | nulloptional
Variant 1 map<string, string>
map<string, string>

Also accepts null.

oob_adversarial_risk_category_response_actionsmap<string, string> | nulloptional
Variant 1 map<string, string>
map<string, string>

Also accepts null.

oob_data_risk_category_request_actionsmap<string, string> | nulloptional
Variant 1 map<string, string>
map<string, string>

Also accepts null.

oob_data_risk_category_response_actionsmap<string, string> | nulloptional
Variant 1 map<string, string>
map<string, string>

Also accepts null.

oob_edm_sub_category_request_actionsmap<string, string> | nulloptional
Variant 1 map<string, string>
map<string, string>

Also accepts null.

oob_edm_sub_category_response_actionsmap<string, string> | nulloptional
Variant 1 map<string, string>
map<string, string>

Also accepts null.

Unknown fields are rejected in this object.

Also accepts null.

token_savingobject | nulloptional
ScopedTokenSavingSettingsPatch object
html_to_textboolean | nulloptional
Variant 1 boolean
boolean

Also accepts null.

markdown_to_textboolean | nulloptional
Variant 1 boolean
boolean

Also accepts null.

smart_json_compressionboolean | nulloptional
Variant 1 boolean
boolean

Also accepts null.

strip_base64boolean | nulloptional

Replaces detected base64 content with a byte-count placeholder. Removed content is unavailable to the model.

Variant 1 boolean
boolean

Also accepts null.

text_compressionboolean | nulloptional
Variant 1 boolean
boolean

Also accepts null.

Unknown fields are rejected in this object.

Also accepts null.

toolsmap<string, object> | nulloptional
Variant 1 map<string, object>
map<string, object>

Also accepts null.

Unknown fields are rejected in this object.

Unknown fields are rejected in this object.

curl --request PUT \
'https://mcpgateway.quilr.ai/mcpgateway/management/v1/mcps/a1b2c3d4/scoped-settings/user/dana%40example.com' \
--header 'Authorization: Bearer <management-key>' \
--header 'If-Match: "r4"' \
--header 'Content-Type: application/json' \
--data '{
"enabled": true,
"settings": {
"dlp": {
"data_risk_action": "block"
}
}
}'

Authentication, errors & retry rules Scopes Try it in the playground

GET/mcps/{mcp_id}/settings

Read MCP settings

Every settings section with defaults filled in, and whether QuilrQL policies are authoritative (`policy_authority.mode`).

REQUIRESread
Path, query & header parameters 1
mcp_id (path)stringrequired

MCP id (the `id` of an MCP, not its slug).

No request body.

curl --request GET \
'https://mcpgateway.quilr.ai/mcpgateway/management/v1/mcps/a1b2c3d4/settings' \
--header 'Authorization: Bearer <management-key>'

Authentication, errors & retry rules Scopes Try it in the playground

PATCH/mcps/{mcp_id}/settings

Update MCP settings

Sectioned patch: tools, dlp, token_saving, access_control, tool_sync, tool_exposure and onemcp merge by key; web_search_policy and oauth_scopes replace the stored value. Unknown fields at any depth answer 400 with their paths in `error.fields`. Changes reach both the MCP's own endpoint and OneMCP immediately. Under QuilrQL the settings are saved with an `inactive_under_quilrql` warning. Send the quoted `version` from the latest read in If-Match (428 when missing, 412 when stale).

REQUIRESsettings:write
Path, query & header parameters 2
mcp_id (path)stringrequired

MCP id (the `id` of an MCP, not its slug).

If-Match (header)stringrequired

Quoted `version` (ETag) from the latest read of this resource.

Full request body specification application/json

Sectioned MCP settings patch. Unknown fields at any depth are refused. tools, dlp, token_saving, access_control, tool_sync, tool_exposure and onemcp merge by key into the stored settings; web_search_policy and oauth_scopes replace the stored value; oauth_scopes: null and upstream_session_max_concurrency: null clear it.

access_controlobjectoptional

Which agents, smart groups and users may use this MCP. Users are checked in this order, first match wins: denied_users (blocked), allowed_users (allowed, even when a group of theirs is denied), denied_smart_groups (blocked), then allowed_smart_groups (when not empty, users in none of them are blocked). Otherwise allowed.

Object fields
allowed_agentsarray<string>optional
Array item specification
string
allowed_smart_groupsarray<string>optional
Array item specification
string
allowed_usersarray<string>optional
Array item specification
string
denied_smart_groupsarray<string>optional
Array item specification
string
denied_usersarray<string>optional
Array item specification
string

Unknown fields are rejected in this object.

dlpobjectoptional

Data loss prevention actions and enabled risk categories for this MCP.

Object fields
data_risk_actionstringoptional
data_risk_request_actionstringoptional
data_risk_response_actionstringoptional
enabled_oob_adversarial_risk_categoriesmap<string, boolean>optional
Map value specification
boolean
enabled_oob_data_risk_categoriesmap<string, boolean>optional
Map value specification
boolean
enabled_oob_edm_sub_categoriesmap<string, boolean>optional
Map value specification
boolean
oob_adversarial_risk_category_request_actionsmap<string, string>optional
Map value specification
string
oob_adversarial_risk_category_response_actionsmap<string, string>optional
Map value specification
string
oob_data_risk_category_request_actionsmap<string, string>optional
Map value specification
string
oob_data_risk_category_response_actionsmap<string, string>optional
Map value specification
string
oob_edm_sub_category_request_actionsmap<string, string>optional
Map value specification
string
oob_edm_sub_category_response_actionsmap<string, string>optional
Map value specification
string

Unknown fields are rejected in this object.

oauth_scopesarray<string> | nulloptional
Variant 1 array<string>
array<string>

Also accepts null.

onemcpobjectoptional

How this MCP takes part in OneMCP; hidden makes it reachable only at its own endpoint.

Object fields
hiddenbooleanoptional

Unknown fields are rejected in this object.

send_user_claims_headerbooleanoptional
token_savingobjectoptional

Output transforms that reduce tokens sent to the model.

Object fields
html_to_textbooleanoptional
markdown_to_textbooleanoptional
smart_json_compressionbooleanoptional
strip_base64booleanoptional

Replaces detected base64 content with a byte-count placeholder. Removed content is unavailable to the model.

text_compressionbooleanoptional

Unknown fields are rejected in this object.

tool_exposureobjectoptional

Smart tool lists: list only the most-used tools plus a tool search, or expose a code tool. Both are off by default.

Object fields
codebooleanoptional
pinnedarray<string>optional
Array item specification
string
top_toolsbooleanoptional

Unknown fields are rejected in this object.

tool_syncobjectoptional

What happens when the upstream tool list changes: notify (record the change for review), auto (refresh the tool list) or off.

Object fields
modestringoptional
"notify""auto""off"
new_toolsstringoptional
"inherit""hold""allow"

Unknown fields are rejected in this object.

toolsmap<string, object>optional
Map value specification
enabledbooleanoptional
enforce_confirmationbooleanoptional
require_justificationbooleanoptional

Unknown fields are rejected in this object.

upstream_session_max_concurrencyinteger | nulloptional
Variant 1 integer
integer
min: 1max: 256

Also accepts null.

web_search_policyobjectoptional

Web search policy of the Quilr web search MCP: per smart group domain exclusions and URL category overrides.

Object fields
group_excluded_domainsmap<string, array<string>>optional
Map value specification
array<string>
zia_check_timeout_secondsnumberoptional
min: 1max: 30
zia_url_overridesarray<object>optional
Array item specification
actionstringrequired
"allow""block"
domain_patternsarray<string>optional
Array item specification
string
scope_namestringoptional
scope_namesarray<string>optional
Array item specification
string
scope_typestringrequired
"global""zia_group""zia_department"

Unknown fields are rejected in this object.

Unknown fields are rejected in this object.

Unknown fields are rejected in this object.

curl --request PATCH \
'https://mcpgateway.quilr.ai/mcpgateway/management/v1/mcps/a1b2c3d4/settings' \
--header 'Authorization: Bearer <management-key>' \
--header 'If-Match: "r4"' \
--header 'Content-Type: application/json' \
--data '{
"dlp": {
"data_risk_action": "redact"
}
}'

Authentication, errors & retry rules Scopes Try it in the playground

DELETE/mcps/{mcp_id}/upstream-auth

Remove upstream credentials

Removes the static credential and, unless `keep_extras=true`, the extra headers and query parameters (a REST API MCP keeps its extra headers and query parameters: clear them with `PUT` `{"extra_headers": {}, "extra_query_params": {}}`). Refused with 409 `policy_dependency` while the active QuilrQL policy depends on them. Send the quoted `version` from the latest read in If-Match (428 when missing, 412 when stale).

REQUIREScredentials:write
Path, query & header parameters 3
mcp_id (path)stringrequired

MCP id (the `id` of an MCP, not its slug).

keep_extras (query)booleanoptional

true keeps the extra headers and query parameters; default false removes them too. A REST API MCP always keeps them (clear them with PUT {"extra_headers": {}, "extra_query_params": {}}).

default: false
If-Match (header)stringrequired

Quoted `version` (ETag) from the latest read of this resource.

Full request body specification application/json

No body, or an empty JSON object.

Unknown fields are rejected in this object.

curl --request DELETE \
'https://mcpgateway.quilr.ai/mcpgateway/management/v1/mcps/a1b2c3d4/upstream-auth' \
--header 'Authorization: Bearer <management-key>' \
--header 'If-Match: "r4"'

Authentication, errors & retry rules Scopes Try it in the playground

GET/mcps/{mcp_id}/upstream-auth

Read upstream credential metadata

Whether a static credential is configured, how it is sent and the names (never values) of extra headers and query parameters.

REQUIRESread
Path, query & header parameters 1
mcp_id (path)stringrequired

MCP id (the `id` of an MCP, not its slug).

No request body.

curl --request GET \
'https://mcpgateway.quilr.ai/mcpgateway/management/v1/mcps/a1b2c3d4/upstream-auth' \
--header 'Authorization: Bearer <management-key>'

Authentication, errors & retry rules Scopes Try it in the playground

PUT/mcps/{mcp_id}/upstream-auth

Set or rotate upstream credentials

Creates, rotates or changes the static credential and/or the extra headers and query parameters. `mode: user_required` makes every user bring their own key (they save it from the sign-in link, `GET /mcps/{mcp_id}/sign-in-link`); the shared key is deleted. Omitted extras keep the stored ones; {} clears them. On OAuth MCPs only the extra headers and query parameters can be set (sent upstream with each user's OAuth token); a static credential is refused with 400. Send the quoted `version` from the latest read in If-Match (428 when missing, 412 when stale).

REQUIREScredentials:write
Path, query & header parameters 2
mcp_id (path)stringrequired

MCP id (the `id` of an MCP, not its slug).

If-Match (header)stringrequired

Quoted `version` (ETag) from the latest read of this resource.

Full request body specification application/json

Static credential and extras: one shared key, or the shape of a key each user brings (`mode`). OAuth MCPs take only `extra_headers` and `extra_query_params`; a static credential (type, token, header_name, query_param, scheme, mode) is refused.

extra_headersmap<string, string>optional

Replaces the extra headers; {} clears them; omit to keep.

write only
Map value specification
string
max length: 8192
extra_query_paramsmap<string, string>optional

Replaces the extra query parameters; {} clears them; omit to keep.

write only
Map value specification
string
max length: 8192
header_namestringoptional

Header for type header.

max length: 8192
modestringoptional

admin_shared: one key for every user (`token` required). user_required: each user saves their own key from the user dashboard; send the shape only, never `token`. Switching to user_required deletes the shared key; switching back needs a new `token` and keeps users' saved keys unused. Omit to keep the current mode.

"admin_shared""user_required"
query_paramstringoptional

Parameter for type query.

max length: 8192
schemestringoptional

Scheme for type bearer.

max length: 8192
tokenstringoptional

Static API key or token. Rotates the stored one (admin_shared only).

min length: 1max length: 8192write only
typestringoptional

How the token is sent: bearer, header or query.

"bearer""header""query"

Unknown fields are rejected in this object.

curl --request PUT \
'https://mcpgateway.quilr.ai/mcpgateway/management/v1/mcps/a1b2c3d4/upstream-auth' \
--header 'Authorization: Bearer <management-key>' \
--header 'If-Match: "r4"' \
--header 'Content-Type: application/json' \
--data '{
"header_name": "X-Api-Key",
"token": "<token>",
"type": "header"
}'

Authentication, errors & retry rules Scopes Try it in the playground

GET/mcps/{mcp_id}/tool-reviews

Read tool reviews

Review mode and the tools detected upstream that are held, rejected or already approved.

REQUIRESread
Path, query & header parameters 1
mcp_id (path)stringrequired

MCP id (the `id` of an MCP, not its slug).

No request body.

curl --request GET \
'https://mcpgateway.quilr.ai/mcpgateway/management/v1/mcps/a1b2c3d4/tool-reviews' \
--header 'Authorization: Bearer <management-key>'

Authentication, errors & retry rules Scopes Try it in the playground

POST/mcps/{mcp_id}/tool-reviews/approve

Approve held tools

Approves the named tools; they are added to the tool list. 409 `tools_not_awaiting_review` when one is not awaiting review.

REQUIREStool_reviews:write
Path, query & header parameters 1
mcp_id (path)stringrequired

MCP id (the `id` of an MCP, not its slug).

Full request body specification application/json

toolsarray<string>required

Names of tools awaiting review.

min items: 1max items: 500unique items
Array item specification
string
min length: 1max length: 500

Unknown fields are rejected in this object.

curl --request POST \
'https://mcpgateway.quilr.ai/mcpgateway/management/v1/mcps/a1b2c3d4/tool-reviews/approve' \
--header 'Authorization: Bearer <management-key>' \
--header 'Content-Type: application/json' \
--data '{
"tools": [
"delete_repo"
]
}'

Authentication, errors & retry rules Scopes Try it in the playground

POST/mcps/{mcp_id}/tool-reviews/reject

Reject held tools

Rejects the named tools; they stay hidden from clients. 409 `tools_not_awaiting_review` when one is not awaiting review.

REQUIREStool_reviews:write
Path, query & header parameters 1
mcp_id (path)stringrequired

MCP id (the `id` of an MCP, not its slug).

Full request body specification application/json

toolsarray<string>required

Names of tools awaiting review.

min items: 1max items: 500unique items
Array item specification
string
min length: 1max length: 500

Unknown fields are rejected in this object.

curl --request POST \
'https://mcpgateway.quilr.ai/mcpgateway/management/v1/mcps/a1b2c3d4/tool-reviews/reject' \
--header 'Authorization: Bearer <management-key>' \
--header 'Content-Type: application/json' \
--data '{
"tools": [
"delete_repo"
]
}'

Authentication, errors & retry rules Scopes Try it in the playground