Skip to main content
GET
/
api
/
admin
/
v1
/
deploymentTargets
/
{deploymentTargetId}
/
resourceConfigurations
/
{resourceConfigurationId}
/
effectiveModelDeploymentSchema
Gets the effective configuration for model deployments using the resource configuration
curl --request GET \
  --url https://api.example.com/api/admin/v1/deploymentTargets/{deploymentTargetId}/resourceConfigurations/{resourceConfigurationId}/effectiveModelDeploymentSchema \
  --header 'X-Domino-Api-Key: <api-key>'
{
  "dataPlaneId": "<string>",
  "deploymentTargetConfiguration": {
    "resourceConfig": {},
    "targetConfig": {}
  },
  "deploymentTargetLastModified": "2023-11-07T05:31:56Z",
  "deploymentTargetTypeId": "<string>",
  "deploymentTargetTypeName": "aws",
  "deploymentTargetTypeOperatorVersion": "1.0.2",
  "modelDeploymentConfigurationSchemas": {
    "modelSpecificSchema": {
      "additionalProperties": "<unknown>",
      "default": "<unknown>",
      "description": "<string>",
      "enum": [
        "<unknown>"
      ],
      "id": "<string>",
      "items": "<unknown>",
      "maxItems": 1,
      "maxLength": 1,
      "maxProperties": 1,
      "maximum": 123,
      "minItems": 0,
      "minLength": 0,
      "minProperties": 0,
      "minimum": 123,
      "pattern": "<string>",
      "properties": {},
      "required": [
        "<string>"
      ],
      "title": "<string>",
      "uniqueItems": false
    },
    "sharedSchema": {
      "additionalProperties": "<unknown>",
      "default": "<unknown>",
      "description": "<string>",
      "enum": [
        "<unknown>"
      ],
      "id": "<string>",
      "items": "<unknown>",
      "maxItems": 1,
      "maxLength": 1,
      "maxProperties": 1,
      "maximum": 123,
      "minItems": 0,
      "minLength": 0,
      "minProperties": 0,
      "minimum": 123,
      "pattern": "<string>",
      "properties": {},
      "required": [
        "<string>"
      ],
      "title": "<string>",
      "uniqueItems": false
    }
  },
  "modelDeploymentCustomResourceDefinition": {
    "group": "<string>",
    "kind": "<string>",
    "version": "<string>"
  },
  "modelDeploymentStateSchemas": {
    "modelSpecificSchema": {
      "additionalProperties": "<unknown>",
      "default": "<unknown>",
      "description": "<string>",
      "enum": [
        "<unknown>"
      ],
      "id": "<string>",
      "items": "<unknown>",
      "maxItems": 1,
      "maxLength": 1,
      "maxProperties": 1,
      "maximum": 123,
      "minItems": 0,
      "minLength": 0,
      "minProperties": 0,
      "minimum": 123,
      "pattern": "<string>",
      "properties": {},
      "required": [
        "<string>"
      ],
      "title": "<string>",
      "uniqueItems": false
    },
    "sharedSchema": {
      "additionalProperties": "<unknown>",
      "default": "<unknown>",
      "description": "<string>",
      "enum": [
        "<unknown>"
      ],
      "id": "<string>",
      "items": "<unknown>",
      "maxItems": 1,
      "maxLength": 1,
      "maxProperties": 1,
      "maximum": 123,
      "minItems": 0,
      "minLength": 0,
      "minProperties": 0,
      "minimum": 123,
      "pattern": "<string>",
      "properties": {},
      "required": [
        "<string>"
      ],
      "title": "<string>",
      "uniqueItems": false
    }
  },
  "modelDeploymentSupportedModelSources": [
    "MODELREGISTRY"
  ],
  "modelDeploymentTypeConfigurationSchemas": {},
  "modelDeploymentTypeStateSchemas": {},
  "resourceConfigurationLastModified": "2023-11-07T05:31:56Z"
}

Authorizations

​
X-Domino-Api-Key
string
header
required

Path Parameters

​
deploymentTargetId
string
required

ID of Deployment Target the Resource Configuration belongs to

​
resourceConfigurationId
string
required

ID of Resource Configuration

Response

Success

Effective Model Deployment Schema

​
dataPlaneId
string
required

ID of the data plane where the operator is deployed

​
deploymentTargetConfiguration
object
required

The Deployment Target configuration values for the Deployment Target and Resource Configuration

​
deploymentTargetLastModified
string<date-time>
required

Timestamp of the last update to the deployment target (will be the creation timestamp on creation)

​
deploymentTargetTypeId
string
required

UUID for the Deployment Target Type

​
deploymentTargetTypeName
string
required

Internal name for the Deployment Target Type

Example:

"aws"

​
deploymentTargetTypeOperatorVersion
string
required

Version of the operator

Example:

"1.0.2"

​
modelDeploymentConfigurationSchemas
object
required

Shared and Model Specific configs.

​
modelDeploymentCustomResourceDefinition
object
required

Custom Resource Definition for Model Deployment

​
modelDeploymentStateSchemas
object
required

Shared and Model Specific configs.

​
modelDeploymentSupportedModelSources
enum<string>[]
required

Model sources supported by Domino

Available options:
MODELREGISTRY
​
modelDeploymentTypeConfigurationSchemas
object
required

The supported deployment types. There must be one property present for each deployment type.

​
modelDeploymentTypeStateSchemas
object
required

The supported deployment types. There must be one property present for each deployment type.

​
resourceConfigurationLastModified
string<date-time>
required

Timestamp of the last update to the resource configuration (will be the creation timestamp on creation)