/systems/{id}/entitlements/{entitlement}/seats/{module_id} - Free a seat

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL


        
          
            https://api.my.nethesis.it/mcp

Standard setup for AI tools providing an mcp.json file

{
  "my.nethesis.it MCP server": {
    "url": "https://api.my.nethesis.it/mcp"
  }
}

DELETE /systems/{id}/entitlements/{entitlement}/seats/{module_id}

Bearer auth

Free the seat an application instance holds, so it can be given to another one. Collect frees the seats of instances that leave the inventory on its own. Requires manage:entitlements on a system within the caller's hierarchy.

Path parameters

id string Required

System ID
entitlement string Required

Catalog id (or legacy alias) of a seated add-on
module_id string Required

Application instance holding the seat

Responses

200 application/json

Seat released successfully
Hide response attributes Show response attributes object
- code integer
- message string
- data object | null
400 application/json

Bad request - validation error
Hide response attributes Show response attributes object
- code integer
  
  HTTP error code
- message string
  
  Error message
- data object
  
  Hide data attributes Show data attributes object
  
  type string
  
  Type of error
  
  Values are validation_error or external_api_error.
  
  errors array[object]
  
  Hide errors attributes Show errors attributes object
  
  key string
  
  Field name that failed validation
  
  message string
  
  Error code or message
  
  value string
  
  Value that failed validation
  
  details
  
  Additional error details
401 application/json

Unauthorized - invalid or missing token
Hide response attributes Show response attributes object
- code integer
- message string
- data object | null
403 application/json

Forbidden - insufficient permissions
Hide response attributes Show response attributes object
- code integer
- message string
- data object | null
404 application/json

System not found, add-on not granted, or the instance holds no seat
Hide response attributes Show response attributes object
- code integer
  
  HTTP error code
- message string
  
  Error message
- data object
  
  Hide data attributes Show data attributes object
  
  type string
  
  Type of error
  
  Values are validation_error or external_api_error.
  
  errors array[object]
  
  Hide errors attributes Show errors attributes object
  
  key string
  
  Field name that failed validation
  
  message string
  
  Error code or message
  
  value string
  
  Value that failed validation
  
  details
  
  Additional error details
500 application/json

Internal server error
Hide response attributes Show response attributes object
- code integer
- message string
- data object | null

DELETE /systems/{id}/entitlements/{entitlement}/seats/{module_id}

curl \
 --request DELETE 'https://my.nethesis.it/backend/api/systems/sys_123456789/entitlements/nethvoice-chat/seats/nethvoice5' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "code": 200,
  "message": "seat released successfully",
  "data": {}
}

Response examples (400)

{
  "code": 400,
  "message": "validation failed",
  "data": {
    "type": "validation_error",
    "errors": [
      {
        "key": "username",
        "message": "required",
        "value": "string"
      }
    ]
  }
}

Response examples (401)

{
  "code": 401,
  "message": "invalid token",
  "data": {}
}

Response examples (403)

{
  "code": 403,
  "message": "insufficient permissions",
  "data": {}
}

Response examples (404)

{
  "code": 400,
  "message": "validation failed",
  "data": {
    "type": "validation_error",
    "errors": [
      {
        "key": "username",
        "message": "required",
        "value": "string"
      }
    ]
  }
}

Response examples (500)

{
  "code": 500,
  "message": "internal server error",
  "data": {}
}