(Preview) Create a model deployment

post

/20260430/aiDataPlatforms/{aiDataPlatformId}/mlops/api/2.0/model-deployments/create

(Preview) Creates a model deployment for a registered model.

Request

Path Parameters
Header Parameters
  • Maximum Length: 255
    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.
  • Maximum Length: 64
    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of running that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and removed from the system, then a retry of the original creation request might be rejected.
Body ()
Details for the new model deployment.
Root Schema : CreateModelDeploymentDetails
Type: object
The data to create a model deployment.
Show Source
  • DeploymentOAuthDetails
    OAuth trust configuration for a model deployment's query endpoint. Required when authType is OAUTH and must be omitted for AIDP. A closed schema: the gateway turns these values into the token policy it enforces, so a member outside this set is not accepted -- it is discarded rather than stored or forwarded, and a misspelled member therefore leaves the one it was meant to be unset, which fails validation. The serialized object must not exceed 16000 characters. Cannot be changed while the deployment is ACTIVE.
  • Allowed Values: [ "AIDP", "OAUTH" ]
    Authentication mechanism for the deployment's query endpoint. Required.
  • Minimum Length: 1
    Maximum Length: 255
    Compute key of the deployment. At most 255 characters and 255 UTF-8 bytes.
  • deployment_targets
    Minimum Number of Items: 1
    Maximum Number of Items: 100
    Deployment targets of the deployment.
  • Maximum Length: 2000
    Description of the deployment. At most 2000 characters and 2000 UTF-8 bytes.
  • Minimum Length: 1
    Maximum Length: 256
    Name of the registered model. At most 256 characters and 256 UTF-8 bytes.
  • Minimum Length: 1
    Maximum Length: 255
    Name of the deployment. At most 255 characters and 255 UTF-8 bytes.
  • tags
    Maximum Number of Items: 20
    List of tags set on the model deployment.
  • Minimum Length: 1
    Maximum Length: 255
    Workspace key of the deployment. At most 255 characters and 255 UTF-8 bytes.
Nested Schema : DeploymentOAuthDetails
Type: object
OAuth trust configuration for a model deployment's query endpoint. Required when authType is OAUTH and must be omitted for AIDP. A closed schema: the gateway turns these values into the token policy it enforces, so a member outside this set is not accepted -- it is discarded rather than stored or forwarded, and a misspelled member therefore leaves the one it was meant to be unset, which fails validation. The serialized object must not exceed 16000 characters. Cannot be changed while the deployment is ACTIVE.
Show Source
  • audienceClaim
    Minimum Number of Items: 1
    Maximum Number of Items: 20
    OAuth audience claims (aud) the query endpoint accepts. Entries must be unique.
  • Minimum Length: 1
    Maximum Length: 1024
    OAuth issuer claim (iss) the query endpoint requires. An https URI whose host is a fully qualified domain name, not an IP literal in any notation, and which carries no userinfo and no fragment.
  • Minimum Length: 1
    Maximum Length: 2048
    URI the gateway retrieves the signing keys (JWKS) from. An https URI whose host is a fully qualified domain name, not an IP literal in any notation, and which carries no userinfo and no fragment. A query string and a non-default port are permitted: published provider JWKS endpoints use both.
Nested Schema : deployment_targets
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 100
Deployment targets of the deployment.
Show Source
Nested Schema : tags
Type: array
Maximum Number of Items: 20
List of tags set on the model deployment.
Show Source
Nested Schema : audienceClaim
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 20
OAuth audience claims (aud) the query endpoint accepts. Entries must be unique.
Show Source
Nested Schema : DeploymentTarget
Type: object
A model version targeted by a deployment and its traffic share.
Show Source
Nested Schema : ModelDeploymentTag
Type: object
A tag associated with a model deployment.
Show Source
  • Minimum Length: 1
    Maximum Length: 250
    Key of the model deployment tag. At most 250 characters and 250 UTF-8 bytes.
  • Maximum Length: 5000
    Value of the model deployment tag. At most 5000 characters and 5000 UTF-8 bytes.
Back to Top

Response

Supported Media Types

201 Response

Successful operation. Model deployment is created.
Headers
  • For optimistic concurrency control. See `if-match`.
  • Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : ModelDeployment
Type: object
A model deployment.
Show Source
Nested Schema : DeploymentOAuthDetails
Type: object
OAuth trust configuration for a model deployment's query endpoint. Required when authType is OAUTH and must be omitted for AIDP. A closed schema: the gateway turns these values into the token policy it enforces, so a member outside this set is not accepted -- it is discarded rather than stored or forwarded, and a misspelled member therefore leaves the one it was meant to be unset, which fails validation. The serialized object must not exceed 16000 characters. Cannot be changed while the deployment is ACTIVE.
Show Source
  • audienceClaim
    Minimum Number of Items: 1
    Maximum Number of Items: 20
    OAuth audience claims (aud) the query endpoint accepts. Entries must be unique.
  • Minimum Length: 1
    Maximum Length: 1024
    OAuth issuer claim (iss) the query endpoint requires. An https URI whose host is a fully qualified domain name, not an IP literal in any notation, and which carries no userinfo and no fragment.
  • Minimum Length: 1
    Maximum Length: 2048
    URI the gateway retrieves the signing keys (JWKS) from. An https URI whose host is a fully qualified domain name, not an IP literal in any notation, and which carries no userinfo and no fragment. A query string and a non-default port are permitted: published provider JWKS endpoints use both.
Nested Schema : deployment_targets
Type: array
Deployment targets of the deployment.
Show Source
Nested Schema : tags
Type: array
List of tags set on the model deployment.
Show Source
Nested Schema : audienceClaim
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 20
OAuth audience claims (aud) the query endpoint accepts. Entries must be unique.
Show Source
Nested Schema : DeploymentTarget
Type: object
A model version targeted by a deployment and its traffic share.
Show Source
Nested Schema : ModelDeploymentTag
Type: object
A tag associated with a model deployment.
Show Source
  • Minimum Length: 1
    Maximum Length: 250
    Key of the model deployment tag. At most 250 characters and 250 UTF-8 bytes.
  • Maximum Length: 5000
    Value of the model deployment tag. At most 5000 characters and 5000 UTF-8 bytes.

400 Response

Bad Request (invalid query parameters, malformed headers, and so on).
Headers
  • Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
Error information.
Show Source

401 Response

Unauthorized (missing or expired credentials, and so on).
Headers
  • Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
Error information.
Show Source

404 Response

Not Found. The requested resource was not found.
Headers
  • Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
Error information.
Show Source

409 Response

Conflict. Request conflicts with the current state of the resource.
Headers
  • Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
Error information.
Show Source

429 Response

Too Many Requests. Too many requests sent to the server in a short period.
Headers
  • Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
Error information.
Show Source

500 Response

Internal Server Error. The server encountered an unexpected condition preventing fulfilment of the request.
Headers
  • Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
Error information.
Show Source

Default Response

Unknown Error. Error is not recognized by the system.
Headers
  • Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
Error information.
Show Source
Back to Top