Update a Model Deployment

curl --request PATCH \
  --url https://mycluster.domino.tech/api/modelServing/v1/modelDeployments/{modelDeploymentId} \
  --header 'Content-Type: application/json' \
  --header 'X-Domino-Api-Key: <api-key>' \
  --data '
{
  "collaborators": [
    {
      "id": "66a84107c774610134ae3a28"
    }
  ],
  "deploymentTargetId": "<string>",
  "description": "This endpoint is designed to provide businesses with insights into their customer retention patterns.",
  "isGloballyAccessible": true,
  "models": [
    {
      "environmentId": "<string>",
      "name": "XYZ Model",
      "source": {
        "registeredModelName": "Growth Forecasting Model",
        "registeredModelType": "MODELREGISTRY",
        "registeredModelVersion": 3
      }
    }
  ],
  "name": "Income Classifier Deployment",
  "resourceConfigurationId": "<string>"
}
'

import requests

url = "https://mycluster.domino.tech/api/modelServing/v1/modelDeployments/{modelDeploymentId}"

payload = {
    "collaborators": [{ "id": "66a84107c774610134ae3a28" }],
    "deploymentTargetId": "<string>",
    "description": "This endpoint is designed to provide businesses with insights into their customer retention patterns.",
    "isGloballyAccessible": True,
    "models": [
        {
            "environmentId": "<string>",
            "name": "XYZ Model",
            "source": {
                "registeredModelName": "Growth Forecasting Model",
                "registeredModelType": "MODELREGISTRY",
                "registeredModelVersion": 3
            }
        }
    ],
    "name": "Income Classifier Deployment",
    "resourceConfigurationId": "<string>"
}
headers = {
    "X-Domino-Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-Domino-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    collaborators: [{id: '66a84107c774610134ae3a28'}],
    deploymentTargetId: '<string>',
    description: 'This endpoint is designed to provide businesses with insights into their customer retention patterns.',
    isGloballyAccessible: true,
    models: [
      {
        environmentId: '<string>',
        name: 'XYZ Model',
        source: {
          registeredModelName: 'Growth Forecasting Model',
          registeredModelType: 'MODELREGISTRY',
          registeredModelVersion: 3
        }
      }
    ],
    name: 'Income Classifier Deployment',
    resourceConfigurationId: '<string>'
  })
};

