Update Stack

Overview

Updates the properties of an existing stack. You can modify the stack name and/or configuration. This endpoint supports partial updates - you only need to include the fields you want to change.

Endpoint

PUT https://api.toolrouter.ai/v1/stacks/{stack_id}

Authentication

This endpoint requires an API key. Include it in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Path Parameters

string

required

The unique identifier of the stack to update

Request Body

string

New name for the stack (optional)

object

Stack configuration settings to update (optional)

Show Configuration Object

boolean

Whether to enable analytics for this stack

All request body fields are optional. Include only the fields you want to update.

Response

string

Unique identifier for the updated stack

string

Name of the updated stack

object

Updated stack configuration settings

Show Configuration Object

boolean

Whether analytics are enabled for this stack

array

Array of servers (not populated in update response)

string

ISO timestamp when the stack was originally created

string

ISO timestamp when the stack was last updated

Example Request

Update Stack Name

curl -X PUT "https://api.toolrouter.ai/v1/stacks/stack_123e4567-e89b-12d3-a456-426614174000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "stack_name": "Updated Stack Name"
  }'

import requests

headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
}

data = {
    "stack_name": "Updated Stack Name"
}

response = requests.put(
    "https://api.toolrouter.ai/v1/stacks/stack_123e4567-e89b-12d3-a456-426614174000",
    headers=headers,
    json=data
)

stack = response.json()

const response = await fetch('https://api.toolrouter.ai/v1/stacks/stack_123e4567-e89b-12d3-a456-426614174000', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    stack_name: "Updated Stack Name"
  })
});

const stack = await response.json();

Update Configuration Only

curl -X PUT "https://api.toolrouter.ai/v1/stacks/stack_123e4567-e89b-12d3-a456-426614174000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "configuration": {
      "analytics_enabled": false
    }
  }'

import requests

headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
}

data = {
    "configuration": {
        "analytics_enabled": False
    }
}

response = requests.put(
    "https://api.toolrouter.ai/v1/stacks/stack_123e4567-e89b-12d3-a456-426614174000",
    headers=headers,
    json=data
)

stack = response.json()

Update Both Name and Configuration

curl -X PUT "https://api.toolrouter.ai/v1/stacks/stack_123e4567-e89b-12d3-a456-426614174000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "stack_name": "Production Environment",
    "configuration": {
      "analytics_enabled": true
    }
  }'

import requests

headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
}

data = {
    "stack_name": "Production Environment",
    "configuration": {
        "analytics_enabled": True
    }
}

response = requests.put(
    "https://api.toolrouter.ai/v1/stacks/stack_123e4567-e89b-12d3-a456-426614174000",
    headers=headers,
    json=data
)

stack = response.json()

Example Response

{
  "stack_id": "stack_123e4567-e89b-12d3-a456-426614174000",
  "stack_name": "Production Environment",
  "configuration": {
    "analytics_enabled": true
  },
  "servers": [],
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-25T15:45:00Z"
}

Error Responses

Invalid request data

{
  "detail": "Invalid configuration parameters"
}

Invalid or missing API key

{
  "detail": "Unauthorized"
}

Stack not found

{
  "detail": "Stack not found"
}

Rate limit exceeded

{
  "detail": "Too many requests"
}

Server error occurred

{
  "detail": "Failed to update stack"
}

API Documentation

Stack Specific Endpoints

Account Management API

Stack Management

Server Management

Credentials Management

Tools Management

SDK

Overview

Endpoint

Authentication

Path Parameters

Request Body

Response

Example Request

Update Stack Name

Update Configuration Only

Update Both Name and Configuration

Example Response

Error Responses

​Overview

​Endpoint

​Authentication

​Path Parameters

​Request Body

​Response

​Example Request

​Update Stack Name

​Update Configuration Only

​Update Both Name and Configuration

​Example Response

​Error Responses

Overview

Endpoint

Authentication

Path Parameters

Request Body

Response

Example Request

Update Stack Name

Update Configuration Only

Update Both Name and Configuration

Example Response

Error Responses