> This page is for Multi-Tenant, version v3.0 (default). > For other versions, use one of these documentation indexes: > - v3.0 (default): https://docs.nvidia.com/run-ai/multi-tenant/v3.0/llms.txt > - v2.26: https://docs.nvidia.com/run-ai/multi-tenant/v2.26/llms.txt > - v2.25: https://docs.nvidia.com/run-ai/multi-tenant/v2.25/llms.txt > - v2.24: https://docs.nvidia.com/run-ai/multi-tenant/v2.24/llms.txt > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.nvidia.com/run-ai/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.nvidia.com/run-ai/_mcp/server. # Update tenant PATCH http://localhost:8080/api/v1/tenants/{tenantId} Content-Type: application/json Update tenant properties such as alias. Reference: https://docs.nvidia.com/run-ai/multi-tenant/reference/rest-api/endpoints/organizations/tenant/update-tenant-by-id ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication ## Request ### Path parameters - `tenantId` (integer, required) — The id of the tenant to retrieve ### Body (application/json) This endpoint expects a TenantUpdateRequest. - `alias` (string, optional, nullable) — An optional alias for the tenant. Must be unique across all tenant names and aliases. ## Response ### 200 Tenant updated successfully. - `id` (integer, required) — The id of the tenant. - `uuid` (string, required) — The universally unique identifier of the tenant. - `name` (string, required) — The internal system name of the tenant. - `smg` (boolean, required) - `status` (enum, required) — The current status of the tenant. Possible values: - Creating - Failed - Updating - Deleted - Deleting - Ready - Allowed values: `Creating`, `Failed`, `Updating`, `Deleted`, `Deleting`, `Ready` - `createdAt` (datetime, required) — The date and time when the tenant was created. - `updatedAt` (datetime, required) — The date and time when the tenant was last updated. - `contractType` (enum, required) - Allowed values: `normal`, `trial` - `mimirId` (string, optional) - `displayName` (string, optional) — The name of the tenant as shown to users within the tenant. - `alias` (string, optional) — An optional alias for the tenant. - `diagnostics` (string, optional) — Most recent provisioning failure message. Only populated by GET /tenants/\{id} when status is Failed. ## Errors ### 400 Bad Request Error Bad request. - `code` (integer, required) - `message` (string, required) - `details` (string, optional) ### 401 Unauthorized Error Unauthorized - `code` (integer, required) - `message` (string, required) - `details` (string, optional) ### 403 Forbidden Error Forbidden - `code` (integer, required) - `message` (string, required) - `details` (string, optional) ### 404 Not Found Error The specified resource was not found - `code` (integer, required) - `message` (string, required) - `details` (string, optional) ### 409 Conflict Error The specified resource already exists - `code` (integer, required) - `message` (string, required) - `details` (string, optional) ### 500 Internal Server Error unexpected error - `code` (integer, required) - `message` (string, required) - `details` (string, optional) ### 503 Service Unavailable Error unexpected error - `code` (integer, required) - `message` (string, required) - `details` (string, optional) ## Examples **Request** ```json {} ``` **Response** ```json { "id": 1, "uuid": "string", "name": "example", "smg": true, "status": "Ready", "createdAt": "2020-01-01T00:00:00Z", "updatedAt": "2020-01-02T00:00:00Z", "contractType": "normal", "displayName": "Example", "alias": "example-alias", "deletedAt": null, "tenantId": 123 } ``` **SDK Code** ```python import requests url = "http://localhost:8080/api/v1/tenants/1" payload = {} headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.patch(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'http://localhost:8080/api/v1/tenants/1'; const options = { method: 'PATCH', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "http://localhost:8080/api/v1/tenants/1" payload := strings.NewReader("{}") req, _ := http.NewRequest("PATCH", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("http://localhost:8080/api/v1/tenants/1") http = Net::HTTP.new(url.host, url.port) request = Net::HTTP::Patch.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.patch("http://localhost:8080/api/v1/tenants/1") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('PATCH', 'http://localhost:8080/api/v1/tenants/1', [ 'body' => '{}', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("http://localhost:8080/api/v1/tenants/1"); var request = new RestRequest(Method.PATCH); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:8080/api/v1/tenants/1")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "PATCH" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```