fetch('https://mycluster.domino.tech/api/modelServing/v1/modelDeployments/{modelDeploymentId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://mycluster.domino.tech/api/modelServing/v1/modelDeployments/{modelDeploymentId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'collaborators' => [
        [
                'id' => '66a84107c774610134ae3a28'
        ]
    ],
    'deploymentTargetId' => '<string>',
    'description' => 'This endpoint is designed to provide businesses with insights into their customer retention patterns.',
    'isGloballyAccessible' => true,
    'models' => [
        [
                'environmentId' => '<string>',
                'name' => 'XYZ Model',
                'source' => [
                                'registeredModelName' => 'Growth Forecasting Model',
                                'registeredModelType' => 'MODELREGISTRY',
                                'registeredModelVersion' => 3
                ]
        ]
    ],
    'name' => 'Income Classifier Deployment',
    'resourceConfigurationId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Domino-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://mycluster.domino.tech/api/modelServing/v1/modelDeployments/{modelDeploymentId}"

	payload := strings.NewReader("{\n  \"collaborators\": [\n    {\n      \"id\": \"66a84107c774610134ae3a28\"\n    }\n  ],\n  \"deploymentTargetId\": \"<string>\",\n  \"description\": \"This endpoint is designed to provide businesses with insights into their customer retention patterns.\",\n  \"isGloballyAccessible\": true,\n  \"models\": [\n    {\n      \"environmentId\": \"<string>\",\n      \"name\": \"XYZ Model\",\n      \"source\": {\n        \"registeredModelName\": \"Growth Forecasting Model\",\n        \"registeredModelType\": \"MODELREGISTRY\",\n        \"registeredModelVersion\": 3\n      }\n    }\n  ],\n  \"name\": \"Income Classifier Deployment\",\n  \"resourceConfigurationId\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("X-Domino-Api-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://mycluster.domino.tech/api/modelServing/v1/modelDeployments/{modelDeploymentId}")
  .header("X-Domino-Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"collaborators\": [\n    {\n      \"id\": \"66a84107c774610134ae3a28\"\n    }\n  ],\n  \"deploymentTargetId\": \"<string>\",\n  \"description\": \"This endpoint is designed to provide businesses with insights into their customer retention patterns.\",\n  \"isGloballyAccessible\": true,\n  \"models\": [\n    {\n      \"environmentId\": \"<string>\",\n      \"name\": \"XYZ Model\",\n      \"source\": {\n        \"registeredModelName\": \"Growth Forecasting Model\",\n        \"registeredModelType\": \"MODELREGISTRY\",\n        \"registeredModelVersion\": 3\n      }\n    }\n  ],\n  \"name\": \"Income Classifier Deployment\",\n  \"resourceConfigurationId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://mycluster.domino.tech/api/modelServing/v1/modelDeployments/{modelDeploymentId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["X-Domino-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"collaborators\": [\n    {\n      \"id\": \"66a84107c774610134ae3a28\"\n    }\n  ],\n  \"deploymentTargetId\": \"<string>\",\n  \"description\": \"This endpoint is designed to provide businesses with insights into their customer retention patterns.\",\n  \"isGloballyAccessible\": true,\n  \"models\": [\n    {\n      \"environmentId\": \"<string>\",\n      \"name\": \"XYZ Model\",\n      \"source\": {\n        \"registeredModelName\": \"Growth Forecasting Model\",\n        \"registeredModelType\": \"MODELREGISTRY\",\n        \"registeredModelVersion\": 3\n      }\n    }\n  ],\n  \"name\": \"Income Classifier Deployment\",\n  \"resourceConfigurationId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "collaborators": [
    {
      "id": "66a84107c774610134ae3a28",
      "role": "CONSUMER"
    }
  ],
  "configuration": {
    "deploymentType": {
      "modelConfigs": {},
      "sharedConfig": {},
      "type": "SYNC_ENDPOINT"
    },
    "modelConfigs": {},
    "sharedConfig": {}
  },
  "creationTimestamp": "2023-07-15T14:35:47.89Z",
  "creatorInfo": {
    "id": "ABC-123",
    "username": "Production"
  },
  "deploymentTargetInfo": {
    "id": "ABC-123",
    "name": "Production",
    "typeName": "AWS SageMaker"
  },
  "description": "This endpoint is designed to provide businesses with insights into their customer retention patterns.",
  "id": "614e40a7-0509-4cae-89af-55e2097b817d",
  "isGloballyAccessible": true,
  "models": [
    {
      "environmentId": "<string>",
      "environmentName": "<string>",
      "name": "XYZ Model",
      "projectId": "<string>",
      "source": {
        "registeredModelName": "Growth Forecasting Model",
        "registeredModelType": "MODELREGISTRY",
        "registeredModelVersion": 3
      }
    }
  ],
  "name": "Income Classifier Deployment",
  "resourceConfigurationInfo": {
    "configuration": {
      "instance_type": "m5.large"
    },
    "id": "ABC-123",
    "name": "Large"
  },
  "version": 23,
  "remoteUpdateTimestamp": "2023-07-16T19:20:30.45Z",
  "status": {
    "state": "STARTING",
    "message": "<string>",
    "modelOperations": {},
    "modelStates": {},
    "sharedOperations": [
      {
        "fields": {},
        "metadata": {
          "operations": [
            "<string>"
          ],
          "type": "<string>",
          "service": "<string>"
        },
        "type": "<string>",
        "credentials": {
          "expirationTime": "2023-11-07T05:31:56Z",
          "keys": [
            "<string>"
          ],
          "type": "AWS"
        },
        "examplePayload": "<string>",
        "examples": [
          {
            "code": "<string>",
            "format": "<string>",
            "language": "<string>",
            "request": "<string>"
          }
        ]
      }
    ],
    "sharedState": {}
  }
}

{
  "error": "<string>"
}

{
  "code": "UNAUTHORIZED",
  "message": "Authentication is required to access this resource."
}

{
  "code": "FORBIDDEN",
  "message": "You do not have permission to perform this action."
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}