Set a key's tool permissions
Replaces the grant whole and returns it. Every server must be one of the instance’s MCP servers or APIs, named once. A key reaches the servers granted to it or to its team, and the servers open to every key; when both grant, only the servers in both. The instance must be ready; otherwise the request answers 409.
PUT
/
agent_gateways
/
{instance_id}
/
keys
/
{key_id}
/
tool_permissions
curl --request PUT \
--url https://api.telnyx.com/v2/agent_gateways/{instance_id}/keys/{key_id}/tool_permissions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"servers": [
{
"id": "88d5a97b-4080-4855-8bac-a39811b1dc24",
"tools": [
"get_order"
]
}
]
}
'{
"data": {
"servers": [
{
"id": "88d5a97b-4080-4855-8bac-a39811b1dc24",
"tools": [
"get_order"
]
}
]
}
}{
"errors": [
{
"code": "10013",
"title": "Missing association",
"detail": "One of the associated fields does not exist.",
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10013"
},
"source": {
"pointer": "/servers/0/id"
}
}
]
}{
"errors": [
{
"code": "10009",
"title": "Authentication failed",
"detail": "The required authentication headers were either invalid or not included in the request.",
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10009"
}
}
]
}{
"errors": [
{
"code": "10005",
"title": "Resource not found",
"detail": "The requested resource or URL could not be found.",
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10005"
}
}
]
}{
"errors": [
{
"code": "99901",
"title": "Instance not ready",
"detail": "The instance is not ready; its engine is not running."
}
]
}{
"errors": [
{
"code": "10027",
"title": "Unprocessable Entity",
"detail": "The value is invalid.",
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10027"
},
"source": {
"pointer": "/servers"
}
}
]
}{
"errors": [
{
"code": "99903",
"title": "Engine unavailable",
"detail": "The instance's engine did not answer; try again shortly."
}
]
}Authorizations
Telnyx API key
Path Parameters
The Agent Gateway's id.
The key's id, a 64-character hash the instance stores in place of the key.
Pattern:
^[0-9a-f]{64}$Body
application/json
The servers granted, each with its tools. [] grants none.
Show child attributes
Show child attributes
Response
The grant
Show child attributes
Show child attributes
Was this page helpful?
curl --request PUT \
--url https://api.telnyx.com/v2/agent_gateways/{instance_id}/keys/{key_id}/tool_permissions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"servers": [
{
"id": "88d5a97b-4080-4855-8bac-a39811b1dc24",
"tools": [
"get_order"
]
}
]
}
'{
"data": {
"servers": [
{
"id": "88d5a97b-4080-4855-8bac-a39811b1dc24",
"tools": [
"get_order"
]
}
]
}
}{
"errors": [
{
"code": "10013",
"title": "Missing association",
"detail": "One of the associated fields does not exist.",
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10013"
},
"source": {
"pointer": "/servers/0/id"
}
}
]
}{
"errors": [
{
"code": "10009",
"title": "Authentication failed",
"detail": "The required authentication headers were either invalid or not included in the request.",
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10009"
}
}
]
}{
"errors": [
{
"code": "10005",
"title": "Resource not found",
"detail": "The requested resource or URL could not be found.",
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10005"
}
}
]
}{
"errors": [
{
"code": "99901",
"title": "Instance not ready",
"detail": "The instance is not ready; its engine is not running."
}
]
}{
"errors": [
{
"code": "10027",
"title": "Unprocessable Entity",
"detail": "The value is invalid.",
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10027"
},
"source": {
"pointer": "/servers"
}
}
]
}{
"errors": [
{
"code": "99903",
"title": "Engine unavailable",
"detail": "The instance's engine did not answer; try again shortly."
}
]
}