Create a new Model Deployment
Creates a new Model Deployment entity.
curl --request POST \
--url https://mycluster.domino.tech/api/modelServing/v1/modelDeployments \
--header 'Content-Type: application/json' \
--header 'X-Domino-Api-Key: <api-key>' \
--data '
{
"configuration": {
"deploymentType": {
"modelConfigs": {},
"sharedConfig": {},
"type": "SYNC_ENDPOINT"
},
"modelConfigs": {},
"sharedConfig": {}
},
"deploymentTargetId": "ABC-123",
"models": [
{
"environmentId": "<string>",
"name": "XYZ Model",
"source": {
"registeredModelName": "Growth Forecasting Model",
"registeredModelType": "MODELREGISTRY",
"registeredModelVersion": 3
}
}
],
"name": "Income Classifier Deployment",
"resourceConfigurationId": "DEF-123",
"collaborators": [
{
"id": "66a84107c774610134ae3a28"
}
],
"description": "This endpoint is designed to provide businesses with insights into their customer retention patterns.",
"isGloballyAccessible": true
}
'import requests
url = "https://mycluster.domino.tech/api/modelServing/v1/modelDeployments"
payload = {
"configuration": {
"deploymentType": {
"modelConfigs": {},
"sharedConfig": {},
"type": "SYNC_ENDPOINT"
},
"modelConfigs": {},
"sharedConfig": {}
},
"deploymentTargetId": "ABC-123",
"models": [
{
"environmentId": "<string>",
"name": "XYZ Model",
"source": {
"registeredModelName": "Growth Forecasting Model",
"registeredModelType": "MODELREGISTRY",
"registeredModelVersion": 3
}
}
],
"name": "Income Classifier Deployment",
"resourceConfigurationId": "DEF-123",
"collaborators": [{ "id": "66a84107c774610134ae3a28" }],
"description": "This endpoint is designed to provide businesses with insights into their customer retention patterns.",
"isGloballyAccessible": True
}
headers = {
"X-Domino-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Domino-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
configuration: {
deploymentType: {modelConfigs: {}, sharedConfig: {}, type: 'SYNC_ENDPOINT'},
modelConfigs: {},
sharedConfig: {}
},
deploymentTargetId: 'ABC-123',
models: [
{
environmentId: '<string>',
name: 'XYZ Model',
source: {
registeredModelName: 'Growth Forecasting Model',
registeredModelType: 'MODELREGISTRY',
registeredModelVersion: 3
}
}
],
name: 'Income Classifier Deployment',
resourceConfigurationId: 'DEF-123',
collaborators: [{id: '66a84107c774610134ae3a28'}],
description: 'This endpoint is designed to provide businesses with insights into their customer retention patterns.',
isGloballyAccessible: true
})
};
fetch('https://mycluster.domino.tech/api/modelServing/v1/modelDeployments', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'configuration' => [
'deploymentType' => [
'modelConfigs' => [
],
'sharedConfig' => [
],
'type' => 'SYNC_ENDPOINT'
],
'modelConfigs' => [
],
'sharedConfig' => [
]
],
'deploymentTargetId' => 'ABC-123',
'models' => [
[
'environmentId' => '<string>',
'name' => 'XYZ Model',
'source' => [
'registeredModelName' => 'Growth Forecasting Model',
'registeredModelType' => 'MODELREGISTRY',
'registeredModelVersion' => 3
]
]
],
'name' => 'Income Classifier Deployment',
'resourceConfigurationId' => 'DEF-123',
'collaborators' => [
[
'id' => '66a84107c774610134ae3a28'
]
],
'description' => 'This endpoint is designed to provide businesses with insights into their customer retention patterns.',
'isGloballyAccessible' => true
]),
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"
payload := strings.NewReader("{\n \"configuration\": {\n \"deploymentType\": {\n \"modelConfigs\": {},\n \"sharedConfig\": {},\n \"type\": \"SYNC_ENDPOINT\"\n },\n \"modelConfigs\": {},\n \"sharedConfig\": {}\n },\n \"deploymentTargetId\": \"ABC-123\",\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\": \"DEF-123\",\n \"collaborators\": [\n {\n \"id\": \"66a84107c774610134ae3a28\"\n }\n ],\n \"description\": \"This endpoint is designed to provide businesses with insights into their customer retention patterns.\",\n \"isGloballyAccessible\": true\n}")
req, _ := http.NewRequest("POST", 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.post("https://mycluster.domino.tech/api/modelServing/v1/modelDeployments")
.header("X-Domino-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"configuration\": {\n \"deploymentType\": {\n \"modelConfigs\": {},\n \"sharedConfig\": {},\n \"type\": \"SYNC_ENDPOINT\"\n },\n \"modelConfigs\": {},\n \"sharedConfig\": {}\n },\n \"deploymentTargetId\": \"ABC-123\",\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\": \"DEF-123\",\n \"collaborators\": [\n {\n \"id\": \"66a84107c774610134ae3a28\"\n }\n ],\n \"description\": \"This endpoint is designed to provide businesses with insights into their customer retention patterns.\",\n \"isGloballyAccessible\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://mycluster.domino.tech/api/modelServing/v1/modelDeployments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Domino-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"configuration\": {\n \"deploymentType\": {\n \"modelConfigs\": {},\n \"sharedConfig\": {},\n \"type\": \"SYNC_ENDPOINT\"\n },\n \"modelConfigs\": {},\n \"sharedConfig\": {}\n },\n \"deploymentTargetId\": \"ABC-123\",\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\": \"DEF-123\",\n \"collaborators\": [\n {\n \"id\": \"66a84107c774610134ae3a28\"\n }\n ],\n \"description\": \"This endpoint is designed to provide businesses with insights into their customer retention patterns.\",\n \"isGloballyAccessible\": true\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>"
}Authorizations
Body
Model Deployment
The Model Deployment configuration
Show child attributes
Show child attributes
"ABC-123"
A list of models associated with this Model Deployment.
Show child attributes
Show child attributes
The Model Deployment name.
"Income Classifier Deployment"
"DEF-123"
List of collaborators, if any. Will default to empty list if not provided
Show child attributes
Show child attributes
"This endpoint is designed to provide businesses with insights into their customer retention patterns."
Whether the Model Deployment is viewable by Domino Users who are not collaborators. Will default to false if not provided
Response
The created Model Deployment.
Model Deployment
List of collaborators, if any
Show child attributes
Show child attributes
The Model Deployment configuration
Show child attributes
Show child attributes
"2023-07-15T14:35:47.89Z"
Information about the creator of a Model Deployment
Show child attributes
Show child attributes
Information about a Deployment Target and its corresponding Deployment Target Type
Show child attributes
Show child attributes
"This endpoint is designed to provide businesses with insights into their customer retention patterns."
The id of the Model Deployment.
"614e40a7-0509-4cae-89af-55e2097b817d"
Whether the Model Deployment is viewable by Domino Users who are not collaborators
Models associated with this Model Deployment.
Show child attributes
Show child attributes
"Income Classifier Deployment"
Information about a Resource Configuration
Show child attributes
Show child attributes
23
"2023-07-16T19:20:30.45Z"
The Model Deployment status
Show child attributes
Show child attributes
Related topics
Model deployment administrationCreates a new Deployment TargetConfigure DominoManage models with model registryWas this page helpful?
curl --request POST \
--url https://mycluster.domino.tech/api/modelServing/v1/modelDeployments \
--header 'Content-Type: application/json' \
--header 'X-Domino-Api-Key: <api-key>' \
--data '
{
"configuration": {
"deploymentType": {
"modelConfigs": {},
"sharedConfig": {},
"type": "SYNC_ENDPOINT"
},
"modelConfigs": {},
"sharedConfig": {}
},
"deploymentTargetId": "ABC-123",
"models": [
{
"environmentId": "<string>",
"name": "XYZ Model",
"source": {
"registeredModelName": "Growth Forecasting Model",
"registeredModelType": "MODELREGISTRY",
"registeredModelVersion": 3
}
}
],
"name": "Income Classifier Deployment",
"resourceConfigurationId": "DEF-123",
"collaborators": [
{
"id": "66a84107c774610134ae3a28"
}
],
"description": "This endpoint is designed to provide businesses with insights into their customer retention patterns.",
"isGloballyAccessible": true
}
'import requests
url = "https://mycluster.domino.tech/api/modelServing/v1/modelDeployments"
payload = {
"configuration": {
"deploymentType": {
"modelConfigs": {},
"sharedConfig": {},
"type": "SYNC_ENDPOINT"
},
"modelConfigs": {},
"sharedConfig": {}
},
"deploymentTargetId": "ABC-123",
"models": [
{
"environmentId": "<string>",
"name": "XYZ Model",
"source": {
"registeredModelName": "Growth Forecasting Model",
"registeredModelType": "MODELREGISTRY",
"registeredModelVersion": 3
}
}
],
"name": "Income Classifier Deployment",
"resourceConfigurationId": "DEF-123",
"collaborators": [{ "id": "66a84107c774610134ae3a28" }],
"description": "This endpoint is designed to provide businesses with insights into their customer retention patterns.",
"isGloballyAccessible": True
}
headers = {
"X-Domino-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Domino-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
configuration: {
deploymentType: {modelConfigs: {}, sharedConfig: {}, type: 'SYNC_ENDPOINT'},
modelConfigs: {},
sharedConfig: {}
},
deploymentTargetId: 'ABC-123',
models: [
{
environmentId: '<string>',
name: 'XYZ Model',
source: {
registeredModelName: 'Growth Forecasting Model',
registeredModelType: 'MODELREGISTRY',
registeredModelVersion: 3
}
}
],
name: 'Income Classifier Deployment',
resourceConfigurationId: 'DEF-123',
collaborators: [{id: '66a84107c774610134ae3a28'}],
description: 'This endpoint is designed to provide businesses with insights into their customer retention patterns.',
isGloballyAccessible: true
})
};
fetch('https://mycluster.domino.tech/api/modelServing/v1/modelDeployments', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'configuration' => [
'deploymentType' => [
'modelConfigs' => [
],
'sharedConfig' => [
],
'type' => 'SYNC_ENDPOINT'
],
'modelConfigs' => [
],
'sharedConfig' => [
]
],
'deploymentTargetId' => 'ABC-123',
'models' => [
[
'environmentId' => '<string>',
'name' => 'XYZ Model',
'source' => [
'registeredModelName' => 'Growth Forecasting Model',
'registeredModelType' => 'MODELREGISTRY',
'registeredModelVersion' => 3
]
]
],
'name' => 'Income Classifier Deployment',
'resourceConfigurationId' => 'DEF-123',
'collaborators' => [
[
'id' => '66a84107c774610134ae3a28'
]
],
'description' => 'This endpoint is designed to provide businesses with insights into their customer retention patterns.',
'isGloballyAccessible' => true
]),
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"
payload := strings.NewReader("{\n \"configuration\": {\n \"deploymentType\": {\n \"modelConfigs\": {},\n \"sharedConfig\": {},\n \"type\": \"SYNC_ENDPOINT\"\n },\n \"modelConfigs\": {},\n \"sharedConfig\": {}\n },\n \"deploymentTargetId\": \"ABC-123\",\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\": \"DEF-123\",\n \"collaborators\": [\n {\n \"id\": \"66a84107c774610134ae3a28\"\n }\n ],\n \"description\": \"This endpoint is designed to provide businesses with insights into their customer retention patterns.\",\n \"isGloballyAccessible\": true\n}")
req, _ := http.NewRequest("POST", 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.post("https://mycluster.domino.tech/api/modelServing/v1/modelDeployments")
.header("X-Domino-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"configuration\": {\n \"deploymentType\": {\n \"modelConfigs\": {},\n \"sharedConfig\": {},\n \"type\": \"SYNC_ENDPOINT\"\n },\n \"modelConfigs\": {},\n \"sharedConfig\": {}\n },\n \"deploymentTargetId\": \"ABC-123\",\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\": \"DEF-123\",\n \"collaborators\": [\n {\n \"id\": \"66a84107c774610134ae3a28\"\n }\n ],\n \"description\": \"This endpoint is designed to provide businesses with insights into their customer retention patterns.\",\n \"isGloballyAccessible\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://mycluster.domino.tech/api/modelServing/v1/modelDeployments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Domino-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"configuration\": {\n \"deploymentType\": {\n \"modelConfigs\": {},\n \"sharedConfig\": {},\n \"type\": \"SYNC_ENDPOINT\"\n },\n \"modelConfigs\": {},\n \"sharedConfig\": {}\n },\n \"deploymentTargetId\": \"ABC-123\",\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\": \"DEF-123\",\n \"collaborators\": [\n {\n \"id\": \"66a84107c774610134ae3a28\"\n }\n ],\n \"description\": \"This endpoint is designed to provide businesses with insights into their customer retention patterns.\",\n \"isGloballyAccessible\": true\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>"
}